[]
        
(Showing Draft Content)

IMilestoneDatabaseAdapter

Interface: IMilestoneDatabaseAdapter<S>

Defines the interface for a milestone database adapter.

Type parameters

Name
S

Table of contents

Properties

Methods

Properties

interval

interval: number

The interval for saving milestone snapshots.

default 1000

Methods

getMilestoneSnapshot

getMilestoneSnapshot(id, version): Promise<undefined | ISnapshot<S>>

Retrieves a milestone snapshot by document ID and version.

Parameters

Name Type
id string
version number

Returns

Promise<undefined | ISnapshot<S>>


saveMilestoneSnapshot

saveMilestoneSnapshot(snapshot): Promise<boolean>

Saves a milestone snapshot.

Parameters

Name Type
snapshot ISnapshot<S>

Returns

Promise<boolean>