Class CheckpointsManager<T>

A class to manage checkpoints (multiple backups). Stored data is of type string (json conversion if needed). One can add tags to checkpoints.

name is a string used to identify each instance. maxItems is the maximum number of checkpoints we keep before removing old ones. Set to zero to disable.

Type Parameters

T

Index

Constructors

Properties

ready toHumanDate

Methods

clear get getIndex getIndexTags getIndexTimestamp getLast getLastTags getLastTimestamp getTags hasTag lastHasTag length push remove removeOldest tag tagLast times untag untagLast drop

Constructors

constructor

new CheckpointsManager<T>(
name: string,
maxItems?: number,
): CheckpointsManager<T>
Type Parameters
- T
Parameters
- name: string
- OptionalmaxItems: number
Returns CheckpointsManager<T>
- Defined in src/lib/outils/basthon/basthon.types.ts:204

Properties

ready

ready: () => Promise<void>

`Static`toHumanDate

toHumanDate: (timestamp: string | number) => string

Convert a timestamp to a (french) human date : DD/MM/YYYY, hh:mm:ss

Methods

clear

clear(): Promise<void>
Clear all checkpoints.

Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:289

get

get(timestamp: string): Promise<T | null | undefined>
Get checkpoint from its timestamp.
Parameters
- timestamp: string
Returns Promise<T | null | undefined>
- Defined in src/lib/outils/basthon/basthon.types.ts:233

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>
- Defined in src/lib/outils/basthon/basthon.types.ts:257

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>
- Defined in src/lib/outils/basthon/basthon.types.ts:261

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>
- Defined in src/lib/outils/basthon/basthon.types.ts:253

getLast

getLast(): Promise<T | null | undefined>
Get the most recent checkpoint. Equivalent to getIndex(0).

Returns Promise<T | null | undefined>
- Defined in src/lib/outils/basthon/basthon.types.ts:269

getLastTags

getLastTags(): Promise<string[] | undefined>
Get the most recent tags. Equivalent to getIndex(0).

Returns Promise<string[] | undefined>
- Defined in src/lib/outils/basthon/basthon.types.ts:273

getLastTimestamp

getLastTimestamp(): Promise<string | undefined>
Get the most recent timestamp. Equivalent to getIndexTimestamp(0).

Returns Promise<string | undefined>
- Defined in src/lib/outils/basthon/basthon.types.ts:265

getTags

getTags(timestamp: string): Promise<string[] | undefined>
Get tags from timestamp.
Parameters
- timestamp: string
Returns Promise<string[] | undefined>
- Defined in src/lib/outils/basthon/basthon.types.ts:237

hasTag

hasTag(timestamp: string, tag: string): Promise<boolean | null>
Does this checkpoint has this tag?
Parameters
- timestamp: string
- tag: string
Returns Promise<boolean | null>
- Defined in src/lib/outils/basthon/basthon.types.ts:241

lastHasTag

lastHasTag(tag: string): Promise<boolean | null>
Does the most recent checkpoint has this tag?
Parameters
- tag: string
Returns Promise<boolean | null>
- Defined in src/lib/outils/basthon/basthon.types.ts:277

length

length(): Promise<number>
Get the total number of checkpoints.

Returns Promise<number>
- Defined in src/lib/outils/basthon/basthon.types.ts:245

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>
- Defined in src/lib/outils/basthon/basthon.types.ts:213

remove

remove(timestamp: string): Promise<void>
Remove checkpoint at a specific timestamp.
Parameters
- timestamp: string
Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:281

removeOldest

removeOldest(): Promise<void>
Remove the oldest checkpoint.

Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:285

tag

tag(timestamp: string, tag: string): Promise<void>
Set a tag to a checkpoint.
Parameters
- timestamp: string
- tag: string
Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:217

tagLast

tagLast(tag: string): Promise<void>
Add a tag to last checkpoint.
Parameters
- tag: string
Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:225

times

times(): Promise<string[] | undefined>
Get the array of all timestamps sorted in reverse historical order.

Returns Promise<string[] | undefined>
- Defined in src/lib/outils/basthon/basthon.types.ts:249

untag

untag(timestamp: string, tag: string): Promise<void>
Remove a tag from a checkpoint.
Parameters
- timestamp: string
- tag: string
Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:221

untagLast

untagLast(tag: string): Promise<void>
Remove a tag from last checkpoint.
Parameters
- tag: string
Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:229

`Static`drop

drop(name: string): Promise<void>
Drop a checkpoint table from its name.
Parameters
- name: string
Returns Promise<void>
- Defined in src/lib/outils/basthon/basthon.types.ts:297