lib/auth/rate-limit

Classes

ExpiringTokenBucket<_Key>

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:161

Represents a token bucket with tokens that expire after a specified duration. Used to control access to resources with tokens that reset after expiration.

Type Parameters

_Key

_Key

The type of key used to identify individual token buckets.

Constructors

Constructor

new ExpiringTokenBucket<_Key>(max: number, expiresInSeconds: number): ExpiringTokenBucket<_Key>

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:186

Initializes a new instance of the ExpiringTokenBucket class.

Parameters

max

number

The maximum number of tokens the bucket can hold.

expiresInSeconds

number

The duration in seconds after which tokens expire.

Returns

ExpiringTokenBucket<_Key>

Properties

expiresInSeconds

expiresInSeconds: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:172

The duration (in seconds) after which tokens in the bucket expire.

max

max: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:166

The maximum number of tokens the bucket can hold.

Methods

check()

check(key: _Key, cost: number): boolean

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:198

Checks if there are enough tokens available in the bucket for the specified key and cost.

Parameters

key

_Key

The key associated with the token bucket.

cost

number

The number of tokens required.

Returns

boolean

• Returns true if there are enough tokens or if the tokens have expired; otherwise, false.

consume()

consume(key: _Key, cost: number): boolean

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:217

Consumes tokens from the bucket for the specified key and cost.

Parameters

key

_Key

The key associated with the token bucket.

cost

number

The number of tokens to consume.

Returns

boolean

• Returns true if tokens were successfully consumed; otherwise, false.

reset()

reset(key: _Key): void

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:244

Resets the token bucket for a specified key, removing all tokens.

Parameters

key

_Key

The key associated with the token bucket to reset.

Returns

void

---

RefillingTokenBucket<_Key>

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:10

Represents a token bucket that refills tokens at a specified interval. Used to control access to resources by limiting the number of tokens that can be consumed over time.

Type Parameters

_Key

_Key

The type of key used to identify individual token buckets.

Constructors

Constructor

new RefillingTokenBucket<_Key>(max: number, refillIntervalSeconds: number): RefillingTokenBucket<_Key>

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:29

Initializes a new instance of the RefillingTokenBucket class.

Parameters

max

number

The maximum number of tokens the bucket can hold.

refillIntervalSeconds

number

The refill interval in seconds.

Returns

RefillingTokenBucket<_Key>

Properties

max

max: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:15

The maximum number of tokens that the bucket can hold.

refillIntervalSeconds

refillIntervalSeconds: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:21

The interval in seconds at which tokens are refilled.

Methods

check()

check(key: _Key, cost: number): boolean

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:47

Checks if there are enough tokens available in the bucket for the specified key and cost.

Parameters

key

_Key

The key associated with the token bucket.

cost

number

The number of tokens required.

Returns

boolean

• Returns true if there are enough tokens; otherwise, false.

consume()

consume(key: _Key, cost: number): boolean

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:67

Consumes tokens from the bucket for the specified key and cost.

Parameters

key

_Key

The key associated with the token bucket.

cost

number

The number of tokens to consume.

Returns

boolean

• Returns true if tokens were successfully consumed; otherwise, false.

---

Throttler<_Key>

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:96

Represents a throttler that limits the frequency of actions performed with a specified key. Uses incremental timeouts to delay repeated actions.

Type Parameters

_Key

_Key

The type of key used to identify throttling counters.

Constructors

Constructor

new Throttler<_Key>(timeoutSeconds: number[]): Throttler<_Key>

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:114

Initializes a new instance of the Throttler class.

Parameters

timeoutSeconds

number[]

Array of timeout durations in seconds for each consecutive attempt.

Returns

Throttler<_Key>

Properties

timeoutSeconds

timeoutSeconds: number[];

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:101

Array of timeout durations (in seconds) for each consecutive attempt.

Methods

consume()

consume(key: _Key): boolean

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:124

Attempts to consume an action for the specified key.

Parameters

key

_Key

The key associated with the throttling counter.

Returns

boolean

• Returns true if the action is allowed; otherwise, false.

reset()

reset(key: _Key): void

Defined in: studiocms/packages/studiocms/src/lib/auth/rate-limit.ts:150

Resets the throttling counter for a specified key.

Parameters

key

_Key

The key associated with the throttling counter to reset.

Returns

void