itee-validators 5.3.5 → 5.3.6

package/.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
       MOZ_HEADLESS: 1
     strategy:
       matrix:
-        node-version: [ 12.x, 14.x, 16.x ]
+        node-version: [ 18.x, 20.x, 22.x ]
         firefox: [ 'latest' ]
     steps:
       - name: Use Node.js ${{ matrix.node-version }}

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [5.3.6](https://github.com/Itee/itee-validators/compare/v5.3.5...v5.3.6) (2025-09-04)
+
+
+### Bug Fixes
+
+* **configs:** add missing rollup tests configs updates ([30aff13](https://github.com/Itee/itee-validators/commit/30aff13c7713a24dc342ac08d2ea8bac25b6b0fb))
+* **file-system:** add parameter check ([54211a7](https://github.com/Itee/itee-validators/commit/54211a7bf3ccfe4ea5a283502d46c69e547049d4))
+* **gulpfile:** fix compute-test-bench task ([bffeaba](https://github.com/Itee/itee-validators/commit/bffeabaa9fbd2322d0df1c8c0be8d319b0697bcf))
+* **gulpfile:** fix compute-test-unit task ([a2f36ae](https://github.com/Itee/itee-validators/commit/a2f36ae73f96e2da056b02fed63eebd5d275dc87))
+* **gulpfile:** fix test building system ([f9aeb4f](https://github.com/Itee/itee-validators/commit/f9aeb4fd667c8058cda1629e5ad1c2a31bd91a95))
+* **gulpfile:** fix wrong rollup call in compute-test-bundle-by-source-file-export task ([27afd98](https://github.com/Itee/itee-validators/commit/27afd98dc244bd1eeb3c3cc565fd2a9d178d4cf6))
+* **gulpfile:** remove help task from release pipeline ([b4bfb71](https://github.com/Itee/itee-validators/commit/b4bfb717d9a42eaed877b733d05c94770b5b24c1))
+* **gulpfile:** remove karma broken tasks due to deprecation ([c2146e9](https://github.com/Itee/itee-validators/commit/c2146e94d03754a2f4394851616c3418cd037fa1))
+* **isblockdevicepath:** avoid throw on stat sync fail ([9d4a94d](https://github.com/Itee/itee-validators/commit/9d4a94d7338fab9620f351d26269a15600fc2aa5))
+* **ischaracterdevicepath:** avoid throw on stat sync fail ([61c831f](https://github.com/Itee/itee-validators/commit/61c831f4b398fca78afaffdb4b35e76fbcc0a175))
+* **isdirectorypath:** avoid throw on stat sync fail ([0d6576c](https://github.com/Itee/itee-validators/commit/0d6576c7e0f22603ceaf227589e5760a3587464b))
+* **isemptydirectory:** avoid throw on stat sync fail ([c32ae20](https://github.com/Itee/itee-validators/commit/c32ae2068861647ab0b6192b817c92449f5477a5))
+* **isemptyfile:** avoid throw null or wrong file path ([abe5b70](https://github.com/Itee/itee-validators/commit/abe5b70269eff627164abe1a6f2d4e548f979f6e))
+* **isfifopath:** avoid throw on stat sync fail ([ddc8d2f](https://github.com/Itee/itee-validators/commit/ddc8d2fe1aca46c6373f2f5c4c3998f8fa25463c))
+* **isfilepath:** avoid throw on stat sync fail ([24d2e4f](https://github.com/Itee/itee-validators/commit/24d2e4f231c2c863976b3961ebc331d4ea951c37))
+* **issocketpath:** avoid throw on stat sync fail ([211aa80](https://github.com/Itee/itee-validators/commit/211aa80afb813d9ab93ab6fdf06271202a2d7ae2))
+* **issymboliclinkpath:** add parameter check ([66c7ec0](https://github.com/Itee/itee-validators/commit/66c7ec0b1dbd443bd29ad54acad9a9bc5e543d0d))
+* **issymboliclinkpath:** avoid throw on stat sync fail ([a0e1e17](https://github.com/Itee/itee-validators/commit/a0e1e17e4384648422c75fd193240665e3fd4df9))
+* **istestunitgenerator:** fix eslint error for test purpose ([0e99747](https://github.com/Itee/itee-validators/commit/0e9974778b071a3b2af2d7e8a97d68a4b16eb094))
+* **npmignore:** fix file name ([86579d1](https://github.com/Itee/itee-validators/commit/86579d183b182d4a840c3a71ddd5b4945058afcc))
+* **units:** fix some source file methode parameters types to fix unit test generation ([0fa0951](https://github.com/Itee/itee-validators/commit/0fa09510c990e266d30af807a2fff5218147ce48))
+
 ## [5.3.5](https://github.com/Itee/itee-validators/compare/v5.3.4...v5.3.5) (2022-02-14)
 
 

package/builds/itee-validators.cjs.js

@@ -1,4 +1,4 @@
-console.log('Itee.Validators v5.3.5 - CommonJs')
+console.log('Itee.Validators v5.3.6 - CommonJs')
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -2295,7 +2295,7 @@ const ABSOLUTE_ZERO_FAHRENHEIT = -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
  *
@@ -2311,7 +2311,7 @@ const ABSOLUTE_ZERO_FAHRENHEIT = -459.67;
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 function isCelsius ( data ) {
@@ -2320,7 +2320,7 @@ function isCelsius ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 function isNotCelsius ( data ) {
@@ -2331,7 +2331,7 @@ function isNotCelsius ( data ) {
  * @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
  *
@@ -2347,7 +2347,7 @@ function isNotCelsius ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 function isFahrenheit ( data ) {
@@ -2356,7 +2356,7 @@ function isFahrenheit ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 function isNotFahrenheit ( data ) {
@@ -2367,7 +2367,7 @@ function isNotFahrenheit ( data ) {
  * @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
  *
@@ -2383,7 +2383,7 @@ function isNotFahrenheit ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 function isKelvin ( data ) {
@@ -2392,7 +2392,7 @@ function isKelvin ( data ) {
 
 /**
  *
- * @param data
+ * @param data {*}
  * @return {boolean}
  */
 function isNotKelvin ( data ) {
@@ -2403,7 +2403,7 @@ function isNotKelvin ( data ) {
  * @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
  *
@@ -2463,7 +2463,12 @@ function isNotTemperature ( data ) {
  * @returns {boolean} true if path is a block device path, false otherwise
  */
 function isBlockDevicePath ( path ) {
-    return fs__default["default"].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__default["default"].statSync( path, { throwIfNoEntry: false } );
+    return isDefined(stat) && stat.isBlockDevice()
 }
 
 /**
@@ -2583,7 +2588,12 @@ function isInvalidBlockDevicePath ( data ) {
  * @returns {boolean} true if path is a character device path, false otherwise
  */
 function isCharacterDevicePath ( path ) {
-    return fs__default["default"].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__default["default"].statSync( path, { throwIfNoEntry: false } );
+    return isDefined(stat) && stat.isCharacterDevice()
 }
 
 /**
@@ -2662,7 +2672,12 @@ function isInvalidCharacterDevicePath ( data ) {
  * @returns {boolean} true if path is a directory path, false otherwise
  */
 function isDirectoryPath ( path ) {
-    return fs__default["default"].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__default["default"].statSync( path, { throwIfNoEntry: false } );
+    return isDefined(stat) && stat.isDirectory()
 }
 
 /**
@@ -2703,7 +2718,7 @@ function isNotDirectoryPath ( path ) {
  * @returns {boolean} true if directory is empty, false otherwise
  */
 function isEmptyDirectory ( directoryPath ) {
-    return ( fs__default["default"].readdirSync( directoryPath ).length === 0 )
+    return isDirectoryPath(directoryPath) && ( fs__default["default"].readdirSync( directoryPath ).length === 0 )
 }
 
 /**
@@ -2782,7 +2797,12 @@ function isInvalidDirectoryPath ( data ) {
  * @returns {boolean} true if path is a fifo path, false otherwise
  */
 function isFIFOPath ( path ) {
-    return fs__default["default"].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__default["default"].statSync( path, { throwIfNoEntry: false } );
+    return isDefined(stat) && stat.isFIFO()
 }
 
 /**
@@ -2840,16 +2860,16 @@ function isInvalidFIFOPath ( data ) {
  * @author [Tristan Valcke]{@link https://github.com/Itee}
  * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
  *
- * @module sources/file-system/files/isEmptyFile
- * @description Export function to validate if a value is an empty file
+ * @module sources/file-system/files/isFilePath
+ * @description Export function to validate if a value is a file path
  *
  * @requires {@link module: [fs]{@link https://nodejs.org/api/fs.html}}
  *
  * @example
  *
- * import { isEmptyFile } from 'itee-validators'
+ * import { isFilePath } from 'itee-validators'
  *
- * if( isEmptyFile( value ) ) {
+ * if( isFilePath( value ) ) {
  *     //...
  * } else {
  *     //...
@@ -2858,41 +2878,44 @@ function isInvalidFIFOPath ( data ) {
  */
 
 /**
- * Check if given file path is an empty file more or less a threshold in bytes.
+ * Check if given path is a file path
  *
- * @param filePath {string|Buffer|URL} The directory path to check the emptiness
- * @param threshold {number} An amount of byte below which it consider the file as empty ( 0 as default ).
- * @returns {boolean} true if file is empty, false otherwise
+ * @param path {string|Buffer|URL} The data to check against the file path type
+ * @returns {boolean} true if path is a file path, false otherwise
  */
-function isEmptyFile ( filePath, threshold = 0 ) {
-    return ( fs__default["default"].statSync( filePath ).size <= threshold )
+function isFilePath ( path ) {
+    if( isNotString(path) && !(path instanceof Buffer) && !(path instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    const stat = fs__default["default"].statSync( path, { throwIfNoEntry: false } );
+    return isDefined(stat) && stat.isFile()
 }
 
 /**
- * Check if given file path is not an empty file more or less a threshold in bytes.
+ * Check if given path is not a file path
  *
- * @param filePath {string|Buffer|URL} The directory path to check the emptiness
- * @param threshold {number} An amount of byte above which it consider the file as not empty ( 0 as default ).
- * @returns {boolean} true if file is not empty, false otherwise
+ * @param path {string|Buffer|URL} The data to check against the file path type
+ * @returns {boolean} true if path is not a file path, false otherwise
  */
-function isNotEmptyFile ( filePath, threshold = 0 ) {
-    return ( fs__default["default"].statSync( filePath ).size > threshold )
+function isNotFilePath ( path ) {
+    return !isFilePath( path )
 }
 
 /**
  * @author [Tristan Valcke]{@link https://github.com/Itee}
  * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
  *
- * @module sources/file-system/files/isFilePath
- * @description Export function to validate if a value is a file path
+ * @module sources/file-system/files/isEmptyFile
+ * @description Export function to validate if a value is an empty file
  *
  * @requires {@link module: [fs]{@link https://nodejs.org/api/fs.html}}
  *
  * @example
  *
- * import { isFilePath } from 'itee-validators'
+ * import { isEmptyFile } from 'itee-validators'
  *
- * if( isFilePath( value ) ) {
+ * if( isEmptyFile( value ) ) {
  *     //...
  * } else {
  *     //...
@@ -2901,23 +2924,29 @@ function isNotEmptyFile ( filePath, threshold = 0 ) {
  */
 
 /**
- * Check if given path is a file path
+ * Check if given file path is an empty file more or less a threshold in bytes.
  *
- * @param path {string|Buffer|URL} The data to check against the file path type
- * @returns {boolean} true if path is a file path, false otherwise
+ * @param filePath {string|Buffer|URL} The directory path to check the emptiness
+ * @param threshold {number} An amount of byte below which it consider the file as empty ( 0 as default ).
+ * @returns {boolean} true if file is empty, false otherwise
  */
-function isFilePath ( path ) {
-    return fs__default["default"].statSync( path ).isFile()
+function isEmptyFile ( filePath, threshold = 0 ) {
+    if( isNotString(filePath) && !(filePath instanceof Buffer) && !(filePath instanceof URL) ) {
+        throw new TypeError('Invalid path type! Expect string, buffer or url.')
+    }
+
+    return isFilePath(filePath) && ( fs__default["default"].statSync( filePath ).size <= threshold )
 }
 
 /**
- * Check if given path is not a file path
+ * Check if given file path is not an empty file more or less a threshold in bytes.
  *
- * @param path {string|Buffer|URL} The data to check against the file path type
- * @returns {boolean} true if path is not a file path, false otherwise
+ * @param filePath {string|Buffer|URL} The directory path to check the emptiness
+ * @param threshold {number} An amount of byte above which it consider the file as not empty ( 0 as default ).
+ * @returns {boolean} true if file is not empty, false otherwise
  */
-function isNotFilePath ( path ) {
-    return !isFilePath( path )
+function isNotEmptyFile ( filePath, threshold = 0 ) {
+    return !isEmptyFile(filePath, threshold)
 }
 
 /**
@@ -2986,7 +3015,12 @@ function isInvalidFilePath ( data ) {
  * @returns {boolean} true if path is a socket path, false otherwise
  */
 function isSocketPath ( path ) {
-    return fs__default["default"].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__default["default"].statSync( path, { throwIfNoEntry: false } );
+    return isDefined(stat) && stat.isSocket()
 }
 
 /**
@@ -3065,7 +3099,12 @@ function isInvalidSocketPath ( data ) {
  * @returns {boolean} true if path is a symbolic link path, false otherwise
  */
 function isSymbolicLinkPath ( path ) {
-    return fs__default["default"].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__default["default"].statSync( path, { throwIfNoEntry: false } );
+    return isDefined(stat) && stat.isSymbolicLink()
 }
 
 /**