Documentation
    Preparing search index...

    Class Timeline<Parsers>

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

    Type Parameters

    Implements

    Index

    Constructors

    constructor

    Accessors

    Parsers position

    Methods

    [asyncIterator] displayTimelinePosition hasUnfinishedItems next startOver toJSON toString toTimeline create

    Constructors

    Accessors

    • get Parsers(): Parsers

      Returns Parsers

    • get position(): number

      Returns number

    Methods

    • Returns this

    • Displays the current position of timeline.

      Returns string

      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--|
                   ^
      `

    • Returns boolean

    • Returns void

    • Returns a string representation of an object.

      Returns string

    • Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods