TransactionsController | @dhealthdapps/backend

label

DISCOVERY

description

The transactions controller of the app. Handles requests about transactions that are available in the database.

This controller defines the following routes:

URI	HTTP method	Class method	Description
`/transactions`	`GET`	find	Responds with a pageable PaginatedResultDTO that contains TransactionDTO objects.

since

v0.3.0

Hierarchy

TransactionsController

Index

Constructors

constructor

Methods

find

Constructors

constructor

new TransactionsController(transactionsService: TransactionsService): TransactionsController

- Defined in src/discovery/routes/TransactionsController.ts:74
Constructs an instance of this controller.

Parameters
- transactionsService: TransactionsService
Returns TransactionsController

Methods

find

find(query: TransactionQuery): Promise<PaginatedResultDTO<TransactionDTO>>

- Defined in src/discovery/routes/TransactionsController.ts:99
Handler of the /transactions endpoint. Returns all transactions that match the request query. If the query is null or not specified, returns all documents.

The result of this endpoint can be paginated using query parameters: pageSize, pageNumber. Also, it can be sorted with query parameters: sort, order.

async
access
public

method
GET

Parameters
- query: TransactionQuery
Returns Promise<PaginatedResultDTO<TransactionDTO>>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

transactionsService: TransactionsService

Returns TransactionsController

Methods

find

Parameters

query: TransactionQuery

Returns Promise<PaginatedResultDTO<TransactionDTO>>