Interface PlatformSocketOptions

interface PlatformSocketOptions {
    accessToken?: string;
    apiBaseUrl: string;
    publishableKey?: string;
    socketConfig?: Omit<SocketConfig, "params">;
    socketPath?: string;
}

Index

Properties

accessToken? apiBaseUrl publishableKey? socketConfig? socketPath?

Properties

`Optional`accessToken

accessToken?: string

Bearer token for direct platform connections. Omit for cookie-authenticated gateways.

apiBaseUrl

apiBaseUrl: string

`Optional`publishableKey

publishableKey?: string

Publishable key (pk_...) — optional for user JWT paths that only need token

`Optional`socketConfig

socketConfig?: Omit<SocketConfig, "params">

`Optional`socketPath

socketPath?: string

Explicit WebSocket path, including any same-origin gateway prefix.