Interface RestRepositoryInterface<T>

The RestRepository retreives resources from the database through the REST API.

A full list of resources can be fetched by calling findAll and a specific resource by calling findOne.

interface RestRepositoryInterface<T> {
    create(): T;
    filter(params): Promise<T[]>;
    findAll(forceFetch?): Promise<T[]>;
    findOne(id, forceFetch?): Promise<T>;
    remove(item): Promise<void>;
    save(items): Promise<T[]>;
}

Type Parameters

  • T

Hierarchy (view full)

Methods

create filter findAll findOne remove save

Methods

create

  • create(): T

  • Factory method. Creates and returns a new empty instance of the entity.

    Returns T

    An instance of the entity.

filter

  • filter(params): Promise<T[]>

  • Find all repository items matching the filter parameters.

    Parameters

    Returns Promise<T[]>

    Promise with the entities that match the filter.

findAll

  • findAll(forceFetch?): Promise<T[]>

  • Gets all repository items. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server.

    Parameters

    • Optional forceFetch: boolean

      Whether to bypass the cache and retrieve a fresh copy from the server.

    Returns Promise<T[]>

    Promise with the repository items.

findOne

  • findOne(id, forceFetch?): Promise<T>

  • Get one repository item by id. The cached data will be returned if the data has been fetched before. Use the forceFetch parameter to retrieve a fresh copy from the server. In case a new record is fetched, the data and dataMap will be updated accordingly.

    Parameters

    • id: number

      Identifier of the repository item

    • Optional forceFetch: boolean

      Whether to bypass the cache and retrieve a fresh copy from the server.

    Returns Promise<T>

remove

  • remove(item): Promise<void>

  • Deletes an item from the repository.

    Parameters

    • item: T

      The item to delete.

    Returns Promise<void>

    Promise that resolves once the request has completed.

save

  • save(items): Promise<T[]>

  • Saves new and/or updated items.

    Parameters

    • items: T | T[]

      The item(s) to save or update.

    Returns Promise<T[]>

    Promise with the saved objects.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc