Class Timeline<Parsers>

Given a timeline, parse it in to a list of TimelineItem objects.

Type Parameters

Implements

Constructors

constructor

Properties

#private

Accessors

Parsers position

Methods

[asyncIterator] displayTimelinePosition hasUnfinishedItems next startOver toJSON toString toTimeline create

Constructors

constructor

Properties

Private #private

#private: any

Accessors

Parsers

  • get Parsers(): Parsers

  • Returns Parsers

position

  • get position(): number

  • Returns number

Methods

[asyncIterator]

  • [asyncIterator](): this

  • Returns this

displayTimelinePosition

  • displayTimelinePosition(): string

  • Displays the current position of timeline.

    Returns string

    Example

    const timeline = new Timeline('--{foo: bar}--4--|')
    await timeline.next()
    await timeline.next()
    await timeline.next()
    await timeline.next()
    await timeline.next()
    console.info(timeline.displayTimelinePosition())
    `
    --{foo: bar}--4--|
                 ^
    `

hasUnfinishedItems

  • hasUnfinishedItems(): boolean

  • Returns boolean

next

  • next(): Promise<IteratorResult<ParsedTimelineItem<Parsers>, undefined>>

  • Returns Promise<IteratorResult<ParsedTimelineItem<Parsers>, undefined>>

startOver

  • startOver(): void

  • Returns void

toJSON

toString

  • toString(): string

  • Returns string

toTimeline

  • toTimeline(): Promise<string>

  • Returns Promise<string>

Static create

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc