root
/
request.js
mirror of https://github.com/therootcompany/request.js
2
0
Fork 0
Code Issues Releases Wiki Activity

fix(types): add RequestOptions

This commit is contained in:
AJ ONeal 2022-09-01 00:33:01 -06:00
parent 88ae1a2086
commit 968926cdc5
Signed by: coolaj86
GPG Key ID: 585419CA6DB0AA23
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
local-types.js
View File

@ -1,4 +1,5 @@
/**
* @typedef {import('./types.js').RequestOptions} RequestOptions
* @typedef {import('./types.js').Response} Response
* @typedef {import('./types.js').Headers} Headers
*/

18
types.js
View File

@ -4,16 +4,20 @@ module.exports._typesOnly = true;
/**
* @callback Request
* @param {Object} opts
* @param {any} [opts.body]
* @param {Object.<String,any>} [opts.form]
* @param {Headers} [opts.headers]
* @param {String} [opts.method]
* @param {Boolean | any} [opts.json]
* @param {String} opts.url
* @param {RequestOptions} opts
* @returns {Response}
*/
/**
* @typedef {Object} RequestOptions
* @prop {any} [opts.body]
* @prop {Object.<String,any>} [opts.form]
* @prop {Headers} [opts.headers]
* @prop {String} [opts.method]
* @prop {Boolean | any} [opts.json]
* @prop {String} opts.url
*/
/**
* @typedef {Object} Response
* @prop {any} body