Interface PoiTypeRepositoryInterface

The PoiTypeRepository retreives PoiTypes from the database through the REST API.

A full list of PoiTypes can be fetched by calling findAll and a specific PoiType by calling findOne.

Hierarchy

RestRepositoryInterface<PoiTypeInterface>
- PoiTypeRepositoryInterface

Index

Methods

Methods

create

create(): PoiTypeInterface

Inherited from RestRepositoryInterface.create

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

Returns PoiTypeInterface

filter

filter(params: RestFilterInterface): Promise<PoiTypeInterface[]>

Inherited from RestRepositoryInterface.filter

Find all repository items matching the filter parameters.

Parameters
- params: RestFilterInterface
Returns Promise<PoiTypeInterface[]>

findAll

findAll(forceFetch?: boolean): Promise<PoiTypeInterface[]>

Inherited from RestRepositoryInterface.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
  
  Flag whether to force a server request or not. False by default.
Returns Promise<PoiTypeInterface[]>

Array of resources.

findOne

findOne(id: number, forceFetch?: boolean): Promise<PoiTypeInterface>

Inherited from RestRepositoryInterface.findOne

Gets one repository item by id. 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. In case a new record is fetched, the data will be updated accordingly.

Parameters
- id: number
- Optional forceFetch: boolean
  
  False by default.
Returns Promise<PoiTypeInterface>

remove

remove(item: PoiTypeInterface): Promise<void>

Inherited from RestRepositoryInterface.remove

Deletes an item from the repository.

Parameters
- item: PoiTypeInterface
Returns Promise<void>

save

save(resources: PoiTypeInterface | PoiTypeInterface[]): Promise<PoiTypeInterface[]>

Inherited from RestRepositoryInterface.save

Saves new and/or updated items.

Parameters
- resources: PoiTypeInterface | PoiTypeInterface[]
  
  The resource or array of resources to save or update.
Returns Promise<PoiTypeInterface[]>

A new array with referenced resources.

Generated using TypeDoc