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

PulseScheduler

Index

Constructors

Properties

currentTick executionSchedule items nextIndex period processor recalculateExecutionSchedule runId? tick log

Methods

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

Constructors

constructor

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

Properties

`Private` currentTick

currentTick: any

`Private` executionSchedule

executionSchedule: any

`Protected` items

items: T[]

`Private` nextIndex

nextIndex: any

`Private` period

period: any

processor

processor: ((t) => void)

Type declaration

- (t): void
- Parameters
  - t: T
  Returns void

`Private` recalculateExecutionSchedule

recalculateExecutionSchedule: any

`Private` `Optional` runId

runId?: any

`Private` tick

tick: any

`Static` `Private` `Readonly` log

log: any

Methods

add

add(item): 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:1074

addAll

addAll(items): 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:1081

getItems

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

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

pop

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

push

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

remove

remove(index): 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:1086

removeIf

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

shift

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

splice

splice(start, deleteCount?): T[]
Parameters
- start: number
- Optional deleteCount: number
Returns T[]
- Defined in index.d.ts:1111
splice(start, deleteCount, ...items): T[]
Parameters
- start: number
- deleteCount: number
- Rest ...items: T[]
Returns T[]
- Defined in index.d.ts:1112

start

start(): void
Starts the schedule.

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

stop

stop(): void
Stops the schedule.

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

unshift

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