Interface CodexTransport

interface CodexTransport {
    abortStream(): void;
    close(): Promise<void>;
    connect(): Promise<void>;
    isReady(): boolean;
    readMessages(): AsyncIterable<CodexFrame>;
    reconnect(): Promise<void>;
    write(
        frame: string | CodexFrame,
        options?: { signal?: AbortSignal },
    ): Promise<void>;
}

Implemented by

CodexAxonTransport

Index

Methods

abortStream close connect isReady readMessages reconnect write

Methods

abortStream

abortStream(): void
Returns void
- Defined in sdk/src/codex/transport.ts:41

close

close(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/codex/transport.ts:40

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/codex/transport.ts:36

isReady

isReady(): boolean
Returns boolean
- Defined in sdk/src/codex/transport.ts:42

readMessages

readMessages(): AsyncIterable<CodexFrame>
Returns AsyncIterable<CodexFrame>
- Defined in sdk/src/codex/transport.ts:39

reconnect

reconnect(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/codex/transport.ts:37

write

write(
frame: string | CodexFrame,
options?: { signal?: AbortSignal },
): Promise<void>
Parameters
- frame: string | CodexFrame
- Optionaloptions: { signal?: AbortSignal }
Returns Promise<void>
- Defined in sdk/src/codex/transport.ts:38