Interface StarCommsClientConfig

Configuration options for the Star Comms client.

interface StarCommsClientConfig {
    baseUrl: string;
    connectTimeoutMs?: number;
    fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
    ownerApiKey: string;
    shardToken?: string;
    timeoutMs?: number;
}

Properties

baseUrl connectTimeoutMs? fetch? ownerApiKey shardToken? timeoutMs?

Properties

baseUrl

baseUrl: string

Base URL of the shard (e.g., "http://your-shard:25588"). No trailing slash.

OptionalconnectTimeoutMs

connectTimeoutMs?: number

Connection timeout for streaming endpoints in ms.

Default

30000

Optionalfetch

fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

Custom fetch implementation.

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

Default

globalThis.fetch

ownerApiKey

ownerApiKey: string

Owner API key (scok_...) for authenticated endpoints.

OptionalshardToken

shardToken?: string

Shard token (scsh_...) for the /debug endpoint.

OptionaltimeoutMs

timeoutMs?: number

Request timeout in milliseconds.

Default

10000

Settings

Member Visibility

On This Page

Properties