Class StorageInterface

The StorageInterface is the base class, which all external storage handlers extend from.

Hierarchy

Constructors

constructor

Methods

create delete generateUniqueKey getName getPrefix isValidKey validateKey view

Constructors

constructor

Methods

create

  • This function handles the creating a new entry in the storage backend and on success returns the generated key.

    Returns

    The key of the created entity.

    Parameters

    • data: any

      The data to be stored.

    Returns string

delete

  • This function handles the deletion of an existing stored entity in the storage backend, specified by a key.

    Parameters

    • key: string

      The key to use to delete the data.

    Returns void

generateUniqueKey

  • This method is used to generate a unique key specific to the storage engine.

    Returns

    A unique key

    Parameters

    • prefix: string

    Returns string

getName

getPrefix

isValidKey

  • Returns true / false if value is valid storage key

    Parameters

    • key: string

      string value for testing

    Returns boolean

validateKey

  • This method is used to verify that the key provided matches what the storage engine is expecting.

    Parameters

    • prefix: string
    • key: string

    Returns string

view

  • This function handles the retrival of an existing entity from the storage backend, specified by a key.

    Returns

    The entity data held in external storage

    Parameters

    • key: string

      The key to use to store the data.

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc