AngularRateLimiterSignal

Defined in: packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:23

An Angular writable signal whose set and update writes share a rate limit. Accepted writes execute immediately; rejected writes and their updaters are discarded. Updaters receive the committed value when executed. asReadonly() exposes a live readonly view. The rateLimiter attribute controls execution.

Extends#

• WritableSignal<TValue>

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

AngularRateLimiterSignal(): TValue;

Defined in: packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:23

An Angular writable signal whose set and update writes share a rate limit. Accepted writes execute immediately; rejected writes and their updaters are discarded. Updaters receive the committed value when executed. asReadonly() exposes a live readonly view. The rateLimiter attribute controls execution.

Returns#

TValue

Properties#

[ɵWRITABLE_SIGNAL]#

[ɵWRITABLE_SIGNAL]: TValue;

Defined in: node_modules/.pnpm/@angular+core@22.2.1_@angular+compiler@22.2.1_rxjs@7.8.2_zone.js@0.16.3/node_modules/@angular/core/types/_chrome_dev_tools_performance-chunk.d.ts:19

Inherited from#

WritableSignal.[ɵWRITABLE_SIGNAL]

[SIGNAL]#

[SIGNAL]: unknown;

Defined in: node_modules/.pnpm/@angular+core@22.2.1_@angular+compiler@22.2.1_rxjs@7.8.2_zone.js@0.16.3/node_modules/@angular/core/types/_chrome_dev_tools_performance-chunk.d.ts:75

Inherited from#

WritableSignal.[SIGNAL]

rateLimiter#

rateLimiter: AngularRateLimiter<(value) => void, TSelected>;

Defined in: packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:28

The underlying Angular RateLimiter ref for controlling execution.

Methods#

asReadonly()#

asReadonly(): Signal<TValue>;

Defined in: node_modules/.pnpm/@angular+core@22.2.1_@angular+compiler@22.2.1_rxjs@7.8.2_zone.js@0.16.3/node_modules/@angular/core/types/_chrome_dev_tools_performance-chunk.d.ts:34

Returns a readonly version of this signal. Readonly signals can be accessed to read their value but can't be changed using set or update methods. The readonly signals do not have any built-in mechanism that would prevent deep-mutation of their value.

Returns#

Signal<TValue>

Inherited from#

WritableSignal.asReadonly

set()#

set(value): void;

Defined in: node_modules/.pnpm/@angular+core@22.2.1_@angular+compiler@22.2.1_rxjs@7.8.2_zone.js@0.16.3/node_modules/@angular/core/types/_chrome_dev_tools_performance-chunk.d.ts:23

Directly set the signal to a new value, and notify any dependents.

Parameters#

value#

TValue

Returns#

void

Inherited from#

WritableSignal.set

update()#

update(updateFn): void;

Defined in: node_modules/.pnpm/@angular+core@22.2.1_@angular+compiler@22.2.1_rxjs@7.8.2_zone.js@0.16.3/node_modules/@angular/core/types/_chrome_dev_tools_performance-chunk.d.ts:28

Update the value of the signal based on its current value, and notify any dependents.

Parameters#

updateFn#

(value) => TValue

Returns#

void

Inherited from#

WritableSignal.update