Stone.js API
    Preparing search index...

    Interface TencentScfHttpEvent

    Represents the Tencent Cloud SCF HTTP event (API Gateway proxy integration).

    SCF fronts HTTP with API Gateway, which delivers a single proxy event shape. Every field is optional because a given request may omit some; use normalizeHttpEvent to reduce it to a canonical shape.

    interface TencentScfHttpEvent {
        body?: unknown;
        headers?: Record<string, string>;
        httpMethod?: string;
        isBase64Encoded?: boolean;
        multiValueHeaders?: Record<string, string[]>;
        multiValueQueryStringParameters?: Record<string, string[]>;
        path?: string;
        queryString?: Record<string, string | string[]>;
        queryStringParameters?: Record<string, string | string[]>;
        requestContext?: { httpMethod?: string; sourceIp?: string };
        [key: string]: unknown;
    }

    Hierarchy

    • Record<string, unknown>
      • TencentScfHttpEvent

    Indexable

    • [key: string]: unknown
    Index
    body? headers? httpMethod? isBase64Encoded? multiValueHeaders? multiValueQueryStringParameters? path? queryString? queryStringParameters? requestContext?

    Optionalbody

    body?: unknown

    The body of the HTTP request (string, possibly base64-encoded).

    headers?: Record<string, string>

    The headers of the HTTP request as key-value pairs (may be null/absent).

    httpMethod?: string

    The HTTP method of the request.

    isBase64Encoded?: boolean

    Indicates whether the request body is base64-encoded.

    multiValueHeaders?: Record<string, string[]>

    Multi-value headers, when the gateway is configured to emit them.

    multiValueQueryStringParameters?: Record<string, string[]>

    Multi-value query parameters, when enabled.

    path?: string

    The path of the HTTP request.

    queryString?: Record<string, string | string[]>

    The query parameters, as delivered by API Gateway (values string or string[]).

    queryStringParameters?: Record<string, string | string[]>

    Alternative single-value query parameters some integrations send.

    requestContext?: { httpMethod?: string; sourceIp?: string }

    The API Gateway request context.

    Type Declaration

    • OptionalhttpMethod?: string

      The HTTP method, when carried on the context rather than the top level.

    • OptionalsourceIp?: string

      The client source IP.

    Settings
    Member Visibility

    On This Page
    Properties