From 34b71f0a1c55d67d63376e8a995b2d4a3cf6ba9f Mon Sep 17 00:00:00 2001
From: Jay <jasonsaayman@gmail.com>
Date: Thu, 2 Jun 2022 20:45:27 +0200
Subject: [PATCH] chore(helpers/validator): added docs for validator function

---
 lib/helpers/validator.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/lib/helpers/validator.js b/lib/helpers/validator.js
index 8095b90..4b022f4 100644
--- a/lib/helpers/validator.js
+++ b/lib/helpers/validator.js
@@ -16,9 +16,11 @@ var deprecatedWarnings = {};
 
 /**
  * Transitional option validator
+ *
  * @param {function|boolean?} validator - set to false if the transitional option has been removed
  * @param {string?} version - deprecated version / removed since version
  * @param {string?} message - some message with additional info
+ *
  * @returns {function}
  */
 validators.transitional = function transitional(validator, version, message) {
@@ -52,9 +54,12 @@ validators.transitional = function transitional(validator, version, message) {
 
 /**
  * Assert object's properties type
+ *
  * @param {object} options
  * @param {object} schema
  * @param {boolean?} allowUnknown
+ *
+ * @returns {object}
  */
 
 function assertOptions(options, schema, allowUnknown) {