itee-validators 5.3.5 → 5.3.7

package/builds/itee-validators.iife.min.js

@@ -704,7 +704,7 @@ const Z=4.5e-10,x=-273.14999999955,G=-459.67;
 	 * @author [Tristan Valcke]{@link https://github.com/Itee}
 	 * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
 	 *
-	 * @module sources/physics/temperatues
+	 * @module sources/physics/temperatures
 	 * @desc Export function to validate if a value is a Celsius temperature
 	 * @example
 	 *
@@ -722,7 +722,7 @@ function Y(r){return A(r)&&r>=x}function K(r){return!Y(r)}
 	 * @author [Tristan Valcke]{@link https://github.com/Itee}
 	 * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
 	 *
-	 * @module sources/physics/temperatues
+	 * @module sources/physics/temperatures
 	 * @desc Export function to validate if a value is a Fahrenheit temperature
 	 * @example
 	 *
@@ -739,7 +739,7 @@ function Y(r){return A(r)&&r>=x}function K(r){return!Y(r)}
 	 * @author [Tristan Valcke]{@link https://github.com/Itee}
 	 * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
 	 *
-	 * @module sources/physics/temperatues
+	 * @module sources/physics/temperatures
 	 * @desc Export function to validate if a value is a kelvin temperature
 	 * @example
 	 *
@@ -756,7 +756,7 @@ function Y(r){return A(r)&&r>=x}function K(r){return!Y(r)}
 	 * @author [Tristan Valcke]{@link https://github.com/Itee}
 	 * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
 	 *
-	 * @module sources/physics/temperatues
+	 * @module sources/physics/temperatures
 	 * @desc Export function to validate if a value is a temperature
 	 * @example
 	 *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itee-validators",
-  "version": "5.3.5",
+  "version": "5.3.7",
   "description": "A library of validation functions use in various Itee projects",
   "keywords": [
     "itee",
@@ -28,7 +28,7 @@
     "url": "https://github.com/Itee/itee-validators/issues"
   },
   "engines": {
-    "node": ">=8.16.0"
+    "node": ">=18"
   },
   "os": [
     "win32",
@@ -45,56 +45,59 @@
     "clean": "gulp clean",
     "lint": "gulp lint",
     "doc": "gulp doc",
-    "build-test": "gulp build-test",
-    "bench": "gulp bench",
-    "unit": "gulp unit",
+    "build-test": "gulp build-tests",
+    "bench": "gulp run-benchmarks",
+    "unit": "gulp run-unit-tests",
     "test": "gulp test",
     "build": "gulp build",
     "release": "gulp release",
     "semantic-release": "semantic-release --dry-run --no-ci",
     "postversion": "gulp build"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^21.0.1",
-    "@rollup/plugin-node-resolve": "^13.1.3",
-    "@semantic-release/changelog": "^6.0.1",
+    "@rollup/plugin-commonjs": "^23.0.4",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^8.0.2",
-    "@semantic-release/npm": "^9.0.0",
+    "@semantic-release/github": "^8.0.7",
+    "@semantic-release/npm": "^9.0.1",
     "@semantic-release/release-notes-generator": "^10.0.3",
-    "ansi-colors": "^4.1.1",
+    "ansi-colors": "^4.1.3",
     "benchmark": "^2.1.4",
-    "chai": "^4.3.6",
+    "chai": "^4.3.7",
     "cz-conventional-changelog": "^3.3.0",
-    "del": "^6.0.0",
-    "eslint-plugin-mocha": "^10.0.3",
+    "del": "^7.0.0",
+    "eslint-plugin-mocha": "^10.1.0",
     "fancy-log": "^2.0.0",
+    "glob": "^8.0.3",
     "gulp": "^4.0.2",
     "gulp-eslint": "^6.0.0",
     "gulp-jsdoc3": "^3.0.0",
     "gulp-replace": "^1.1.3",
-    "karma": "^6.3.16",
+    "itee-utils": "^5.4.2",
+    "karma": "^4.4.1",
     "karma-benchmark": "^1.0.4",
     "karma-benchmarkjs-reporter": "^1.0.0",
     "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "^3.1.0",
+    "karma-chrome-launcher": "^3.1.1",
     "karma-edge-launcher": "^0.4.2",
     "karma-firefox-launcher": "^2.1.2",
     "karma-htmlfile-reporter": "^0.3.8",
     "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
-    "leveldown": "^6.1.0",
-    "minimist": "^1.2.5",
-    "mocha": "^9.2.0",
-    "mochawesome": "^7.0.1",
+    "leveldown": "^6.1.1",
+    "minimist": "^1.2.7",
+    "mocha": "^10.1.0",
+    "mochawesome": "^7.1.3",
+    "prettier": "^2.8.1",
     "rollup": "^2.67.2",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-prettier": "^3.0.0",
     "rollup-plugin-re": "^1.0.7",
     "rollup-plugin-terser": "^7.0.2",
-    "semantic-release": "^19.0.2"
+    "semantic-release": "^19.0.5"
   },
-  "optionalDependencies": {},
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"

package/sources/cores/_cores.js

@@ -4,7 +4,7 @@
  *
  * @module sources/cores
  * @description This is the cores main export entry point.
- * It expose all exports of the voids, booleans, numbers, symbols, strings, arrays, typed arrays, objects and functions validators.
+ * It exposes all exports of the voids, booleans, numbers, symbols, strings, arrays, typed arrays, objects and functions validators.
  *
  */
 

package/sources/cores/numbers/_numbers.js

@@ -13,3 +13,5 @@ export * from './isMin'
 export * from './isNumber'
 export * from './isSafeInteger'
 export * from './isZero'
+
+// Todo isMultipleOf( multiple, value )

package/sources/cores/tests/isTestUnitGenerator.js

@@ -0,0 +1,118 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
+ */
+
+/**
+ * This is noParamNoReturn
+ */
+function noParamNoReturn () {
+    // eslint-disable-next-line no-console
+    console.log( 'Hello' )
+}
+
+/**
+ *
+ * @returns {number} The response to life
+ */
+function noParamOneReturn () {
+    return 42
+}
+
+/**
+ *
+ * @returns {string|number}
+ */
+function noParamTwoReturn () {
+    return ( Math.random() >= 0.5 ) ? 'The response to life is' : 42
+}
+
+/**
+ *
+ * @param {string} paramA
+ */
+function oneParamNoReturn ( paramA = '' ) {
+    // eslint-disable-next-line no-console
+    console.log( paramA )
+}
+
+/**
+ *
+ * @param {number} theParam What add to the response of life
+ * @returns {boolean} Your response to life is correct
+ */
+function oneParamOneReturn ( theParam = 0 ) {
+    return ( 42 === theParam )
+}
+
+/**
+ *
+ * @param {number} paramA
+ * @returns {null|number}
+ */
+function oneParamTwoReturn ( paramA = 0 ) {
+    if ( paramA === 0 ) {
+        return null
+    } else {
+        return ( 42 + paramA )
+    }
+}
+
+/**
+ *
+ * @param {string} paramA
+ * @param {number} paramB
+ */
+function twoParamNoReturn ( paramA = '', paramB = 123 ) {
+    // eslint-disable-next-line no-console
+    console.log( `${ paramA }:${ paramB }` )
+}
+
+/**
+ *
+ * @param {string} paramA
+ * @param {number} paramB
+ * @returns {string}
+ */
+function twoParamOneReturn ( paramA = '', paramB = 123 ) {
+    return `${ paramA }:${ paramB }`
+}
+
+/**
+ *
+ * @param {number} paramA
+ * @param {string} paramB
+ * @returns {string|number}
+ */
+function twoParamTwoReturn ( paramA = 0, paramB = '' ) {
+    if ( paramA === 0 ) {
+        return paramB
+    } else {
+        return ( 42 + paramA )
+    }
+}
+
+/**
+ *
+ * @param {*} any
+ * @returns {boolean}
+ */
+function anyParamOneReturn ( any ) {
+    return any != null
+}
+
+export {
+    noParamNoReturn,
+    noParamOneReturn,
+    noParamTwoReturn,
+
+    oneParamNoReturn,
+    oneParamOneReturn,
+    oneParamTwoReturn,
+
+    twoParamNoReturn,
+    twoParamOneReturn,
+    twoParamTwoReturn,
+
+    anyParamOneReturn
+}

package/sources/dom/isEventTarget.js

@@ -4,10 +4,20 @@
  *
  */
 
+/**
+ *
+ * @param data {*}
+ * @returns {boolean}
+ */
 export function isEventTarget ( data ) {
     return ( data instanceof EventTarget )
 }
 
+/**
+ *
+ * @param data {*}
+ * @returns {boolean}
+ */
 export function isNotEventTarget ( data ) {
     return !isEventTarget( data )
 }

package/sources/file-system/block-devices/isBlockDevicePath.js

@@ -19,7 +19,9 @@
  *
  */
 
-import fs from 'fs'
+import fs            from 'fs'
+import { isDefined } from '../../cores/voids/isDefined'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given path is a block device path
@@ -28,7 +30,12 @@ import fs from 'fs'
  * @returns {boolean} true if path is a block device path, false otherwise
  */
 export function isBlockDevicePath ( path ) {
-    return fs.statSync( path ).isBlockDevice()
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs.statSync( path, { throwIfNoEntry: false } )
+    return isDefined(stat) && stat.isBlockDevice()
 }
 
 /**

package/sources/file-system/character-devices/isCharacterDevicePath.js

@@ -20,6 +20,8 @@
  */
 
 import fs from 'fs'
+import { isDefined } from '../../cores/voids/isDefined'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given path is a character device path
@@ -28,7 +30,12 @@ import fs from 'fs'
  * @returns {boolean} true if path is a character device path, false otherwise
  */
 export function isCharacterDevicePath ( path ) {
-    return fs.statSync( path ).isCharacterDevice()
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs.statSync( path, { throwIfNoEntry: false } )
+    return isDefined(stat) && stat.isCharacterDevice()
 }
 
 /**

package/sources/file-system/directories/isDirectoryPath.js

@@ -20,6 +20,8 @@
  */
 
 import fs from 'fs'
+import { isDefined } from '../../cores/voids/isDefined'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given path is a directory path
@@ -28,7 +30,12 @@ import fs from 'fs'
  * @returns {boolean} true if path is a directory path, false otherwise
  */
 export function isDirectoryPath ( path ) {
-    return fs.statSync( path ).isDirectory()
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs.statSync( path, { throwIfNoEntry: false } )
+    return isDefined(stat) && stat.isDirectory()
 }
 
 /**

package/sources/file-system/directories/isEmptyDirectory.js

@@ -20,6 +20,7 @@
  */
 
 import fs from 'fs'
+import { isDirectoryPath } from './isDirectoryPath'
 
 /**
  * Check if given directory path is an empty directory
@@ -28,7 +29,7 @@ import fs from 'fs'
  * @returns {boolean} true if directory is empty, false otherwise
  */
 export function isEmptyDirectory ( directoryPath ) {
-    return ( fs.readdirSync( directoryPath ).length === 0 )
+    return isDirectoryPath(directoryPath) && ( fs.readdirSync( directoryPath ).length === 0 )
 }
 
 /**

package/sources/file-system/fifo-pipes/isFIFOPath.js

@@ -20,6 +20,8 @@
  */
 
 import fs from 'fs'
+import { isDefined } from '../../cores/voids/isDefined'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given path is a fifo path
@@ -28,7 +30,12 @@ import fs from 'fs'
  * @returns {boolean} true if path is a fifo path, false otherwise
  */
 export function isFIFOPath ( path ) {
-    return fs.statSync( path ).isFIFO()
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs.statSync( path, { throwIfNoEntry: false } )
+    return isDefined(stat) && stat.isFIFO()
 }
 
 /**

package/sources/file-system/files/isEmptyFile.js

@@ -19,7 +19,9 @@
  *
  */
 
-import fs from 'fs'
+import fs             from 'fs'
+import { isFilePath } from './isFilePath'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given file path is an empty file more or less a threshold in bytes.
@@ -29,7 +31,11 @@ import fs from 'fs'
  * @returns {boolean} true if file is empty, false otherwise
  */
 export function isEmptyFile ( filePath, threshold = 0 ) {
-    return ( fs.statSync( filePath ).size <= threshold )
+    if( isNotString(filePath) && !(filePath instanceof Buffer) && !(filePath instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    return isFilePath(filePath) && ( fs.statSync( filePath ).size <= threshold )
 }
 
 /**
@@ -40,5 +46,5 @@ export function isEmptyFile ( filePath, threshold = 0 ) {
  * @returns {boolean} true if file is not empty, false otherwise
  */
 export function isNotEmptyFile ( filePath, threshold = 0 ) {
-    return ( fs.statSync( filePath ).size > threshold )
+    return !isEmptyFile(filePath, threshold)
 }

package/sources/file-system/files/isFilePath.js

@@ -20,6 +20,8 @@
  */
 
 import fs from 'fs'
+import { isDefined } from '../../cores/voids/isDefined'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given path is a file path
@@ -28,7 +30,12 @@ import fs from 'fs'
  * @returns {boolean} true if path is a file path, false otherwise
  */
 export function isFilePath ( path ) {
-    return fs.statSync( path ).isFile()
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs.statSync( path, { throwIfNoEntry: false } )
+    return isDefined(stat) && stat.isFile()
 }
 
 /**

package/sources/file-system/sockets/isSocketPath.js

@@ -20,6 +20,8 @@
  */
 
 import fs from 'fs'
+import { isDefined } from '../../cores/voids/isDefined'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given path is a socket path
@@ -28,7 +30,12 @@ import fs from 'fs'
  * @returns {boolean} true if path is a socket path, false otherwise
  */
 export function isSocketPath ( path ) {
-    return fs.statSync( path ).isSocket()
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs.statSync( path, { throwIfNoEntry: false } )
+    return isDefined(stat) && stat.isSocket()
 }
 
 /**

package/sources/file-system/symbolic-links/isSymbolicLinkPath.js

@@ -20,6 +20,8 @@
  */
 
 import fs from 'fs'
+import { isDefined } from '../../cores/voids/isDefined'
+import {isNotString} from '../../cores/strings/isString';
 
 /**
  * Check if given path is a symbolic link path
@@ -28,7 +30,12 @@ import fs from 'fs'
  * @returns {boolean} true if path is a symbolic link path, false otherwise
  */
 export function isSymbolicLinkPath ( path ) {
-    return fs.statSync( path ).isSymbolicLink()
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs.statSync( path, { throwIfNoEntry: false } )
+    return isDefined(stat) && stat.isSymbolicLink()
 }
 
 /**

package/sources/physics/temperatures/isCelsius.js

@@ -2,7 +2,7 @@
  * @author [Tristan Valcke]{@link https://github.com/Itee}
  * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
  *
- * @module sources/physics/temperatues
+ * @module sources/physics/temperatures
  * @desc Export function to validate if a value is a Celsius temperature
  * @example
  *
@@ -21,7 +21,7 @@ import { ABSOLUTE_ZERO_CELSIUS } from './constants'
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 export function isCelsius ( data ) {
@@ -30,7 +30,7 @@ export function isCelsius ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 export function isNotCelsius ( data ) {

package/sources/physics/temperatures/isFahrenheit.js

@@ -2,7 +2,7 @@
  * @author [Tristan Valcke]{@link https://github.com/Itee}
  * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
  *
- * @module sources/physics/temperatues
+ * @module sources/physics/temperatures
  * @desc Export function to validate if a value is a Fahrenheit temperature
  * @example
  *
@@ -21,7 +21,7 @@ import { ABSOLUTE_ZERO_FAHRENHEIT } from './constants'
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 export function isFahrenheit ( data ) {
@@ -30,7 +30,7 @@ export function isFahrenheit ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 export function isNotFahrenheit ( data ) {

package/sources/physics/temperatures/isKelvin.js

@@ -2,7 +2,7 @@
  * @author [Tristan Valcke]{@link https://github.com/Itee}
  * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
  *
- * @module sources/physics/temperatues
+ * @module sources/physics/temperatures
  * @desc Export function to validate if a value is a kelvin temperature
  * @example
  *
@@ -21,7 +21,7 @@ import { ABSOLUTE_ZERO_KELVIN } from './constants'
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 export function isKelvin ( data ) {
@@ -30,7 +30,7 @@ export function isKelvin ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 export function isNotKelvin ( data ) {

package/sources/physics/temperatures/isTemperature.js

@@ -2,7 +2,7 @@
  * @author [Tristan Valcke]{@link https://github.com/Itee}
  * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
  *
- * @module sources/physics/temperatues
+ * @module sources/physics/temperatures
  * @desc Export function to validate if a value is a temperature
  * @example
  *