Class UniquePulseScheduler<T>

Represents a PulseScheduler that only adds unique items to the schedule.

Type Parameters

T

Hierarchy (View Summary)

PulseScheduler<T>
- UniquePulseScheduler

Index

Constructors

Properties

items processor

Methods

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

Constructors

constructor

new UniquePulseScheduler<T>(
    processor: (t: T) => void,
    period: number,
    equalityFunction?: (a: T, b: T) => boolean,
): UniquePulseScheduler<T>
Creates a new UniquePulseScheduler instance.
Type Parameters
- T
Parameters
- processor: (t: T) => void
- period: number
  The period of the scheduler.
- OptionalequalityFunction: (a: T, b: T) => boolean
Returns UniquePulseScheduler<T>
Overrides PulseScheduler.constructor
- Defined in index.d.ts:1126

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.
Inherited from PulseScheduler.add
- 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.
Inherited from PulseScheduler.addAll
- Defined in index.d.ts:1072

getItems

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

Returns readonly T[]
Inherited from PulseScheduler.getItems
- Defined in index.d.ts:1087

pop

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

push

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

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
Inherited from PulseScheduler.remove
- 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
Inherited from PulseScheduler.removeIf
- Defined in index.d.ts:1083

shift

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

splice

splice(start: number, deleteCount?: number): T[]
Parameters
- start: number
- OptionaldeleteCount: number
Returns T[]
Overrides PulseScheduler.splice
- Defined in index.d.ts:1129
splice(start: number, deleteCount: number, ...items: T[]): T[]
Parameters
- start: number
- deleteCount: number
- ...items: T[]
Returns T[]
Overrides PulseScheduler.splice
- Defined in index.d.ts:1130

start

start(): void
Starts the schedule.

Returns void
Inherited from PulseScheduler.start
- Defined in index.d.ts:1091

stop

stop(): void
Stops the schedule.

Returns void
Inherited from PulseScheduler.stop
- Defined in index.d.ts:1095

unshift

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