Class TimelineIndexInternal

constructor

• new TimelineIndex(timeline, index): TimelineIndex

• Parameters

  • timeline: EventTimeline
  • index: number

  Returns TimelineIndex

index

OptionalpendingPaginate

timeline

advance

• advance(delta): number

• Try move the index forward, or into the neighbouring timeline

  Parameters

  • delta: number

    number of events to advance by

  Returns number

  number of events successfully advanced by

maxIndex

• maxIndex(): number

• Returns number

  the maximum possible value for the index in the current timeline (exclusive - ie, it actually returns one more than the index of the last element).

minIndex

• minIndex(): number

• Returns number

  the minimum possible value for the index in the current timeline

retreat

• retreat(delta): number

• Try move the index backwards, or into the neighbouring timeline

  Parameters

  • delta: number

    number of events to retreat by

  Returns number

  number of events successfully retreated by