Class TimelineItemTimer

A timeline item that represents a timer.

Remarks

Timers are used in 2 ways. One for simply delaying the stream's content and the other is to expect that a certain amount of time has passed since the previous item.

Hierarchy (view full)

Constructors

constructor

Properties

#private #private regexEnding

Accessors

finished rawValue

Methods

get onPass onReach toTimeline createItemRegExp parse

Constructors

constructor

Properties

Private #private

#private: any

Private #private

#private: any

Static Readonly regexEnding

regexEnding: "(?:-|\\||$)" = "(?:-|\\||$)"

A piece of regular expression that will match something after a timeline item.

Remarks

This is generally one of:

  • a dash
  • a close symbol
  • the end of the timeline

Accessors

finished

  • get finished(): boolean

  • If returns true, the item can be considered finished or "unimportant".

    Returns boolean

rawValue

  • get rawValue(): string

  • Returns string

Methods

get

  • get(): TimelineTimer

  • Returns the value the TimelineItem decorates.

    Returns TimelineTimer

onPass

  • onPass(): Promise<void>

  • Called after this item has been used and before the next item is "reached".

    Returns Promise<void>

    Remarks

    To match other timelines, that may be a string of dashes, consider all characters in the raw value to wait just like that of a dash.

onReach

  • onReach(): Promise<void>

  • Called when this item is reached in the timeline.

    Returns Promise<void>

toTimeline

  • toTimeline(): string

  • The string representation of this item in a timeline.

    Returns string

Static createItemRegExp

  • createItemRegExp(regexp): RegExp

  • Creates a RegExp item to match your timeline item.

    Parameters

    • regexp: string

    Returns RegExp

    Remarks

    Prepends the regexp with a start character (^) and appends it with TimelineItem.regexEnding.

Static parse

  • parse(timeline): undefined | readonly [TimelineItemTimer, string]

  • Parameters

    • timeline: string

    Returns undefined | readonly [TimelineItemTimer, string]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc