@proto-kit/sequencer • Docs

Documentation / @proto-kit/sequencer / InMemoryDatabase

Class: InMemoryDatabase

Lifecycle of a SequencerModule

start(): Executed to execute any logic required to start the module

Extends

• SequencerModule

Implements

• Database

Constructors

new InMemoryDatabase()

new InMemoryDatabase(): InMemoryDatabase

Returns

InMemoryDatabase

Inherited from

SequencerModule.constructor

Properties

currentConfig

protected currentConfig: undefined | NoConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

SequencerModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

presets

static presets: Presets<unknown> = {}

Inherited from

SequencerModule.presets

Defined in

packages/sequencer/src/sequencer/builder/SequencerModule.ts:20

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

SequencerModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

close()

close(): Promise<void>

Returns

Promise<void>

Implementation of

Database.close

Defined in

packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:72

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

SequencerModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20

executeInTransaction()

executeInTransaction(f): Promise<void>

Parameters

• f

Returns

Promise<void>

Implementation of

Database.executeInTransaction

Defined in

packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:83

pruneDatabase()

pruneDatabase(): Promise<void>

Returns

Promise<void>

Defined in

packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:76

start()

start(): Promise<void>

Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.

Returns

Promise<void>

Overrides

SequencerModule.start

Defined in

packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:68

dependencies()

static dependencies(): StorageDependencyMinimumDependencies<InMemoryDatabase>

Returns

StorageDependencyMinimumDependencies<InMemoryDatabase>

Defined in

packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:24