Merge pull request #21 from hckrnews/feature/finetune-docblocks

Finetune docblocks

Author: w3nl

.eslintrc

@@ -25,4 +25,9 @@
     "parserOptions": {
         "sourceType": "module"
     },
+    "settings": {
+        "jsdoc": {
+            "mode": "typescript"
+        }
+    },
 }

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [18.x, 19.x]
 
     steps:
     - uses: actions/checkout@v3

.nvmrc

@@ -1 +1 @@
-18.5.0
+18.13.0

jsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "rootDirs": [
+      "src"
+    ],
+    "resolveJsonModule": true
+  },
+  "exclude": [
+    "node_modules",
+    "**/node_modules/*"
+  ]
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@hckrnews/arrays",
-    "version": "3.0.3",
+    "version": "3.0.4",
     "description": "Usefull array helpers.",
     "files": [
         "src/helpers.js",

package.json

@@ -26,7 +26,7 @@ class Arr extends Array {
      * Sort a multiarray.
      *
      * @param {string} key
-     * @param {string} direction
+     * @param {string=} direction
      *
      * @return {array}
      */
@@ -39,7 +39,7 @@ class Arr extends Array {
      *
      * @param {string}  key
      * @param {string}  find
-     * @param {boolean} operator
+     * @param {boolean=} operator
      *
      * @return {array}
      */
@@ -62,7 +62,7 @@ class Arr extends Array {
      * Get the intersection of arrays.
      *
      * @param {string}  array
-     * @param {boolean} multi
+     * @param {boolean=} multi
      *
      * @return {array}
      */
@@ -74,7 +74,7 @@ class Arr extends Array {
      * Get the difference of arrays.
      *
      * @param {string}  array
-     * @param {boolean} total
+     * @param {boolean=} total
      *
      * @return {array}
      */