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

    Interface HttpSignerInternal

    Interface to sign identity and signing properties.

    interface HttpSigner {
        errorHandler?: ErrorHandler;
        successHandler?: SuccessHandler;
        sign(
            httpRequest: HttpRequest,
            identity: Identity,
            signingProperties: Record<string, unknown>,
        ): Promise<HttpRequest>;
    }
    Index

    Properties

    errorHandler? successHandler?

    Methods

    sign

    Properties

    errorHandler?: ErrorHandler

    Handler that executes after the HttpSigner.sign invocation and corresponding middleware throws an error. The error handler is expected to throw the error it receives, so the return type of the error handler is never.

    successHandler?: SuccessHandler

    Handler that executes after the HttpSigner.sign invocation and corresponding middleware succeeds.

    Methods

    • Signs an HttpRequest with an identity and signing properties.

      Parameters

      • httpRequest: HttpRequest

        request to sign

      • identity: Identity

        identity to sing the request with

      • signingProperties: Record<string, unknown>

        property bag for signing

      Returns Promise<HttpRequest>

      signed request in a promise

    Settings

    Member Visibility

    On This Page

    Properties
    Methods