Class CodexAxonTransport

Whole-frame JSON-RPC transport over Axon publish/SSE.

Implements

CodexTransport

Index

Constructors

Methods

abortStream close connect isReady readMessages reconnect write

Constructors

constructor

new CodexAxonTransport(
axon: Axon,
options?: CodexAxonTransportOptions,
): CodexAxonTransport
Parameters
- axon: Axon
- options: CodexAxonTransportOptions = {}
Returns CodexAxonTransport
- Defined in sdk/src/codex/transport.ts:38

Methods

abortStream

abortStream(): void
Returns void
Implementation of CodexTransport.abortStream
- Defined in sdk/src/codex/transport.ts:76

close

close(): Promise<void>
Returns Promise<void>
Implementation of CodexTransport.close
- Defined in sdk/src/codex/transport.ts:79

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of CodexTransport.connect
- Defined in sdk/src/codex/transport.ts:64

isReady

isReady(): boolean
Returns boolean
Implementation of CodexTransport.isReady
- Defined in sdk/src/codex/transport.ts:82

readMessages

readMessages(): AsyncGenerator<CodexFrame>
Returns AsyncGenerator<CodexFrame>
Implementation of CodexTransport.readMessages
- Defined in sdk/src/codex/transport.ts:73

reconnect

reconnect(): Promise<void>
Returns Promise<void>
Implementation of CodexTransport.reconnect
- Defined in sdk/src/codex/transport.ts:67

write

write(frame: string | CodexFrame): Promise<void>
Parameters
- frame: string | CodexFrame
Returns Promise<void>
Implementation of CodexTransport.write
- Defined in sdk/src/codex/transport.ts:70