API Reference
    Preparing search index...

    Type Alias IdempotencyHandlerOptionsInternal

    Options to configure the behavior of the idempotency logic.

    This is an internal type that is used for configuration.

    type IdempotencyHandlerOptions = {
        functionArguments: unknown[];
        functionPayloadToBeHashed: JSONValue;
        functionToMakeIdempotent: AnyFunction;
        idempotencyConfig: IdempotencyConfig;
        keyPrefix?: string;
        persistenceStore: BasePersistenceLayer;
        thisArg?: Handler;
    }
    Index

    Properties

    functionArguments functionPayloadToBeHashed functionToMakeIdempotent idempotencyConfig keyPrefix? persistenceStore thisArg?

    Properties

    functionArguments: unknown[]

    The arguments passed to the function.

    For example, if the function is foo(a, b), then functionArguments will be [a, b]. We need to keep track of the arguments so that we can pass them to the function when we call it.

    functionPayloadToBeHashed: JSONValue

    The payload to be hashed.

    This is the argument that is used for the idempotency.

    functionToMakeIdempotent: AnyFunction

    Reference to the function to be made idempotent.

    idempotencyConfig: IdempotencyConfig

    Idempotency configuration options.

    keyPrefix?: string

    The custom idempotency key prefix.

    persistenceStore: BasePersistenceLayer

    Persistence layer used to store the idempotency records.

    thisArg?: Handler

    The this context to be used when calling the function.

    When decorating a class method, this will be the instance of the class.

    Settings

    Member Visibility

    On This Page

    Properties