Class UniquePulseScheduler<T>

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

Type Parameters

T

Hierarchy

PulseScheduler<T>
- UniquePulseScheduler

Index

Constructors

Properties

equalityFunction items processor

Methods

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

Constructors

constructor

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

Properties

`Private` equalityFunction

equalityFunction: any

`Protected` items

items: T[]

processor

processor: ((t) => void)

Type declaration

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

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

addAll

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

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:984

pop

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

push

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

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

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

shift

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

splice

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

start

start(): void
Starts the schedule.

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

stop

stop(): void
Stops the schedule.

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

unshift

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