createTokenBucketRateLimitTransitionInput()

Create and strictly normalize one token-bucket-v1 evaluator input.

Import

import { createTokenBucketRateLimitTransitionInput } from "@graphrefly/ts/rate-limit";

Signature

function createTokenBucketRateLimitTransitionInput(
  request: unknown,
  policy: unknown,
  state: unknown,
  observedAtMs: unknown,
): TokenBucketRateLimitTransitionInput

Parameters

Parameter	Type	Description
request	unknown	Complete strict request to evaluate.
policy	unknown	Exact scoped token-bucket policy.
state	unknown	Exact scoped state, or null only when the host atomically confirms that no exact scoped state exists and authorizes this evaluation to perform first initialization.
observedAtMs	unknown	Externally supplied authoritative Unix epoch milliseconds.

Returns

The immutable normalized token-bucket evaluator input.

Example

import { createTokenBucketRateLimitTransitionInput } from "@graphrefly/ts/rate-limit";

Source

packages/ts/src/rate-limit/keyed-rate-limit-algorithms.ts