Interface ConcurrencyPolicy<C>

Describes how requests of one API are grouped into categories, and the default limit of each category.

interface ConcurrencyPolicy<C> {
    defaults: Readonly<Record<C, number>>;
    fallback?: ((normalizedPath: string) => undefined | C);
    name: string;
    normalizePath?: ((pathname: string) => string);
    rules: readonly ConcurrencyRule<C>[];
}

Type Parameters

  • C extends string

Properties

defaults fallback? name normalizePath? rules

Properties

Readonlydefaults

defaults: Readonly<Record<C, number>>

Optional Readonlyfallback

fallback?: ((normalizedPath: string) => undefined | C)

Category for paths no rule matches. Return undefined to leave them unlimited.

Readonlyname

name: string

Used in validation errors

Optional ReadonlynormalizePath

normalizePath?: ((pathname: string) => string)

Maps a request pathname to the form the rules are written against.

Readonlyrules

rules: readonly ConcurrencyRule<C>[]

First match wins, so order matters when rules overlap.

Settings

Member Visibility

On This Page

Properties