@vanillaes/absurdum 2.0.5 → 2.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/absurdum",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "Absurdum - The Ridiculous Application of Reduce",
   "keywords": [
     "esm",
@@ -27,21 +27,28 @@
   "exports": {
     ".": {
       "import": "./index.js",
+      "types": "./index.d.ts",
       "browser": "./index.min.js"
     },
     "./arrays": {
-      "import": "./src/arrays/index.js"
+      "import": "./src/arrays/index.js",
+      "types": "./src/arrays/index.d.ts",
+      "browser": "./src/arrays/index.min.js"
     },
     "./objects": {
-      "import": "./src/objects/index.js"
+      "import": "./src/objects/index.js",
+      "types": "./src/objects/index.d.ts",
+      "browser": "./src/objects/index.min.js"
     },
     "./strings": {
-      "import": "./src/strings/index.js"
+      "import": "./src/strings/index.js",
+      "types": "./src/strings/index.d.ts",
+      "browser": "./src/strings/index.min.js"
     }
   },
-  "types": "index.d.ts",
   "scripts": {
     "test": "esmtk test",
+    "lint": "esmtk lint",
     "type": "esmtk type index.js",
     "build": "npm run build:min && npm run build:docs && npm run build:typings",
     "build:docs": "node .config/docs.config.js",
@@ -52,19 +59,13 @@
     "clean:min": "esmtk clean --minify",
     "clean:typings": "esmtk clean --typings",
     "preview": "esmtk preview",
-    "preversion": "npm test && npm run type",
+    "preversion": "npm test && npm run lint && npm run type",
     "postversion": "git push --follow-tags"
   },
   "devDependencies": {
     "docdown": "github:evanplaice/docdown",
     "glob": "^7.2.0"
   },
-  "standard": {
-    "ignore": [
-      "index.js",
-      "docs.config.js"
-    ]
-  },
   "dependencies": {
     "@vanillaes/esmtk": "^1.2.3"
   }

package/src/arrays/chunk.js

@@ -1,10 +1,8 @@
 /**
  * Splits the input array up into an subset arrays of equal size
- *
  * @param {Array} array input array
- * @param {number} [size=1] size of each chunk
+ * @param {number} [size] size of each chunk (default 1)
  * @returns {Array} array of chunk arrays
- *
  * @example
  * const result = arrays.chunk([1, 2, 3, 4, 5], 2);
  * console.log(result);

package/src/arrays/compact.js

@@ -1,9 +1,7 @@
 /**
  * Compact removes all falsy values `[false, null, 0, "", undefined, NaN]` from an array.
- *
  * @param {Array} array input array
  * @returns {Array} the input array w/ no falsy values
- *
  * @example
  * const result = arrays.compact([1, false, 2, null, 3, 0, 4, "", 5, undefined, 6, NaN]);
  * console.log(result);

package/src/arrays/difference.js

@@ -1,10 +1,8 @@
 /**
  * Finds the difference of two arrays
- *
  * @param {Array} arrayA first input array
  * @param {Array} arrayB second input array
  * @returns {Array} an array containing the difference
- *
  * @example
  * const result = arrays.difference([2, 1], [2, 3]);
  * console.log(result);

package/src/arrays/drop.js

@@ -1,10 +1,8 @@
 /**
  * Remove N items from the beginning of the input array
- *
  * @param {Array} array input array
- * @param {number} [count=1] number of items to drop
+ * @param {number} [count] number of items to drop (default 1)
  * @returns {Array} input array sans the dropped items
- *
  * @example
  * const result = arrays.drop([1, 2, 3], 2);
  * console.log(result);

package/src/arrays/dropRight.js

@@ -1,10 +1,8 @@
 /**
  * Remove N items from the end of the input array
- *
  * @param {Array} array input array
- * @param {number} [count=1] number of items to drop
+ * @param {number} [count] number of items to drop (default 1)
  * @returns {Array} input array sans the dropped items
- *
  * @example
  * const result = arrays.drop([1, 2, 3], 2);
  * console.log(result);

package/src/arrays/fill.js

@@ -1,12 +1,12 @@
+/* eslint-disable jsdoc/reject-any-type */
+
 /**
  * Fills items in an array with a specified value. Optionally, one can start and/or end from a specific index.
- *
  * @param {Array} array input array
  * @param {*} value value that fills the array
- * @param {number} [start=0] start index
- * @param {number} [end=array.length] end index
+ * @param {number} [start] start index (default 0)
+ * @param {number} [end] end index (default array.length)
  * @returns {Array} input array filled w/ the value
- *
  * @example
  * const result = arrays.fill([1, 2, 3, 4], 'a', 1, 2);
  * console.log(result)

package/src/arrays/filter.js

@@ -1,10 +1,10 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * Iterates over an array of values and only outputs values where `predicate is equal to true`.
- *
  * @param {Array} array input array
  * @param {Function} predicate predicate function
  * @returns {Array} the input array w/ unwanted values removed
- *
  * @example
  * const result = arrays.filter([1, 2, 3, 4], (x) => x % 2 === 0);
  * console.log(result)

package/src/arrays/find.js

@@ -1,12 +1,12 @@
+/* eslint-disable jsdoc/reject-any-type,jsdoc/reject-function-type */
+
 /**
  * Find method returns the value of first element at which a provided function is true,
  * or undefined if no elements in the array satisfy the function.
- *
  * @param {Array} array input array
  * @param {Function} predicate to be run against each element of the array
  * @param {*} [thisArg] this argument in the function
  * @returns {*} value of element that satisfied function.
- *
  * @example
  * const result = arrays.find([5, 12, 8, 130, 44], (x) => x > 10);
  * console.log(result);

package/src/arrays/findIndex.js

@@ -1,12 +1,12 @@
+/* eslint-disable jsdoc/reject-any-type,jsdoc/reject-function-type */
+
 /**
  * FindIndex method returns the value of First element at which a provided function is true,
  * or -1 if no elements in the array satisfy the function.
- *
  * @param {Array} array input array
  * @param {Function} predicate to be run against each element of the array
  * @param {*} [thisArg] this argument in the function
  * @returns {*} value of element that satisfied function.
- *
  * @example
  * const result = arrays.findIndex([5, 12, 8, 130, 44], (x) => x < 10);
  * console.log(result);

package/src/arrays/findLastIndex.js

@@ -1,12 +1,12 @@
+/* eslint-disable jsdoc/reject-any-type,jsdoc/reject-function-type */
+
 /**
  * FindLastIndex method returns the value of Last element at which a provided function is true,
  * or undefined if no elements in the array satisfy the function.
- *
  * @param {Array} array input array
  * @param {Function} predicate to be run against each element of the array
  * @param {*} [thisArg] this argument in the function
  * @returns {*} value of element that satisfied function.
- *
  * @example
  * const result = arrays.findLastIndex([5, 12, 8, 130, 44], (x) => x < 10);
  * console.log(result);

package/src/arrays/flat.js

@@ -1,10 +1,8 @@
 /**
  * Flat flattens an array of nested arrays
- *
  * @param {Array} array input array
- * @param {number} [depth=1] depth of array elements to flat
+ * @param {number} [depth] depth of array elements to flat (default 1)
  * @returns {Array} the flattened array
- *
  * @example
  * const result = arrays.flat([1, [2, [3, [4]]]]);
  * console.log(result);

package/src/arrays/frequency.js

@@ -1,10 +1,8 @@
 /**
  * Frequency returns an object mapping each unique item in an array
  * to the number of items it occurs in the array.
- *
  * @param {Array} array input array
- * @returns {Object} object of uniq values and their frequency of occurrence
- *
+ * @returns {object} object of uniq values and their frequency of occurrence
  * @example
  * const result = arrays.frequency(['a', 'b', 'a', 'c', 'a', 'c', 'b']);
  * console.log(result)

package/src/arrays/intersection.js

@@ -1,9 +1,7 @@
 /**
  * Intersection creates an array of unique values that are included in all given arrays
- *
  * @param {Array} arrays input array(s)
  * @returns {Array} an array containing the unique intersecting values between all input arrays
- *
  * @example
  * const result = arrays.intersection([4, 2, 1], [2, 3, 4]));
  * console.log(result);

package/src/arrays/map.js

@@ -1,10 +1,10 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * Map iterates over an array of values and applies a function to each value
- *
  * @param {Array} array input array
  * @param {Function} func function describing how to map values
  * @returns {Array} array of mutated values
- *
  * @example
  * const result = arrays.map([1, 2, 3, 4], (x) => x + 2);
  * console.log(result)

package/src/arrays/pull.js

@@ -1,10 +1,10 @@
+/* eslint-disable jsdoc/reject-any-type */
+
 /**
  * Pull removes all of the given values from an array
- *
  * @param {Array} array input array
  * @param {...*} values values to be removed from the array
  * @returns {Array} array of with values removed
- *
  * @example
  * const result = arrays.pull([1, 2, 3, 4], 2, 4);
  * console.log(result)

package/src/arrays/take.js

@@ -1,10 +1,8 @@
 /**
  * Take method returns a slice of array with 'count' number of elements from the beginning
- *
  * @param {Array} array input array
- * @param {Number} [count=1] number of elements in the slice of the array
+ * @param {number} [count] number of elements in the slice of the array (default 1)
  * @returns {Array} the slice of the array of length 'count'
- *
  * @example
  * const result = arrays.take(['Amy', 'Brie', 'Cam', 'Dimitri']);
  * console.log(result);

package/src/arrays/takeRight.js

@@ -1,10 +1,8 @@
 /**
  * Take method returns a slice of array with 'count' number of elements from the end of the array
- *
  * @param {Array} array input array
- * @param {Number} [count=1] number of elements in the slice of the array
+ * @param {number} [count] number of elements in the slice of the array (default 1)
  * @returns {Array} the slice of the array of length 'count'
- *
  * @example
  * const result = arrays.some(['Amy', 'Brie', 'Cam', 'Dimitri']);
  * console.log(result);

package/src/arrays/union.js

@@ -1,9 +1,7 @@
 /**
  * Union creates an array of unique elements from all given arrays in order encountered
- *
  * @param {Array} arrays input arrays
  * @returns {Array} an array of unique elements from all given arrays
- *
  * @example
  * const result = arrays.union([2], [1, 2, 3, 1]);
  * > [2, 1, 3]

package/src/arrays/unique.js

@@ -1,9 +1,7 @@
 /**
  * Removes all duplicate items of an array
- *
  * @param {Array} array input array
  * @returns {Array} an array of unique values
- *
  * @example
  * const result = arrays.unique([2, 1, 2]);
  * console.log(result);

package/src/arrays/unzip.js

@@ -1,9 +1,7 @@
 /**
  * Performs a manipulation to undo the zip command
- *
  * @param {Array} array input array
  * @returns {Array} an array of unique values
- *
  * @example
  * const result = arrays.unzip([['a', 'b', 'c'], [1, 2, 3], [true, false, true]]);
  * console.log(result);

package/src/arrays/without.js

@@ -1,6 +1,7 @@
+/* eslint-disable jsdoc/reject-any-type */
+
 /**
  * Without, returns an array with all values parameters removed from the input array
- *
  * @param {Array} array input array
  * @param {...*} values input values
  * @returns {Array} an array of unique values

package/src/arrays/xor.js

@@ -1,9 +1,7 @@
 /**
  * Creates an array of unique values that is the symmetric difference of the given arrays
- *
  * @param {...Array} arrays input arrays
  * @returns {Array} an array of unique values
- *
  * @example
  * const result = arrays.xor(['a', 1, [5]], ['b', 1, 'a'], ['b', 'c', 5]);
  * console.log(result);

package/src/arrays/zip.js

@@ -1,12 +1,12 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * Zip applies a specified function to the corresponding elements of two sequences,
  * producing a sequence of the results.
- *
  * @param {Array} arrayA input array
  * @param {Array} ArrayB input array
- * @param {Function} [func=(a, b)=>[a, b]] to be applied to corresponding values
+ * @param {Function} [func] to be applied to corresponding values (default (a, b)=>[a, b])
  * @returns {Array} input array filled value pairs after the function has been applied
- *
  * @example
  * const result = zip([5, 12, 8, 130, 44], ["ham", "cheese", "bread"]);
  * console.log(result)

package/src/objects/assign.js

@@ -1,11 +1,9 @@
 /**
  * Assign merges object properties from all supplied objects. If a property
  * already exists, then it is overwritten when merged from left to right.
- *
  * @param {object} object input object
  * @param {...object} sources input source object(s)
  * @returns {object} returns new object
- *
  * @example
  * const someObj = { hold: 44, fast: 14 };
  * const result = objects.assign(someObj, { hold: 25, your: 19, horses: 4 });

package/src/objects/at.js

@@ -1,10 +1,8 @@
 /**
  * At, creates an array of values corresponding to paths of the object
- *
  * @param {object} object input object
  * @param {...(string|string[])} paths strings describing paths to be returned from an object
- * @returns {array} array of values found by object paths in object
- *
+ * @returns {Array} array of values found by object paths in object
  * @example
  * const result = objects.at({ a: [13, 64], ']': 'b' });
  * console.log(result, 'a[1]');

package/src/objects/defaults.js

@@ -1,11 +1,9 @@
 /**
  * Defaults recursively merges object properties from all supplied objects. If a property
  * already exists, then the existing one is kept when merged from left to right.
- *
  * @param {object} object input object
  * @param {...object} sources input source object(s)
  * @returns {object} returns new object
- *
  * @example
  * const someObj = { hold: 44 };
  * const result = objects.defaults(someObj, { hold: 25, your: 19, horses: 4 });

package/src/objects/defaultsDeep.js

@@ -1,11 +1,9 @@
 /**
  * DefaultsDeep recursively merges object properties from all supplied objects with object values
  * being merged recursively and once a property is set, additional values of the same property are ignored.
- *
  * @param {object} object input object
  * @param {...object} sources input source object(s)
  * @returns {object} returns an object with all included object properties merged
- *
  * @example
  * const result = objects.defaultsDeep({ a: { b: [3, 4] } }, { a: { b: [9, 18, 15], c: 3 } });
  * console.log(result);

package/src/objects/entries.js

@@ -1,9 +1,7 @@
 /**
  * Entries takes an object and returns an array composed from key-value pairs.
- *
  * @param {object} object input object
  * @returns {Array} an array composed from arrays of the key-value pairs
- *
  * @example
  * const result = objects.entries({ asuka: 643, heian: 795, meiji: 1868 });
  * console.log(result);

package/src/objects/filter.js

@@ -1,12 +1,12 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * Filter iterates over an object and applies a predicate to each property, for all properties
  * where the predicate is true, return that property in a new object. Function is invoked
  * with 3 arguments (value, key, object)
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} predicate predicate function to check what properties to include
- * @returns {Object} object with selected properties
- *
+ * @returns {object} object with selected properties
  * @example
  * const obj = { small: "ant", medium: "dog", big: "elephant" }
  * const result = objects.filter(obj, (value, key, object) => ['small', 'big'].includes(key)));

package/src/objects/findKey.js

@@ -1,11 +1,11 @@
+/* eslint-disable jsdoc/reject-any-type,jsdoc/reject-function-type */
+
 /**
  * FindKey returns the key of the first property value for which a supplied function returns true
- *
  * @param {object} object input object
- * @param {function} [predicate=(x)=>x] function to test against object values
+ * @param {Function} [predicate] function to test against object values (default x=>x)
  * @param {*} [thisArg] value of this in a function call
  * @returns {string} string of the first object key whose value returns truthy against the function
- *
  * @example
  * const result = Objects.findKey({ apple: 34, pear: 434, orange: 4 }, x => x > 100 );
  * console.log(result);

package/src/objects/findLastKey.js

@@ -1,11 +1,11 @@
+/* eslint-disable jsdoc/reject-any-type,jsdoc/reject-function-type */
+
 /**
  * FindLastKey returns the key of the last property value for which a supplied function returns true
- *
  * @param {object} object input object
- * @param {function} [predicate=(x)=>x] function to test against object values
+ * @param {Function} [predicate] function to test against object values (default x=>x)
  * @param {*} [thisArg] value of this in a function call
  * @returns {string} string of the first object key whose value returns truthy against the function
- *
  * @example
  * const result = Objects.findLastKey({ apple: 34, pear: 434, orange: 4, grapefruit: 212 }, x => x > 100 );
  * console.log(result);

package/src/objects/forIn.js

@@ -1,11 +1,11 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * forIn iterates over own and inherited enumerable string keyed properties of an object and invokes
  * iteratee for each property. The iteratee is invoked with three arguments: (value, key, object)
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} func function invoked per iteration
- * @returns {Object} original object
- *
+ * @returns {object} original object
  * @example
  * const Obj_A = function () {
  *   this.a = 5;

package/src/objects/fromEntries.js

@@ -1,10 +1,8 @@
 /**
  * FromEntries takes an array of arrays with key-value pairs and returns an
  * object composed from key-value pairs.
- *
  * @param {Array} array input key-value pairs in an array of arrays
  * @returns {object} an object composed from the key-value pairs
- *
  * @example
  * const result = objects.fromEntries([['age', 12034], ['name', 'Trair'],['state', 'Floating']]);
  * console.log(result);

package/src/objects/get.js

@@ -1,16 +1,15 @@
+/* eslint-disable jsdoc/reject-any-type */
+
 /**
  * Get, creates an array of values corresponding to paths of the object
- *
  * @param {object} object input object
  * @param {Array|string} path string or an array of strings describing paths to be returned from an object
  * @param {*} [defaultValue] value returned when path resolves undefined
  * @returns {*} value found by object paths in object, or returns defaultValue if provided and return would otherwise be undefined
- *
  * @example
  * const result = objects.get({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, 'back[1]');
  * > 39
- *
  * @example
  * const result = objects.get({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, ['front', 5], "no value here");

package/src/objects/has.js

@@ -1,15 +1,12 @@
 /**
  * Has, creates an array of values corresponding to paths of the object
- *
  * @param {object} object input object
  * @param {Array|string} path strings describing paths to be returned from an object
  * @returns {boolean} boolean true is a direct property of the object
- *
  * @example
  * const result = objects.has({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, 'back[1]');
  * > true
- *
  * @example
  * const result = objects.has({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, ['front', 1]);

package/src/objects/invert.js

@@ -1,10 +1,8 @@
 /**
  * Create a new object with key-value pairs inverted, in the case of duplicate values the latter value
  * will overwrite the previous value.
- *
  * @param {object} object input string
  * @returns {object} returns an object with key-value pairs inverted
- *
  * @example
  * const result = Objects.invert({ a: 1, b: 2, c: 1 });
  * console.log(result);

package/src/objects/mapKeys.js

@@ -1,10 +1,10 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * MapKeys iterates over an object of values and applies a function to each key
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} func map function
- * @returns {Object} object with mutated keys
- *
+ * @returns {object} object with mutated keys
  * @example
  * const result = objects.mapKeys({ a: 1, b: 2, c: 3 }, value => `neat_${value}`);
  * console.log(result);

package/src/objects/mapValues.js

@@ -1,10 +1,10 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * MapKeys iterates over an object and applies a function to each value
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} func map function
- * @returns {Object} object with mutated values
- *
+ * @returns {object} object with mutated values
  * @example
  * const result = objects.mapValues({ a: 1, b: 2, c: 3 }, value => `neat_${value}`);
  * console.log(result);

package/src/objects/merge.js

@@ -1,11 +1,9 @@
 /**
  * Merge recursively merges object properties from all supplied objects with object values
  * being merged recursively and other value types overridden when applied from left to right.
- *
  * @param {object} object input object
  * @param {...object} sources input object(s)
  * @returns {object} returns an object with all included object properties merged
- *
  * @example
  * const result = objects.merge({ hold: 25, your: 19 }, { a: 1, b: 2 });
  * console.log(result);

package/src/objects/pick.js

@@ -1,10 +1,8 @@
 /**
  * Pick returns a new object composed from the selected object properties.
- *
  * @param {object} object input object
  * @param {...(string|string[])} paths paths names of properties to be returned from an object
  * @returns {object} object with selected properties
- *
  * @example
  * const result = Objects.pick({ a: 'mixed', b34: 'toast', 45: 'pasta' }, 'a', 45);
  * console.log(result);

package/src/objects/result.js

@@ -1,16 +1,15 @@
+/* eslint-disable jsdoc/reject-any-type */
+
 /**
  * Result, creates an array of values corresponding to paths of the object. If value is a function, returns result of calling function
- *
  * @param {object} object input object
  * @param {Array|string} path string or an array of strings describing paths to be returned from an object
  * @param {*} [defaultValue] value returned when path resolves undefined
  * @returns {*} value found by object paths in object, or returns defaultValue if provided and return would otherwise be undefined
- *
  * @example
  * const obj = { front: [1, 3, 5], back: [() => 15, () => 19] };
  * console.log(objects.result(obj, 'back[1]'));
  * > 19
- *
  * @example
  * const obj = { front: [1, 3, 5], back: [37, 39] };
  * const func = (x) => { return x+7; }

package/src/objects/transform.js

@@ -1,11 +1,11 @@
+/* eslint-disable jsdoc/reject-function-type */
+
 /**
  * Transform works like reduce, except the accumulator is implicitly returned
- *
  * @param {object} object input object
- * @param {function} func iteratee function
- * @param {object|Array} [accumulator={}] custom accumulator object
+ * @param {Function} func iteratee function
+ * @param {object|Array} [accumulator] custom accumulator object (default {})
  * @returns {object|Array} returns accumulator object after the input object has been iterated over by the function.
- *
  * @example
  * const result = objects.transform({ harmony: 2, daft: 4, stripes: 6 }, function(acc, val, key) {
  *   acc[key] = val + 5 + '_' + idx;

package/src/objects/values.js

@@ -1,9 +1,7 @@
 /**
  * Values is an alias for Object.values returns an array of all values in an object
- *
  * @param {object} object input object
- * @returns {array} returns an array of all values in an object
- *
+ * @returns {Array} returns an array of all values in an object
  * @example
  * const result = objects.values({ hold: 25, your: 19, horses: 4 });
  * console.log(result);

package/src/strings/camelCase.js

@@ -1,9 +1,7 @@
 /**
  * camelCase updates a string to camelcase
- *
  * @param {string} [string] input string
  * @returns {string} returns new camelCase string
- *
  * @example
  * const result = strings.camelCase('--BEST_friend--');
  * console.log(result);

package/src/strings/chomp.js

@@ -1,15 +1,12 @@
 /**
  * Chomp removes record separator characters (ex \n, \r, \r\n) from the end of a string.
- *
  * @param {string} string input string
- * @param {string} [separator='\r'||'\n'||'\r\n'] separator removed from end of string
+ * @param {string} [separator] separator removed from end of string (default '\r' | '\n' | '\r\n')
  * @returns {string} does the input end with the substring?
- *
  * @example
  * const result = strings.chomp('Goldy\n\r\n');
  * console.log(result);
  * > 'Goldy\n'
- *
  * @example
  * const result = strings.chomp('Sauce', 'ce');
  * console.log(result);

package/src/strings/deburr.js

@@ -1,9 +1,7 @@
 /**
  * Deburrs string by converting all complex Latin characters to basic Latin letters in a string.
- *
  * @param {string} [string] input string
  * @returns {string} returns simplified string
- *
  * @example
  * const result = strings.deburr('_ŁŐúnged\ufe2f_');
  * console.log(result);

package/src/strings/endsWith.js

@@ -1,15 +1,12 @@
 /**
  * Tests a string to see if it ends with a substring
- *
  * @param {string} string input string
- * @param {string} [substr=''] substring to test
+ * @param {string} [substr] substring to test (default '')
  * @returns {boolean} does the input end with the substring?
- *
  * @example
  * const result = strings.endsWith('This sentence ends with', 'with');
  * console.log(result);
  * > true
- *
  * @example
  * const result = strings.endsWith('This sentence does not end with', 'nope');
  * console.log(result);

package/src/strings/includes.js

@@ -1,11 +1,9 @@
 /**
  * Includes determines whether one string can be found in another string
- *
  * @param {string} string input string
  * @param {string} substr candidate string to be searched for
- * @param {Number} start index to begin search for string
+ * @param {number} start index to begin search for string
  * @returns {boolean} does the input string include the substring?
- *
  * @example
  * const result = strings.includes('This Lovely Life', 'Love');
  * console.log(result);

package/src/strings/kebabCase.js

@@ -1,9 +1,7 @@
 /**
  * kebabCase updates a string to kebabcase
- *
  * @param {string} [string] input string
  * @returns {string} returns new kebabCase string
- *
  * @example
  * const result = strings.kebabCase('css classes use kebab case');
  * console.log(result);

package/src/strings/pad.js

@@ -1,23 +1,19 @@
 /**
  * Pads the both ends of a string w/ repeated spaces|substrings
- *
  * @param {string} string input string
- * @param {number} [length=0] length of the padded portion
- * @param {string} [substr=' '] substring to apply
+ * @param {number} [length] length of the padded portion (default 0)
+ * @param {string} [substr] substring to apply (default ' ')
  * @returns {string} the input padded w/ spaces|substrings
- *
  * @example
  * // if no `substr` is provided, it pads the string w/ spaces
  * const result = strings.pad('xyzxyz', 9);
  * console.log(result);
  * > ' xyzxyz  '
- *
  * @example
  * // if `length` is shorter than `string` it doesn't add any padding
  * const result = strings.pad('xyzxyz', 4);
  * console.log(result);
  * > 'xyzxyz'
- *
  * @example
  * // if `substr` is defined, it uses that for padding
  *  const result = strings.pad('xyzxyz', 16, 'FUN');

package/src/strings/padEnd.js

@@ -1,23 +1,19 @@
 /**
  * Pads the end of a string w/ repeated spaces|substrings
- *
  * @param {string} string input string
- * @param {number} [length=0] length of the padded portion
- * @param {string} [substr=' '] substring to apply
+ * @param {number} [length] length of the padded portion (default 0)
+ * @param {string} [substr] substring to apply (default ' ')
  * @returns {string} the input padded w/ spaces|substrings
- *
  * @example
  * // if no `substr` is provided, it pads the string w/ spaces
  * const result = strings.padEnd('abcabc', 9);
  * console.log(result);
  * > abcabc
- *
  * @example
  * // if `length` is shorter than `string` it doesn't add any padding
  * const result = strings.padEnd('abcabc', 4);
  * console.log(result);
  * > abcabc
- *
  * @example
  * // if `substr` is defined, it uses that for padding
  *  const result = strings.padEnd('abcabc', 16, 'fun');

package/src/strings/padStart.js

@@ -1,23 +1,19 @@
 /**
  * PadStart pads the start of of a string.
- *
  * @param {string} string input string
- * @param {number} [length=0] length of the padded portion
- * @param {string} [substr=' '] substring to apply
+ * @param {number} [length] length of the padded portion (default 0)
+ * @param {string} [substr] substring to apply (default ' ')
  * @returns {string} the input padded w/ spaces|substrings
- *
  * @example
  * // if no `substr` is provided, it pads the string w/ spaces
  * const result = strings.padStart('abcabc', 9);
  * console.log(result);
  * >    abcabc
- *
  * @example
  * // if `length` is shorter than `string` it doesn't add any padding
  *  const result = strings.padStart('abcabc', 4);
  *  console.log(result);
  *  > abcabc
- *
  * @example
  * // if `substr` is defined, it uses that for padding
  * const result = strings.padStart('abcabc', 16, 'fun');

package/src/strings/pascalCase.js

@@ -1,9 +1,7 @@
 /**
  * pascalCase updates a string to pascalCase
- *
  * @param {string} [string] input string
  * @returns {string} returns new pascalCase string
- *
  * @example
  * const result = strings.pascalCase('classes use pascal case');
  * console.log(result);

package/src/strings/repeat.js

@@ -1,11 +1,9 @@
 /**
  * Repeat returns a new string containing the provided string copied and concatenated
  * for the number of times given in the parameter
- *
  * @param {string} string input string
- * @param {Number} count number of times to repeat the string
+ * @param {number} count number of times to repeat the string
  * @returns {string} string containing the specified number of copies of the given string
- *
  * @example
  * const result = strings.repeat('Moo', 3);
  * console.log(result);

package/src/strings/reverse.js

@@ -1,9 +1,7 @@
 /**
  * Reversed the characters in a string
- *
  * @param {string} string input string
  * @returns {string} input string reversed
- *
  * @example
  * const result = strings.reverse('This string will be reversed');
  * console.log(result);

package/src/strings/snakeCase.js

@@ -1,9 +1,7 @@
 /**
  * snakeCase updates a string to snakecase
- *
  * @param {string} [string] input string
  * @returns {string} returns new snakeCase string
- *
  * @example
  * const result = strings.snakeCase('--BEST--friend--');
  * console.log(result);

package/src/strings/startsWith.js

@@ -1,15 +1,12 @@
 /**
  * StartsWith tests a string to see if it starts with a substring
- *
  * @param {string} string input string
  * @param {string} substr substring to test
  * @returns {boolean} does the input start with the substring?
- *
  * @example
  * const result = strings.startsWith('This sentence starts with', 'This');
  * console.log(result);
  * > true
- *
  * @example
  * const result = strings.startsWith('This sentence does not start with', 'Nope');
  * console.log(result);

package/src/strings/trimEnd.js

@@ -1,10 +1,8 @@
 /**
  * TrimEnd trims any whitespace or the selected characters from the end of the string
- *
  * @param {string} [string] input string
- * @param {string} [chars=' '] characters to remove from end of the string
+ * @param {string} [chars] characters to remove from end of the string (default ' ')
  * @returns {string} string with the characters removed from end of the string
- *
  * @example
  * const result = strings.trimEnd('-_-abc-_-', '_-');
  * console.log(result);

package/src/strings/trimStart.js

@@ -1,10 +1,8 @@
 /**
  * TrimStart trims any whitespace or the selected characters from the beginning of the string
- *
  * @param {string} [string] input string
- * @param {string} [chars=' '] characters to remove from beginning of string
+ * @param {string} [chars] characters to remove from beginning of string (default ' ')
  * @returns {string} string with the characters removed from beginning
- *
  * @example
  * const result = strings.trimStart('-_-abc-_-', '_-');
  * console.log(result);

package/src/strings/truncate.js

@@ -1,27 +1,25 @@
 /**
  * Truncates string if it's longer than the given maximum string length. The last characters
  * of the truncated string are replaced with the omission string which defaults to "...".
- *
  * @param {string} [string] string to truncate
- * @param {Object} [options={}] object containing options
- * @param {number} [options.length=30] Max length of truncated string
- * @param {string} [options.omission='...'] string to indicate omitted text
+ * @param {object} [options] object containing options (default {})
+ * @param {number} [options.length] Max length of truncated string (default 30)
+ * @param {string} [options.omission] string to indicate omitted text (default '...')
  * @param {RegExp|string} [options.separator] the pattern to end truncation
  * @returns {string} returns truncated string
- *
  * @example
  * const result = strings.truncate('This sentence starts with', 'This');
  * console.log(result);
  * > true
- **/
-function truncate (string, options) {
+ */
+function truncate (string, options = {}) {
   let length = 30
   let omission = '...'
   let separator
   if (options) {
-    if (options.length !== undefined) { length = options.length }
-    if (options.omission !== undefined) { omission = options.omission }
-    if (options.separator !== undefined) { separator = options.separator }
+    if (options?.length !== undefined) { length = options.length }
+    if (options?.omission !== undefined) { omission = options.omission }
+    if (options?.separator !== undefined) { separator = options.separator }
   }
 
   if (length >= string.length) { return string }

package/src/strings/words.js

@@ -1,20 +1,18 @@
+/* eslint-disable no-misleading-character-class */
+
 /**
  * Splits `string` into an array of its words.
- *
  * @param {string} [string] string to inspect for words
  * @param {RegExp|string} [pattern] regex pattern to match words or string of characters to split words by.
  * @returns {Array} Returns an array of words
- *
  * @example
  * const result = words('I can, I should, & I will');
  * console.log(result);
  * // => ['I', 'can', 'I', 'should', 'I', 'will']
- *
  * @example
  * const result = words('I can, I should, & I will', ' ,');
  * console.log(result);
  * // => ['I', 'can', 'I', 'should', '&', 'I', 'will']
- *
  * @example
  * const result = words('I can, I should, & I will', /[^, ]+/g);
  * console.log(result);