Variable succeededShared

Type Declaration

• • (
        what: string,
        req: any,
        identity?: unknown,
        options?: {
            keepAddress?: boolean;
            limit?: NamedLimit;
            unlessBlocked?: boolean;
        },
    ): Promise<void | LimitAnswer>

  • Forgets the counters after a success, in this process and in the shared store.

    With unlessBlocked a success is answered only while the bucket is under the limit: at the limit it resolves to the lockout refusal and clears nothing.

    Parameters

    • what: string

      the door being limited

    • req: any

      the express request, for the address

    • Optionalidentity: unknown

      optional; the identity that succeeded

    • Optionaloptions: { keepAddress?: boolean; limit?: NamedLimit; unlessBlocked?: boolean }

      optional keepAddress, unlessBlocked and limit

    Returns Promise<void | LimitAnswer>

    a promise of the refusal when locked out, otherwise of null or nothing