Class BlocksService

description: The main service of the Blocks module.
since: v0.3.2

Hierarchy

BlocksService

Index

Constructors

constructor

Methods

Constructors

constructor

new BlocksService(model: BlockModel, queriesService: QueryService<BlockDocument, BlockModel>): BlocksService

- Defined in src/discovery/services/BlocksService.ts:39
The constructor of the service.

Parameters
- model: BlockModel
- queriesService: QueryService<BlockDocument, BlockModel>
Returns BlocksService

Methods

createOrUpdateBatch

createOrUpdateBatch(blockDocuments: BlockModel[]): Promise<number>

- Defined in src/discovery/services/BlocksService.ts:74
Method to update a batch of blocks.

async
Parameters
- blockDocuments: BlockModel[]
Returns Promise<number>

exists

exists(query: BlockQuery): Promise<boolean>

- Defined in src/discovery/services/BlocksService.ts:55
Method to query the existence of a document in the blocks collection.

This executes a lean mongoose query such that the properties of the returned document are reduced to only the "_id" field.

Parameters
- query: BlockQuery
  
  The query configuration with sort, order, pageNumber, pageSize.
Returns Promise<boolean>
Whether a document exists which validates the passed query.

Generated using TypeDoc