Class PersistenceAPI

Index

Constructors

Methods

clear createSnapshot getRuntimeState health initialize load loadEvents save saveEvent shutdown statistics status

Constructors

constructor

new PersistenceAPI(retryConfig?: Partial<RetryConfig>): PersistenceAPI
Parameters
- OptionalretryConfig: Partial<RetryConfig>
Returns PersistenceAPI
- Defined in persistence/dist/api.d.ts:109

Methods

clear

clear(): Promise<ClearApiResult>
Returns Promise<ClearApiResult>
- Defined in persistence/dist/api.d.ts:119

createSnapshot

createSnapshot(snapshot: PersistenceSnapshot): Promise<CreateSnapshotResult>
Parameters
- snapshot: PersistenceSnapshot
Returns Promise<CreateSnapshotResult>
- Defined in persistence/dist/api.d.ts:114

getRuntimeState

getRuntimeState(): RuntimeState
Returns RuntimeState
- Defined in persistence/dist/api.d.ts:121

health

health(): Promise<HealthApiResult>
Returns Promise<HealthApiResult>
- Defined in persistence/dist/api.d.ts:117

initialize

initialize(
backend: PersistenceBackend,
config?: Partial<PersistenceConfig>,
): Promise<InitializeResult>
Parameters
- backend: PersistenceBackend
- Optionalconfig: Partial<PersistenceConfig>
Returns Promise<InitializeResult>
- Defined in persistence/dist/api.d.ts:110

load

load(): Promise<LoadApiResult>
Returns Promise<LoadApiResult>
- Defined in persistence/dist/api.d.ts:113

loadEvents

loadEvents(): Promise<LoadEventsApiResult>
Returns Promise<LoadEventsApiResult>
- Defined in persistence/dist/api.d.ts:116

save

save(snapshot: PersistenceSnapshot): Promise<SaveApiResult>
Parameters
- snapshot: PersistenceSnapshot
Returns Promise<SaveApiResult>
- Defined in persistence/dist/api.d.ts:112

saveEvent

saveEvent(event: PersistedEvent): Promise<SaveEventApiResult>
Parameters
- event: PersistedEvent
Returns Promise<SaveEventApiResult>
- Defined in persistence/dist/api.d.ts:115

shutdown

shutdown(): Promise<ShutdownResult>
Returns Promise<ShutdownResult>
- Defined in persistence/dist/api.d.ts:111

statistics

statistics(): Promise<StatisticsApiResult>
Returns Promise<StatisticsApiResult>
- Defined in persistence/dist/api.d.ts:120

status

status(): StatusApiResult
Returns StatusApiResult
- Defined in persistence/dist/api.d.ts:118