assertTokenBucketRateLimitTransitionInput()

Validate one strict token-bucket-v1 evaluator input with externally supplied time.

Import

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

Signature

function assertTokenBucketRateLimitTransitionInput(value: unknown): TokenBucketRateLimitTransitionInput

Parameters

Parameter	Type	Description
value	unknown	Candidate request, policy, state, and observedAtMs input.

Returns

The immutable normalized token-bucket evaluator input.

Example

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

Source

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