Interface SynapseClientConfig

Configuration for SynapseClient.

Extends TransportConfig with optional WebSocket and gRPC endpoints.

Since

1.0.0

interface SynapseClientConfig {
    apiKey?: string;
    debug?: boolean;
    endpoint: string;
    grpcEndpoint?: string;
    headers?: Record<string, string>;
    maxRetries?: number;
    timeout?: number;
    wsEndpoint?: string;
}

Hierarchy (view full)

Properties

apiKey? debug? endpoint grpcEndpoint? headers? maxRetries? timeout? wsEndpoint?

Properties

OptionalapiKey

apiKey?: string

Optional Bearer API key.

Optionaldebug

debug?: boolean

Enable debug logging to console.log.

endpoint

endpoint: string

RPC endpoint URL.

OptionalgrpcEndpoint

grpcEndpoint?: string

gRPC endpoint for Yellowstone/Geyser streaming (defaults to the HTTP endpoint).

Optionalheaders

headers?: Record<string, string>

Extra HTTP headers merged into every request.

OptionalmaxRetries

maxRetries?: number

Max retry attempts on method-not-allowed (default 3).

Optionaltimeout

timeout?: number

Request timeout in ms (default 30 000).

OptionalwsEndpoint

wsEndpoint?: string

WebSocket endpoint for subscriptions (defaults to the HTTP endpoint with ws://).

Settings

Member Visibility

On This Page

Properties