Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PoiRepositoryInterface

The PoiRepository retrieves POIs from the database through the REST API.

A full list of POIs can be fetched by calling findAll and a specific POI by calling findOne.

Hierarchy

Index

Methods

create

createFilterBuilder

filter

findAll

  • 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<PoiInterface[]>

    Promise with the repository items.

findOne

  • findOne(id: number, forceFetch?: boolean): Promise<PoiInterface>
  • 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<PoiInterface>

remove

  • Deletes an item from the repository.

    Parameters

    Returns Promise<void>

    Promise that resolves once the request has completed.

save

Generated using TypeDoc