Class TimelineItem<T>Abstract

constructor

• new TimelineItem<T>(rawValue): TimelineItem<T>

• Type Parameters

  • T

  Parameters

  • rawValue: string

  Returns TimelineItem<T>

Static Readonly regexEnding

finished

• get finished(): boolean

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

  Returns boolean

rawValue

• get rawValue(): string

• Returns string

Abstract get

• get(): T

• Returns the value the TimelineItem decorates.

  Returns T

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.