Class PulseScheduler<T>

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>

processor

add

• add(item): void

• Adds an item to the schedule.

  Parameters

  • item: T

    The item to be added.

  Returns void

  Deprecated

  Use push instead.

addAll

• addAll(items): void

• Adds multiple items to the schedule.

  Parameters

  • items: T[]

    The items to be added.

  Returns void

  Deprecated

  Use push instead.

getItems

• getItems(): readonly T[]

• Returns a list of the items in the schedule.

  Returns readonly T[]

pop

• pop(): undefined | T

• Returns undefined | T

push

• push(...items): number

• Parameters

  • Rest ...items: T[]

  Returns number

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

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

shift

• shift(): undefined | T

• Returns undefined | T

splice

• splice(start, deleteCount?): T[]

• Parameters

  • start: number

  • Optional deleteCount: number

  Returns T[]

• splice(start, deleteCount, ...items): T[]

• Parameters

  • start: number

  • deleteCount: number

  • Rest ...items: T[]

  Returns T[]

start

• start(): void

• Starts the schedule.

  Returns void

stop

• stop(): void

• Stops the schedule.

  Returns void

unshift

• unshift(...items): number

• Parameters

  • Rest ...items: T[]

  Returns number