faastjs.throttle.md

id	title	hide_title
faastjs.throttle	throttle() function	true

faastjs > throttle

throttle() function

A decorator for rate limiting, concurrency limiting, retry, memoization, and on-disk caching. See Limits.

Signature:

export declare function throttle<A extends any[], R>(limits: Limits, fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;

Parameters

Parameter	Type	Description
limits	Limits	see Limits.
fn	(...args: A) => Promise<R>	The function to throttle. It can take any arguments, but must return a Promise (which includes async functions).

**Returns:**

(...args: A) => Promise<R>

Returns a throttled function with the same signature as the argument fn.

Remarks

When programming against cloud services, databases, and other resources, it is often necessary to control the rate of request issuance to avoid overwhelming the service provider. In many cases the provider has built-in safeguards against abuse, which automatically fail requests if they are coming in too fast. Some systems don't have safeguards and precipitously degrade their service level or fail outright when faced with excessive load.

With faast.js it becomes very easy to (accidentally) generate requests from thousands of cloud functions. The throttle function can help manage request flow without resorting to setting up a separate service. This is in keeping with faast.js' zero-ops philosophy.

Usage is simple:

async function operation() { ... }
const throttledOperation = throttle({ concurrency: 10, rate: 5 }, operation);
for(let i = 0; i < 100; i++) {
    // at most 10 concurrent executions at a rate of 5 invocations per second.
    throttledOperation();
}

Note that each invocation to throttle creates a separate function with a separate limits. Therefore it is likely that you want to use throttle in a global context, not within a dynamic context:

async function operation() { ... }
for(let i = 0; i < 100; i++) {
    // WRONG - each iteration creates a separate throttled function that's only called once.
    const throttledOperation = throttle({ concurrency: 10, rate: 5 }, operation);
    throttledOperation();
}

A better way to use throttle avoids creating a named operation function altogether, ensuring it cannot be accidentally called without throttling:

const operation = throttle({ concurrency: 10, rate: 5 }, async () => {
    ...
});

Throttle supports functions with arguments automatically infers the correct type for the returned function:

// `operation` inferred to have type (str: string) => Promise<string>
const operation = throttle({ concurrency: 10, rate: 5 }, async (str: string) => {
    return string;
});

In addition to limiting concurrency and invocation rate, throttle also supports retrying failed invocations, memoizing calls, and on-disk caching. See Limits for details.