Class Controller

Modular Controller with CRUD methods using Firestore repository and DocumentData type.

Hierarchy

Controller

Implements

IController

Index

Constructors

constructor

Properties

repository

Methods

Constructors

constructor

new Controller(collectionName: string): Controller

- Defined in controllers/controller.ts:16
Parameters
- collectionName: string
Returns Controller

Properties

Private repository

repository: FirestoreRepository

Firebase repository used by CRUD methods.

Methods

create

create(req: Request, res: Response, next: NextFunction): DocumentData | undefined

Implementation of IController.create
- Defined in controllers/controller.ts:27
Create a document in Firestore collection using the DocumentData received in the request body.

Parameters
- req: Request
  
  The request received by the API Rest
- res: Response
  
  The response sent by the API Rest
- next: NextFunction
  
  The next function executed in the app's middleware
Returns DocumentData | undefined

delete

delete(req: Request, res: Response, next: NextFunction): DocumentData | undefined

Implementation of IController.delete
- Defined in controllers/controller.ts:137
Delete document by the given id

Parameters
- req: Request
  
  The request received by the API Rest
- res: Response
  
  The response sent by the API Rest
- next: NextFunction
  
  The next function executed in the app's middleware
Returns DocumentData | undefined

readAll

readAll(req: Request, res: Response, next: NextFunction): DocumentData[] | undefined

Implementation of IController.readAll
- Defined in controllers/controller.ts:73
Read all documents available in the Firestore collection.

Parameters
- req: Request
  
  The request received by the API Rest
- res: Response
  
  The response sent by the API Rest
- next: NextFunction
  
  The next function executed in the app's middleware
Returns DocumentData[] | undefined

readOne

readOne(req: Request, res: Response, next: NextFunction): DocumentData | undefined

Implementation of IController.readOne
- Defined in controllers/controller.ts:53
Read one document by the given id.

Parameters
- req: Request
  
  The request received by the API Rest
- res: Response
  
  The response sent by the API Rest
- next: NextFunction
  
  The next function executed in the app's middleware
Returns DocumentData | undefined

update

update(req: Request, res: Response, next: NextFunction): DocumentData | undefined

Implementation of IController.update
- Defined in controllers/controller.ts:107
Update document fields by the given id.

Parameters
- req: Request
  
  The request received by the API Rest
- res: Response
  
  The response sent by the API Rest
- next: NextFunction
  
  The next function executed in the app's middleware
Returns DocumentData | undefined

Generated using TypeDoc