Interface SnapshotProvider

Interface provided by the class set in the snapshotProvider option. save() may be an async method, but read() must be synchronous.

interface SnapshotProvider {
    file: string;
    read(msg: string): string;
    save(): void | Promise<void>;
    snap(data: string, msg: string): void;
}

Implemented by

SnapshotProviderDefault

Index

Properties

Methods

Properties

file

file: string

Methods

read

read(msg): string
Parameters
- msg: string
Returns string
- Defined in src/snapshot/src/index.ts:29

save

save(): void | Promise<void>
Returns void | Promise<void>
- Defined in src/snapshot/src/index.ts:31

snap

snap(data, msg): void
Parameters
- data: string
- msg: string
Returns void
- Defined in src/snapshot/src/index.ts:30