createTokenBucketRateLimitPolicy()

Create one exact scoped token-bucket-v1 policy from an already-identifiable request.

Import

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

Signature

function createTokenBucketRateLimitPolicy(
  requestValue: unknown,
  opts: CreateTokenBucketRateLimitPolicyOptions,
): TokenBucketRateLimitPolicy

Parameters

Parameter	Type	Description
requestValue	unknown	Complete strict request that establishes the exact scope.
opts	CreateTokenBucketRateLimitPolicyOptions	State revision, capacity, integer refill ratio, and initial units.

Returns

The immutable normalized token-bucket policy.

Example

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

Source

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