ts-lambda-api - v2.5.2
    Preparing search index...

    Interface Context

    Handler context parameter. See AWS documentation.

    interface Context {
        awsRequestId: string;
        callbackWaitsForEmptyEventLoop: boolean;
        clientContext?: ClientContext;
        functionName: string;
        functionVersion: string;
        identity?: CognitoIdentity;
        invokedFunctionArn: string;
        logGroupName: string;
        logStreamName: string;
        memoryLimitInMB: string;
        tenantId?: string;
        done(error?: Error, result?: any): void;
        fail(error: string | Error): void;
        getRemainingTimeInMillis(): number;
        succeed(messageOrObject: any): void;
        succeed(message: string, object: any): void;
    }
    Index

    Properties

    awsRequestId callbackWaitsForEmptyEventLoop clientContext? functionName functionVersion identity? invokedFunctionArn logGroupName logStreamName memoryLimitInMB tenantId?

    Methods

    done fail getRemainingTimeInMillis succeed

    Properties

    awsRequestId: string
    callbackWaitsForEmptyEventLoop: boolean
    clientContext?: ClientContext
    functionName: string
    functionVersion: string
    identity?: CognitoIdentity
    invokedFunctionArn: string
    logGroupName: string
    logStreamName: string
    memoryLimitInMB: string
    tenantId?: string

    Methods

    • Parameters

      • Optionalerror: Error
      • Optionalresult: any

      Returns void

      Use handler callback or promise result

    • Parameters

      • error: string | Error

      Returns void

      Use handler callback with first argument or reject a promise result

    • Returns number

    • Parameters

      • messageOrObject: any

      Returns void

      Use handler callback with second argument or resolve a promise result

    • Parameters

      • message: string
      • object: any

      Returns void

      Use handler callback or promise result

    Settings

    Member Visibility

    On This Page

    Properties
    Methods