Documentation
    Preparing search index...

    Class TimelineItemBoolean

    Represents the shorthand for a boolean value, in a timeline.

    Can either be F (false) or T (true).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    regexEnding

    Accessors

    finished rawValue

    Methods

    dash get onPass onReach toTimeline createItemRegExp parse

    Constructors

    Properties

    regexEnding: RegExp

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

    This is generally one of:

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

    Accessors

    • get finished(): boolean

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

      Returns boolean

    • get rawValue(): string

      Returns string

    Methods

    • Returns Promise<void>

    • Returns the value the TimelineItem decorates.

      Returns boolean

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

      Returns Promise<void>

      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.

    • Called when this item is reached in the timeline.

      Returns Promise<void>

    • The string representation of this item in a timeline.

      Returns string

    • Creates a RegExp item to match your timeline item.

      Parameters

      • regexp: RegExp

      Returns RegExp

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

    • Parameters

      • timeline: string

      Returns readonly [TimelineItemBoolean, string] | undefined

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods