createSlidingWindowRateLimitPolicy()

Create one exact scoped sliding-window-v1 policy from an already-identifiable request.

Import

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

Signature

function createSlidingWindowRateLimitPolicy(
  requestValue: unknown,
  opts: CreateSlidingWindowRateLimitPolicyOptions,
): SlidingWindowRateLimitPolicy

Parameters

Parameter	Type	Description
requestValue	unknown	Complete strict request that establishes the exact scope.
opts	CreateSlidingWindowRateLimitPolicyOptions	State revision, capacity, exact window, and bounded ledger size.

Returns

The immutable normalized sliding-window policy.

Example

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

Source

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