Class StateService

description: The main service for the state module. Responsible for querying and saving states of the application.
since: v0.1.0

Hierarchy

StateService

Index

Constructors

constructor

Methods

Constructors

constructor

new StateService(model: StateModel, queryService: QueryService<StateDocument, StateModel>): StateService

- Defined in src/common/services/StateService.ts:38
The constructor of this class.

Parameters
- model: StateModel
- queryService: QueryService<StateDocument, StateModel>
Returns StateService

Methods

findOne

findOne(query: StateQuery): Promise<StateDocument>

- Defined in src/common/services/StateService.ts:53
Find one TDocument instance in the database and use a query based on the Queryable class.

access
public

async
Parameters
- query: StateQuery
  
  The query configuration with sort, order, pageNumber, pageSize.
Returns Promise<StateDocument>
The resulting states document.

updateOne

updateOne(query: StateQuery, data: any): Promise<StateDocument>

- Defined in src/common/services/StateService.ts:68
This method updates exactly one document in a collection. The query is build using getQueryConfig and can thereby use any columns of the document.

async
Parameters
- query: StateQuery
  
  The query configuration with sort, order, pageNumber, pageSize.
- data: any
  
  The fields or data that has to be updated (will be added to $set: {}).
Returns Promise<StateDocument>
The updated states document.

Generated using TypeDoc