ThrottleStrategy

Defined in: packages/db/src/strategies/types.ts:99

Throttle strategy that spaces executions evenly over time

Extends#

• BaseStrategy<"throttle">

Properties#

_type#

_type: "throttle";

Defined in: packages/db/src/strategies/types.ts:8

Type discriminator for strategy identification

Inherited from#

BaseStrategy._type

cleanup()#

cleanup: () => void;

Defined in: packages/db/src/strategies/types.ts:30

Clean up any resources held by the strategy Should be called when the strategy is no longer needed

Returns#

void

Inherited from#

BaseStrategy.cleanup

execute()#

execute: <T>(fn, onAdmit?, onCommit?) => boolean | void | Promise<void>;

Defined in: packages/db/src/strategies/types.ts:20

Execute a function according to the strategy's timing rules

Type Parameters#

T#

T extends object = Record<string, unknown>

Parameters#

fn#

() => Transaction<T>

The function to execute

onAdmit?#

() => void | Transaction<T>

Optional synchronous preparation for an admitted call. Built-in debounce/throttle strategies call it after reserving the current edge but before invoking fn, and do not call it when returning false.

onCommit?#

() => Promise<unknown> | undefined

Optional promise for the actual commit attempt. It can outlive the public persistence receipt after a manual rollback.

Returns#

boolean | void | Promise<void>

The result of the function execution (if applicable)

Inherited from#

BaseStrategy.execute

options#

options: ThrottleStrategyOptions;

Defined in: packages/db/src/strategies/types.ts:100