mirrors/axios
2
0
Fork 0
mirror of https://github.com/tenrok/axios.git synced 2026-06-20 20:00:40 +03:00
Code Activity

chore(helpers/validator): added docs for validator function

Browse Source
This commit is contained in:
Jay
2022-06-02 20:45:27 +02:00
parent 74f59eac88
commit 34b71f0a1c
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/helpers/validator.js
+5
View File
@@ -16,9 +16,11 @@ var deprecatedWarnings = {};
/** /**
* Transitional option validator * Transitional option validator
*
* @param {function|boolean?} validator - set to false if the transitional option has been removed * @param {function|boolean?} validator - set to false if the transitional option has been removed
* @param {string?} version - deprecated version / removed since version * @param {string?} version - deprecated version / removed since version
* @param {string?} message - some message with additional info * @param {string?} message - some message with additional info
*
* @returns {function} * @returns {function}
*/ */
validators.transitional = function transitional(validator, version, message) { validators.transitional = function transitional(validator, version, message) {
@@ -52,9 +54,12 @@ validators.transitional = function transitional(validator, version, message) {
/** /**
* Assert object's properties type * Assert object's properties type
*
* @param {object} options * @param {object} options
* @param {object} schema * @param {object} schema
* @param {boolean?} allowUnknown * @param {boolean?} allowUnknown
*
* @returns {object}
*/ */
function assertOptions(options, schema, allowUnknown) { function assertOptions(options, schema, allowUnknown) {