Class MemoryStorageDriver<Input, Output>

A storage driver that stores data in memory.

Since

v0.6.0

Example

const driver: IStorageDriver<SomeType> = new MemoryStorageDriver<SomeType>('MemoryStorageDriver', serializer, null);

Type Parameters

Input
The type of the data to serialize and deserialize.
Output
The type of the data to store.

Hierarchy (View Summary)

StorageDriver<Input, Output>
- MemoryStorageDriver

Index

Constructors

constructor

new MemoryStorageDriver<Input, Output>(
    name: string,
    serializer: IPersistSerializer<Input, Output>,
    extNotify: null | IExternalNotify,
    processor?: Loadable<IStoreProcessor<Output>>,
    logger?: ILoggerLike,
): MemoryStorageDriver<Input, Output>
Creates a new instance of the StorageDriver class.
Type Parameters
- Input
- Output
Parameters
- name: string
  The name of the storage driver.
- serializer: IPersistSerializer<Input, Output>
  The serializer to use for serializing and deserializing data.
- extNotify: null | IExternalNotify
  If driver does not support onUpdate, use this to notify with external event.
- Optionalprocessor: Loadable<IStoreProcessor<Output>>
  The store processor to use for processing data before it is written to storage and after it is loaded from storage.
- Optionallogger: ILoggerLike
  The logger to use for logging messages.
Returns MemoryStorageDriver<Input, Output>
Throws
An error if the serializer or processor is invalid.
Inherited from StorageDriver.constructor
- Defined in src/drivers/StorageDriver.ts:69

Properties

`Readonly`bandwidth

bandwidth: TachyonBandwidth = TachyonBandwidth.VeryLarge

Indicates the speed of the storage driver.

`Readonly`logger

logger: MapLogger<StorageDriverLogMapping>

`Readonly`name

name: string

The name of the storage driver.

`Readonly`serializer

serializer: IPersistSerializer<Input, Output>

Accessors

isInitialized

get isInitialized(): boolean
Indicates whether or not the storage driver has been initialized.

Returns boolean
Inherited from StorageDriver.isInitialized
- Defined in src/drivers/StorageDriver.ts:91

processor

get processor(): undefined | IStoreProcessor<Output>
Get current processor

Returns undefined | IStoreProcessor<Output>
current processor
Inherited from StorageDriver.processor
- Defined in src/drivers/StorageDriver.ts:269

Methods

clear

clear(): Promise<void>
Clear the stored data

Returns Promise<void>
Inherited from StorageDriver.clear
- Defined in src/drivers/StorageDriver.ts:231

clearResult

clearResult(): Promise<IResult<void>>
Clear the stored data and return the Promise of Result.

Returns Promise<IResult<void>>
A promise of Result that resolves when the data has been successfully cleared.
Inherited from StorageDriver.clearResult
- Defined in src/drivers/StorageDriver.ts:248

clone

clone(data: Input): Input
Clones the given data with the serializer.
Parameters
- data: Input
  The data to clone.
Returns Input
The cloned data.
Inherited from StorageDriver.clone
- Defined in src/drivers/StorageDriver.ts:261

cloneResult

cloneResult(data: Input): IResult<Input>
Clone the given data with the serializer and return Result of the cloned data.
Parameters
- data: Input
  The data to clone.
Returns IResult<Input>
The cloned data.
Inherited from StorageDriver.cloneResult
- Defined in src/drivers/StorageDriver.ts:281

getProcessor

getProcessor(): Promise<undefined | IStoreProcessor<Output>>
Retrieves the processor for the storage driver if it is available.

Returns Promise<undefined | IStoreProcessor<Output>>
The processor for the storage driver, or undefined if no processor is available.
Inherited from StorageDriver.getProcessor
- Defined in src/drivers/StorageDriver.ts:293

getProcessorResult

getProcessorResult(): Promise<IResult<undefined | IStoreProcessor<Output>>>
Retrieves the processor for the storage driver if it is available and returns the Promise of Result.

Returns Promise<IResult<undefined | IStoreProcessor<Output>>>
The processor for the storage driver, or undefined if no processor is available.
Inherited from StorageDriver.getProcessorResult
- Defined in src/drivers/StorageDriver.ts:317

getSerializer

getSerializer(): IPersistSerializer<Input, Output>
Get the serializer for the storage driver.

Returns IPersistSerializer<Input, Output>
The serializer for the storage driver.
Inherited from StorageDriver.getSerializer
- Defined in src/drivers/StorageDriver.ts:329

`Protected`handleClear

handleClear(): void
Clear the stored data in storage.

Returns void
A promise that resolves when the data has been successfully cleared.
Overrides StorageDriver.handleClear
- Defined in src/drivers/MemoryStorageDriver.ts:38

`Protected`handleHydrate

handleHydrate(): undefined | Output
Retrieve the data from storage.

Returns undefined | Output
A promise that resolves to the retrieved data, or undefined if no data was found.
Overrides StorageDriver.handleHydrate
- Defined in src/drivers/MemoryStorageDriver.ts:34

`Protected`handleInit

handleInit(): boolean
Initialize the storage driver.

Returns boolean
A promise that resolves to true if the storage driver was successfully initialized, or false otherwise.
Overrides StorageDriver.handleInit
- Defined in src/drivers/MemoryStorageDriver.ts:26

`Protected`handleStore

handleStore(data: Output): void
Store the given data to storage.
Parameters
- data: Output
Returns void
A promise that resolves when the data has been successfully stored.
Overrides StorageDriver.handleStore
- Defined in src/drivers/MemoryStorageDriver.ts:30

`Protected`handleUnload

handleUnload(): boolean
Called when the storage driver is unloaded.

Returns boolean
A promise that resolves to true if the storage driver was successfully unloaded, or false otherwise.
Overrides StorageDriver.handleUnload
- Defined in src/drivers/MemoryStorageDriver.ts:42

`Protected`handleUpdate

handleUpdate(): Promise<void>
Use this to indicate that the data has been updated.

Returns Promise<void>
Inherited from StorageDriver.handleUpdate
- Defined in src/drivers/StorageDriver.ts:361

hydrate

hydrate(options?: IHydrateOptions): Promise<undefined | Input>
Retrieves the data stored using the specified key.
Parameters
- options: IHydrateOptions = {}
  The options to use for hydrating the data.
Returns Promise<undefined | Input>
The retrieved data, or undefined if no data was found.

Throws
An error if the data fails validation.
Inherited from StorageDriver.hydrate
- Defined in src/drivers/StorageDriver.ts:195

hydrateResult

hydrateResult(options?: IHydrateOptions): Promise<IResult<undefined | Input>>
Retrieves the data stored using the specified key and returns the Promise of Result.
Parameters
- Optionaloptions: IHydrateOptions
  The options to use for hydrating the data.
Returns Promise<IResult<undefined | Input>>
Promise of Result that resolves to the retrieved data, or undefined if no data was found.
Inherited from StorageDriver.hydrateResult
- Defined in src/drivers/StorageDriver.ts:220

init

init(): Promise<boolean>
Initializes the storage driver.

Returns Promise<boolean>
A promise that resolves to true if the storage driver was successfully initialized, or false otherwise.
Inherited from StorageDriver.init
- Defined in src/drivers/StorageDriver.ts:99

initResult

initResult(): Promise<IResult<boolean>>
Initializes the storage driver and returns the Promise of Result.

Returns Promise<IResult<boolean>>
Promise of the result object, see Result
Inherited from StorageDriver.initResult
- Defined in src/drivers/StorageDriver.ts:116

setData

setData(data: undefined | Output): Promise<void>
Set the data to store and emit an update.
Parameters
- data: undefined | Output
  The data to store.
Returns Promise<void>
A promise that resolves when the data has been successfully stored.
- Defined in src/drivers/MemoryStorageDriver.ts:21

store

store(data: Input): Promise<void>
Stores the given data using the specified key.
Parameters
- data: Input
  The data to store.
Returns Promise<void>
Inherited from StorageDriver.store
- Defined in src/drivers/StorageDriver.ts:158

storeResult

storeResult(data: Input): Promise<IResult<void>>
Stores the given data using the specified key and returns the Promise of Result.
Parameters
- data: Input
  The data to store.
Returns Promise<IResult<void>>
A promise of Result that resolves when the data has been successfully stored.
Inherited from StorageDriver.storeResult
- Defined in src/drivers/StorageDriver.ts:181

toJSON

toJSON(): StorageDriverJson
Build the default JSON representation of the storage driver.

Returns StorageDriverJson
The JSON representation of the storage driver.
Example
```
// override the toJSON method to include additional (typed) properties
public override toJSON(): FooStorageDriverJson {
	return {
		...super.toJSON(),
		foo: this.foo,
	};
}
```
Inherited from StorageDriver.toJSON
- Defined in src/drivers/StorageDriver.ts:349

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from StorageDriver.toString
- Defined in src/drivers/StorageDriver.ts:333

unload

unload(): Promise<boolean>
Unload the storage driver.

Returns Promise<boolean>
A promise that resolves to true if the storage driver was successfully unloaded, or false otherwise.
Inherited from StorageDriver.unload
- Defined in src/drivers/StorageDriver.ts:128

unloadResult

unloadResult(): Promise<IResult<boolean>>
Unload the storage driver and return the Promise of Result.

Returns Promise<IResult<boolean>>
A promise of Result that resolves to true if the storage driver was successfully unloaded, or false otherwise.
Inherited from StorageDriver.unloadResult
- Defined in src/drivers/StorageDriver.ts:146

Class MemoryStorageDriver<Input, Output>

Since

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MemoryStorageDriver<Input, Output>

Throws

Properties

Readonlybandwidth

Readonlylogger

Readonlyname

Readonlyserializer

Accessors

isInitialized

Returns boolean

processor

Returns undefined | IStoreProcessor<Output>

Methods

clear

Returns Promise<void>

clearResult

Returns Promise<IResult<void>>

clone

Parameters

Returns Input

cloneResult

Parameters

Returns IResult<Input>

getProcessor

Returns Promise<undefined | IStoreProcessor<Output>>

getProcessorResult

Returns Promise<IResult<undefined | IStoreProcessor<Output>>>

getSerializer

Returns IPersistSerializer<Input, Output>

ProtectedhandleClear

Returns void

ProtectedhandleHydrate

Returns undefined | Output

ProtectedhandleInit

Returns boolean

ProtectedhandleStore

Parameters

Returns void

ProtectedhandleUnload

Returns boolean

ProtectedhandleUpdate

Returns Promise<void>

hydrate

Parameters

Returns Promise<undefined | Input>

Throws

hydrateResult

Parameters

Returns Promise<IResult<undefined | Input>>

init

Returns Promise<boolean>

initResult

Returns Promise<IResult<boolean>>

setData

Parameters

Returns Promise<void>

store

Parameters

Returns Promise<void>

storeResult

Parameters

Returns Promise<IResult<void>>

toJSON

Returns StorageDriverJson

Example

toString

`Readonly`bandwidth

`Readonly`logger

`Readonly`name

`Readonly`serializer

`Protected`handleClear

`Protected`handleHydrate

`Protected`handleInit

`Protected`handleStore

`Protected`handleUnload

`Protected`handleUpdate