iya-sts
    Preparing search index...
    blocked: (
        what: string,
        req: any,
        identity?: unknown,
        limit?: NamedLimit,
    ) => LimitAnswer = ...

    Type Declaration

      • (what: string, req: any, identity?: unknown, limit?: NamedLimit): LimitAnswer
      • Says whether a caller is at a limit right now, without counting anything.

        For a door whose successes are many: it asks this first, counts only a failure with attempt(), and clears on success with succeeded().

        Parameters

        • what: string

          the door being limited

        • req: any

          the express request, for the address

        • Optionalidentity: unknown

          optional; the identity attempted

        • Optionallimit: NamedLimit

          optional; the ceiling, as for attempt()

        Returns LimitAnswer

        the refusal, or null when not blocked