Class PulseScheduler<T>

Represents a scheduler that executes a processor function at regular intervals for each item in the list.

Type Parameters

T
The type of items in the scheduler.

Hierarchy (View Summary)

PulseScheduler

Index

Constructors

Properties

items processor

Methods

add addAll getItems pop push remove removeIf shift splice start stop unshift

Constructors

constructor

new PulseScheduler<T>(
processor: (t: T) => void,
period: number,
): PulseScheduler<T>
Creates a new PulseScheduler instance.
Type Parameters
- T
Parameters
- processor: (t: T) => void
- period: number
  The period of the scheduler.
Returns PulseScheduler<T>
- Defined in index.d.ts:1059

Properties

`Protected`items

items: T[]

processor

processor: (t: T) => void

Methods

add

add(item: T): void
Adds an item to the schedule.
Parameters
- item: T
  The item to be added.
Returns void
Deprecated
Use push instead.
- Defined in index.d.ts:1065

addAll

addAll(items: T[]): void
Adds multiple items to the schedule.
Parameters
- items: T[]
  The items to be added.
Returns void
Deprecated
Use push instead.
- Defined in index.d.ts:1072

getItems

getItems(): readonly T[]
Returns a list of the items in the schedule.

Returns readonly T[]
- Defined in index.d.ts:1087

pop

pop(): undefined | T
Returns undefined | T
- Defined in index.d.ts:1099

push

push(...items: T[]): number
Parameters
- ...items: T[]
Returns number
- Defined in index.d.ts:1098

remove

remove(index: number): void
Removes an item from the schedule at the specified index.
Parameters
- index: number
  The index of the item to remove.
Returns void
- Defined in index.d.ts:1077

removeIf

removeIf(predicate: (t: T) => boolean): void
Removes items from the schedule that satisfy the given predicate.
Parameters
- predicate: (t: T) => boolean
  The predicate function used to determine if an item should be removed.
Returns void
- Defined in index.d.ts:1083

shift

shift(): undefined | T
Returns undefined | T
- Defined in index.d.ts:1100

splice

splice(start: number, deleteCount?: number): T[]
Parameters
- start: number
- OptionaldeleteCount: number
Returns T[]
- Defined in index.d.ts:1102
splice(start: number, deleteCount: number, ...items: T[]): T[]
Parameters
- start: number
- deleteCount: number
- ...items: T[]
Returns T[]
- Defined in index.d.ts:1103

start

start(): void
Starts the schedule.

Returns void
- Defined in index.d.ts:1091

stop

stop(): void
Stops the schedule.

Returns void
- Defined in index.d.ts:1095

unshift

unshift(...items: T[]): number
Parameters
- ...items: T[]
Returns number
- Defined in index.d.ts:1101