Class StorageDriver<Input, Output>Abstract

constructor

• new StorageDriver<Input, Output>(
      name: string,
      serializer: IPersistSerializer<Input, Output>,
      extNotify: null | IExternalNotify,
      processor?: Loadable<IStoreProcessor<Output>>,
      logger?: ILoggerLike,
  ): StorageDriver<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 StorageDriver<Input, Output>

  Throws

  An error if the serializer or processor is invalid.

Abstract Readonlybandwidth

Readonlylogger

Readonlyname

Readonlyserializer

isInitialized

• get isInitialized(): boolean

  Indicates whether or not the storage driver has been initialized.

  Returns boolean

processor

• get processor(): undefined | IStoreProcessor<Output>

  Get current processor

  Returns undefined | IStoreProcessor<Output>

  current processor

clear

• clear(): Promise<void>

  Clear the stored data

  Returns Promise<void>

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.

clone

• clone(data: Input): Input

  Clones the given data with the serializer.

  Parameters

  • data: Input

    The data to clone.

  Returns Input

  The cloned data.

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.

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.

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.

getSerializer

• getSerializer(): IPersistSerializer<Input, Output>

  Get the serializer for the storage driver.

  Returns IPersistSerializer<Input, Output>

  The serializer for the storage driver.

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.

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.

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.

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

store

• store(data: Input): Promise<void>

  Stores the given data using the specified key.

  Parameters

  • data: Input

    The data to store.

  Returns Promise<void>

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.

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,
  	};
  }
  Copy

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

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.

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.