Documentation
    Preparing search index...

    Interface TimelineParsable<T>

    The static methods of a class that denote how it is turned in to a TimelineItem.

    interface TimelineParsable<
        T extends TimelineItem<unknown> = TimelineItem<unknown>,
    > {
        new TimelineParsable(...args: any[]): T;
        parse(
            timelinePart: string,
            options: TimelineItemOptions,
        ): readonly [T, string] | undefined;
    }

    Type Parameters

    Hierarchy

    • Outerface<T>
      • TimelineParsable
    Index

    Constructors

    constructor

    Methods

    parse

    Constructors

    • Parameters

      • ...args: any[]

      Returns T

    Methods

    • Returns a binary tuple where:

      1. the 1st item is the parsed TimelineItem
      2. the 2nd item is the rest of the unparsed timeline

      Parameters

      • timelinePart: string

        the unparsed timeline, from the current position

      • options: TimelineItemOptions

        forwarded to the constructed item; pass options.clock through to super/the item constructor so it shares the timeline's Clock.

      Returns readonly [T, string] | undefined

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods