Module routes/login

Index

Functions

Functions

getRouter

getRouter(): express.Router

- Defined in routes/login.ts:96
Gets the router for all /login/ related endpoints.

Returns express.Router
An Express.js {@link express.Router} routing all /login/ endpoints.

login

login(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Login>

- Defined in routes/login.ts:20
Attempts to log a user into the system.

Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  
  The Express.js request to extract all required data from.
Returns Promise<Responses.Login>
See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

logout

logout(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Empty>

- Defined in routes/login.ts:81
Attempts to log a user out of the system.

Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  
  The Express.js request to extract all required data from.
Returns Promise<Responses.Empty>
See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

Generated using TypeDoc