forked from sqlpad/sqlpad
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypedefs.js
More file actions
25 lines (22 loc) · 810 Bytes
/
typedefs.js
File metadata and controls
25 lines (22 loc) · 810 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/**
* The expressjs Request object plus decorations
* @typedef {Object} SQLPadReq
* @property {Object} config
* @property {Object} log - Pino web logger. Same as appLog but no setLevel
* @property {import('./lib/logger')} appLog - Pino app logger
* @property {import('./models')} models - Collection of data access objects
* @property {import('./lib/webhooks')} webhooks - Webhook utility instance
*/
/**
* Collection of utilities added to expressjs's res object
* @typedef {object} SQLPadRes
* @property {import('./lib/response-utils')} utils - utils for sending response
*/
/**
* The expressjs Req object plus decorations
* @typedef {import('express').Request & SQLPadReq} Req
*/
/**
* The expressjs Res object plus decorations
* @typedef {import('express').Response & SQLPadRes} Res
*/