Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPersistenceRead

Provides a read-only accessor for the App's persistent storage. A App only has access to its own persistent storage and does not have access to any other App's.

Hierarchy

  • IPersistenceRead

Index

Methods

read

  • read(id: string): Promise<object>
  • Retrieves a record from the App's persistent storage by the provided id. A "falsey" value (undefined or null or false) is returned should nothing exist in the storage by the provided id.

    Parameters

    • id: string

      the record to get's id

    Returns Promise<object>

    the record if it exists, falsey if not

readByAssociation

  • Retrieves a record from the App's persistent storage by the provided id. An empty array is returned should there be no records associated with the data provided.

    Parameters

    Returns Promise<Array<object>>

    array of the records if any exists, empty array if none exist

readByAssociations

  • Retrieves a record from the App's persistent storage by the provided id. Providing more than one association record acts like an AND which means a record in persistent storage must have all of the associations to be considered a match. An empty array is returned should there be no records associated with the data provided.

    Parameters

    Returns Promise<Array<object>>

    array of the records if any exists, empty array if none exist

Generated using TypeDoc