Stone.js API
    Preparing search index...

    Interface ApiGatewayWsRequestContext

    The API Gateway WebSocket request context (the fields the adapter reads).

    interface ApiGatewayWsRequestContext {
        connectionId: string;
        domainName?: string;
        eventType: string;
        routeKey?: string;
        stage?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Other request-context fields.

    Index
    connectionId domainName? eventType routeKey? stage?
    connectionId: string

    The stable connection id for the socket.

    domainName?: string

    The API domain name (used to build the management endpoint).

    eventType: string

    The lifecycle event type: CONNECT, DISCONNECT or MESSAGE.

    routeKey?: string

    The route key ($connect, $disconnect, $default, or a custom route).

    stage?: string

    The API stage (used to build the management endpoint).

    Settings
    Member Visibility

    On This Page
    Properties