@types/aws-api-gateway-client

Installation

npm install --save @types/aws-api-gateway-client

Summary

This package contains type definitions for aws-api-gateway-client (https://github.com/kndt84/aws-api-gateway-client).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/aws-api-gateway-client.

index.d.ts

export interface ApiGatewayClientConfig {
    accessKey?: string | undefined;
    secretKey?: string | undefined;
    sessionToken?: string | undefined;
    region?: string | undefined;
    apiKey?: string | undefined;
    invokeUrl: string | undefined;
    service?: string | undefined;
    defaultContentType?: string | undefined;
    defaultAcceptType?: string | undefined;
    systemClockOffset?: number | undefined;
    headers?: Record<string, string | undefined>;
    host?: string | undefined;
}

export interface Response {
    data: unknown;
    status: number;
    statusText: string;
    headers: unknown;
    request?: unknown;
}

export interface ApiGatewayClient {
    invokeApi(
        params: Record<string, unknown>,
        pathTemplate: string,
        method: "GET" | "POST" | "DELETE" | "UPDATE",
        additionalParams?: {
            headers?: { [key: string]: unknown };
            queryParams?: { [key: string]: string | number | boolean };
            timeout?: number;
        },
        body?: string,
    ): Promise<Response>;
}

export const apigClientFactory: {
    newClient(apiGatewayClientConfig: ApiGatewayClientConfig): ApiGatewayClient;
};

export default apigClientFactory;

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:04 GMT
• Dependencies: none

Credits

These definitions were written by Jussi Kinnula.