createFixedWindowRateLimitPolicy()

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

Import

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

Signature

function createFixedWindowRateLimitPolicy(
  requestValue: unknown,
  opts: CreateFixedWindowRateLimitPolicyOptions,
): FixedWindowRateLimitPolicy

Parameters

Parameter	Type	Description
requestValue	unknown	Complete strict request that establishes the exact scope.
opts	CreateFixedWindowRateLimitPolicyOptions	State revision, capacity, and epoch-aligned window duration.

Returns

The immutable normalized fixed-window policy.

Example

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

Source

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