Skip to content

QueuedSignal.md

Latest commit

 

History

History
78 lines (47 loc) · 1.5 KB

QueuedSignal.md

File metadata and controls

78 lines (47 loc) · 1.5 KB
id QueuedSignal
title QueuedSignal

Interface: QueuedSignal()<TValue, TSelected>

Defined in: angular-pacer/src/queuer/injectQueuedSignal.ts:6

Type Parameters

TValue

TValue

TSelected

TSelected = { }

QueuedSignal(): TValue[];

Defined in: angular-pacer/src/queuer/injectQueuedSignal.ts:7

Returns

TValue[]

Properties

addItem()

addItem: (item, position?, runOnItemsChange?) => boolean;

Defined in: angular-pacer/src/queuer/injectQueuedSignal.ts:8

Adds an item to the queue. If the queue is full, the item is rejected and onReject is called. Items can be inserted based on priority or at the front/back depending on configuration.

Returns true if the item was added, false if the queue is full.

Example usage:

queuer.addItem('task');
queuer.addItem('task2', 'front');

Parameters

item

TValue

position?

QueuePosition

runOnItemsChange?

boolean

Returns

boolean

queuer

queuer: AngularQueuer<TValue, TSelected>;

Defined in: angular-pacer/src/queuer/injectQueuedSignal.ts:9