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

    Interface RetryToken

    interface RetryToken {
        $retryLog?: { acquisitionDelay?: number };
        getRetryCount(): number;
        getRetryDelay(): number;
        isLongPoll?(): boolean;
    }
    Index

    Properties

    $retryLog?: { acquisitionDelay?: number }

    Delays that have already been executed by the time the token is accessible. This is needed for the token handler to understand what has happened.

    Methods

    • Starts at 0 for the initial request, which is not a "retry" by definition. 1 indicates the first retry.

      Returns number

      the current count of retry.

    • RetryStrategies implemented by @smithy/core will return tokens with a delay of zero.

      This is because the RetryStrategy token acquisition methods took over the task of idling for the delay period. If a user-implemented retry token contains a delay, the default Smithy retry middleware will still honor it.

      That is to say, you may either sleep within the RetryStrategy methods for acquiring the token, OR return a token with a retry delay that will cause the retry middleware to sleep.

      Returns number

      the number of milliseconds to wait before retrying an action.

    • Returns boolean

      whether the operation which generated this token is long polling.