Class CheckpointsManager<T>

constructor

• new CheckpointsManager<T>(
      name: string,
      maxItems?: number,
  ): CheckpointsManager<T>

  Type Parameters

  • T

  Parameters

  • name: string
  • OptionalmaxItems: number

  Returns CheckpointsManager<T>

ready

StatictoHumanDate

clear

• clear(): Promise<void>

  Clear all checkpoints.

  Returns Promise<void>

get

• get(timestamp: string): Promise<T | null | undefined>

  Get checkpoint from its timestamp.

  Parameters

  • timestamp: string

  Returns Promise<T | null | undefined>

getIndex

• getIndex(index: number): Promise<T | null | undefined>

  Get checkpoint at a specific index (0 is the most recent).

  Parameters

  • index: number

  Returns Promise<T | null | undefined>

getIndexTags

• getIndexTags(index: number): Promise<string[] | undefined>

  Get tags at a specific index (0 is the most recent).

  Parameters

  • index: number

  Returns Promise<string[] | undefined>

getIndexTimestamp

• getIndexTimestamp(index: number): Promise<string | undefined>

  Get timestamp at a specific index (0 is the most recent).

  Parameters

  • index: number

  Returns Promise<string | undefined>

getLast

• getLast(): Promise<T | null | undefined>

  Get the most recent checkpoint. Equivalent to getIndex(0).

  Returns Promise<T | null | undefined>

getLastTags

• getLastTags(): Promise<string[] | undefined>

  Get the most recent tags. Equivalent to getIndex(0).

  Returns Promise<string[] | undefined>

getLastTimestamp

• getLastTimestamp(): Promise<string | undefined>

  Get the most recent timestamp. Equivalent to getIndexTimestamp(0).

  Returns Promise<string | undefined>

getTags

• getTags(timestamp: string): Promise<string[] | undefined>

  Get tags from timestamp.

  Parameters

  • timestamp: string

  Returns Promise<string[] | undefined>

hasTag

• hasTag(timestamp: string, tag: string): Promise<boolean | null>

  Does this checkpoint has this tag?

  Parameters

  • timestamp: string
  • tag: string

  Returns Promise<boolean | null>

lastHasTag

• lastHasTag(tag: string): Promise<boolean | null>

  Does the most recent checkpoint has this tag?

  Parameters

  • tag: string

  Returns Promise<boolean | null>

length

• length(): Promise<number>

  Get the total number of checkpoints.

  Returns Promise<number>

push

• push(data: T, tags?: string[] | null): Promise<string>

  Push checkpoint to DB. Timestamps are computed here. tags is an array of strings.

  Parameters

  • data: T
  • Optionaltags: string[] | null

  Returns Promise<string>

remove

• remove(timestamp: string): Promise<void>

  Remove checkpoint at a specific timestamp.

  Parameters

  • timestamp: string

  Returns Promise<void>

removeOldest

• removeOldest(): Promise<void>

  Remove the oldest checkpoint.

  Returns Promise<void>

tag

• tag(timestamp: string, tag: string): Promise<void>

  Set a tag to a checkpoint.

  Parameters

  • timestamp: string
  • tag: string

  Returns Promise<void>

tagLast

• tagLast(tag: string): Promise<void>

  Add a tag to last checkpoint.

  Parameters

  • tag: string

  Returns Promise<void>

times

• times(): Promise<string[] | undefined>

  Get the array of all timestamps sorted in reverse historical order.

  Returns Promise<string[] | undefined>

untag

• untag(timestamp: string, tag: string): Promise<void>

  Remove a tag from a checkpoint.

  Parameters

  • timestamp: string
  • tag: string

  Returns Promise<void>

untagLast

• untagLast(tag: string): Promise<void>

  Remove a tag from last checkpoint.

  Parameters

  • tag: string

  Returns Promise<void>

Staticdrop

• drop(name: string): Promise<void>

  Drop a checkpoint table from its name.

  Parameters

  • name: string

  Returns Promise<void>