@vanillaes/absurdum 2.0.7 → 2.0.11

package/src/objects/pick.d.ts

@@ -1,13 +1,11 @@
 /**
  * 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);
  * > { 45: 'pasta', a: 'mixed' }
  */
-export function pick(object: any, ...paths: (string | string[])[]): any;
+export function pick(object: object, ...paths: (string | string[])[]): object;

package/src/objects/pick.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this late
+
 /**
  * Pick returns a new object composed from the selected object properties.
  * @param {object} object input object
@@ -8,7 +10,7 @@
  * console.log(result);
  * > { 45: 'pasta', a: 'mixed' }
  */
-function pick (object, ...paths) {
+export function pick (object, ...paths) {
   if (paths.length === 0) { return {} }
   const args = new Set()
 
@@ -23,5 +25,3 @@ function pick (object, ...paths) {
     return acc
   }, {})
 }
-
-export { pick }

package/src/objects/result.d.ts

@@ -1,20 +1,17 @@
 /**
  * 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; }
  * console.log(objects.result(obj, ['front', 5], func(3)));
  * > 10
  */
-export function result(object: any, path: string | any[], defaultValue?: any): any;
+export function result(object: object, path: any[] | string, defaultValue?: any): any;

package/src/objects/result.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-any-type */
+// @ts-nocheck TODO: Fix types on this late
 
 /**
  * Result, creates an array of values corresponding to paths of the object. If value is a function, returns result of calling function
@@ -16,7 +17,7 @@
  * console.log(objects.result(obj, ['front', 5], func(3)));
  * > 10
  */
-function result (object, path, defaultValue) {
+export function result (object, path, defaultValue) {
   if (typeof path === 'undefined') { return undefined }
   let pathArray
 
@@ -41,5 +42,3 @@ function result (object, path, defaultValue) {
     return typeof defaultValue === 'function' ? defaultValue() : defaultValue
   }
 }
-
-export { result }

package/src/objects/transform.d.ts

@@ -1,11 +1,9 @@
 /**
  * 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;
@@ -13,4 +11,4 @@
  * console.log(result);
  * > { harmony: '7_0', daft: '9_1', stripes: '11_2' }
  */
-export function transform(object: any, func: Function, accumulator?: any): any;
+export function transform(object: object, func: Function, accumulator?: object | any[]): object | any[];

package/src/objects/transform.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-function-type */
+// @ts-nocheck TODO: Fix types on this late
 
 /**
  * Transform works like reduce, except the accumulator is implicitly returned
@@ -13,7 +14,7 @@
  * console.log(result);
  * > { harmony: '7_0', daft: '9_1', stripes: '11_2' }
  */
-function transform (object, func, accumulator = {}) {
+export function transform (object, func, accumulator = {}) {
   if (typeof func === 'undefined') { return object }
 
   return Object.keys(object).reduce((acc, key) => {
@@ -21,5 +22,3 @@ function transform (object, func, accumulator = {}) {
     return acc
   }, accumulator)
 }
-
-export { transform }

package/src/objects/values.d.ts

@@ -1,12 +1,10 @@
 /**
  * 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);
  * > [25, 19, 4]
  */
-export function values(object: any): any[];
+export function values(object: object): any[];

package/src/objects/values.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this late
+
 /**
  * Values is an alias for Object.values returns an array of all values in an object
  * @param {object} object input object
@@ -7,11 +9,9 @@
  * console.log(result);
  * > [25, 19, 4]
  */
-function values (object) {
+export function values (object) {
   return Object.keys(object).reduce((acc, key) => {
     acc.push(object[key])
     return acc
   }, [])
 }
-
-export { values }

package/src/strings/camelCase.d.ts

@@ -1,12 +1,10 @@
 /**
  * camelCase updates a string to camelcase
- *
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns new camelCase string
- *
  * @example
  * const result = strings.camelCase('--BEST_friend--');
  * console.log(result);
  * > 'bestFriend'
  */
-export function camelCase(string?: string): string;
+export function camelCase(string: string): string;

package/src/strings/camelCase.js

@@ -1,13 +1,13 @@
 /**
  * camelCase updates a string to camelcase
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns new camelCase string
  * @example
  * const result = strings.camelCase('--BEST_friend--');
  * console.log(result);
  * > 'bestFriend'
  */
-function camelCase (string) {
+export function camelCase (string) {
   let first = true
   const res = string.replace(/[\u2019']/, '').split(/[\u002D\u2014\-_\s]+/).reduce((acc, word) => {
     if (first && word.length > 0) {
@@ -20,5 +20,3 @@ function camelCase (string) {
   }, '')
   return res
 }
-
-export { camelCase }

package/src/strings/chomp.d.ts

@@ -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/chomp.js

@@ -12,7 +12,7 @@
  * console.log(result);
  * > 'Sau'
  */
-function chomp (string, separator) {
+export function chomp (string, separator) {
   const res = string.split('')
   let windows = false
   if (separator === undefined) {
@@ -64,5 +64,3 @@ function chomp (string, separator) {
     }, '')
   }
 }
-
-export { chomp }

package/src/strings/deburr.d.ts

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

package/src/strings/deburr.js

@@ -1,18 +1,19 @@
 /**
  * Deburrs string by converting all complex Latin characters to basic Latin letters in a string.
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns simplified string
  * @example
  * const result = strings.deburr('_ŁŐúnged\ufe2f_');
  * console.log(result);
  * > '_LOunged_'
  */
-function deburr (string) {
+export function deburr (string) {
   let result = ''
   const found = string.match(latinRegex)
   if (found) {
     result = found.reduce((res, curr) => {
       if (curr.length === 1) {
+        // @ts-ignore
         return Object.prototype.hasOwnProperty.call(latinMap, curr) ? res + latinMap[curr] : res + curr
       } else {
         return res + curr
@@ -30,5 +31,3 @@ const diacriticalMarks = /[\u0300-\u036f\ufe20-\ufe2f\u20d0-\u20ff\u1ab0-\u1aff\
 const chars = 'ÀÁÂÃÄÅàáâãäåÇçÐðÈÉÊËèéêëÌÍÎÏìíîïÑñÒÓÔÕÖØòóôõöøÙÚÛÜùúûüÝýÿÆæÞþßĀĂĄāăąĆĈĊČćĉċčĎĐďđĒĔĖĘĚēĕėęěĜĞĠĢĝğġģĤĦĥħĨĪĬĮİĩīĭįıĴĵĶķĸĹĻĽĿŁĺļľŀłŃŅŇŊńņňŋŌŎŐōŏőŔŖŘŕŗřŚŜŞŠśŝşšŢŤŦţťŧŨŪŬŮŰŲũūŭůűųŴŵŶŷŸŹŻŽźżžIJijŒœʼnſ'
 const latinRegex = new RegExp('[' + chars + ']|[^' + chars + ']+', 'g')
 const latinMap = { À: 'A', Á: 'A', Â: 'A', Ã: 'A', Ä: 'A', Å: 'A', à: 'a', á: 'a', â: 'a', ã: 'a', ä: 'a', å: 'a', Ç: 'C', ç: 'c', Ð: 'D', ð: 'd', È: 'E', É: 'E', Ê: 'E', Ë: 'E', è: 'e', é: 'e', ê: 'e', ë: 'e', Ì: 'I', Í: 'I', Î: 'I', Ï: 'I', ì: 'i', í: 'i', î: 'i', ï: 'i', Ñ: 'N', ñ: 'n', Ò: 'O', Ó: 'O', Ô: 'O', Õ: 'O', Ö: 'O', Ø: 'O', ò: 'o', ó: 'o', ô: 'o', õ: 'o', ö: 'o', ø: 'o', Ù: 'U', Ú: 'U', Û: 'U', Ü: 'U', ù: 'u', ú: 'u', û: 'u', ü: 'u', Ý: 'Y', ý: 'y', ÿ: 'y', Æ: 'Ae', æ: 'ae', Þ: 'Th', þ: 'th', ß: 'ss', Ā: 'A', Ă: 'A', Ą: 'A', ā: 'a', ă: 'a', ą: 'a', Ć: 'C', Ĉ: 'C', Ċ: 'C', Č: 'C', ć: 'c', ĉ: 'c', ċ: 'c', č: 'c', Ď: 'D', Đ: 'D', ď: 'd', đ: 'd', Ē: 'E', Ĕ: 'E', Ė: 'E', Ę: 'E', Ě: 'E', ē: 'e', ĕ: 'e', ė: 'e', ę: 'e', ě: 'e', Ĝ: 'G', Ğ: 'G', Ġ: 'G', Ģ: 'G', ĝ: 'g', ğ: 'g', ġ: 'g', ģ: 'g', Ĥ: 'H', Ħ: 'H', ĥ: 'h', ħ: 'h', Ĩ: 'I', Ī: 'I', Ĭ: 'I', Į: 'I', İ: 'I', ĩ: 'i', ī: 'i', ĭ: 'i', į: 'i', ı: 'i', Ĵ: 'J', ĵ: 'j', Ķ: 'K', ķ: 'k', ĸ: 'k', Ĺ: 'L', Ļ: 'L', Ľ: 'L', Ŀ: 'L', Ł: 'L', ĺ: 'l', ļ: 'l', ľ: 'l', ŀ: 'l', ł: 'l', Ń: 'N', Ņ: 'N', Ň: 'N', Ŋ: 'N', ń: 'n', ņ: 'n', ň: 'n', ŋ: 'n', Ō: 'O', Ŏ: 'O', Ő: 'O', ō: 'o', ŏ: 'o', ő: 'o', Ŕ: 'R', Ŗ: 'R', Ř: 'R', ŕ: 'r', ŗ: 'r', ř: 'r', Ś: 'S', Ŝ: 'S', Ş: 'S', Š: 'S', ś: 's', ŝ: 's', ş: 's', š: 's', Ţ: 'T', Ť: 'T', Ŧ: 'T', ţ: 't', ť: 't', ŧ: 't', Ũ: 'U', Ū: 'U', Ŭ: 'U', Ů: 'U', Ű: 'U', Ų: 'U', ũ: 'u', ū: 'u', ŭ: 'u', ů: 'u', ű: 'u', ų: 'u', Ŵ: 'W', ŵ: 'w', Ŷ: 'Y', ŷ: 'y', Ÿ: 'Y', Ź: 'Z', Ż: 'Z', Ž: 'Z', ź: 'z', ż: 'z', ž: 'z', IJ: 'IJ', ij: 'ij', Œ: 'Oe', œ: 'oe', ʼn: "'n", ſ: 's' }
-
-export { deburr }

package/src/strings/endsWith.d.ts

@@ -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/endsWith.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * Tests a string to see if it ends with a substring
  * @param {string} string input string
@@ -12,7 +14,7 @@
  * console.log(result);
  * > false
  */
-function endsWith (string, substr = '') {
+export function endsWith (string, substr = '') {
   const reducer = (acc, _, idx, arr) => {
     // exit early on mismatch
     if (arr[arr.length - idx - 1] !== substr[substr.length - idx - 1]) {
@@ -29,5 +31,3 @@ function endsWith (string, substr = '') {
 
   return string.split('').reduce(reducer, null)
 }
-
-export { endsWith }

package/src/strings/includes.d.ts

@@ -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/includes.js

@@ -13,7 +13,7 @@
  * console.log(result);
  * > false
  */
-function includes (string, substr, start = 0) {
+export function includes (string, substr, start = 0) {
   if (string.length === 0) return false
   const len = substr.length
   const first = substr.charAt(0)
@@ -29,5 +29,3 @@ function includes (string, substr, start = 0) {
     return false
   }, false)
 }
-
-export { includes }

package/src/strings/kebabCase.d.ts

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

package/src/strings/kebabCase.js

@@ -1,13 +1,13 @@
 /**
  * kebabCase updates a string to kebabcase
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns new kebabCase string
  * @example
  * const result = strings.kebabCase('css classes use kebab case');
  * console.log(result);
  * > 'css-classes-use-kebab-case'
  */
-function kebabCase (string) {
+export function kebabCase (string) {
   let first = true
   return string.replace(/[\u2019']/, '').split(/[\u002D\u2014\-_\s]+/).reduce((acc, word) => {
     if (word.length > 0) {
@@ -21,5 +21,3 @@ function kebabCase (string) {
     return acc
   }, '')
 }
-
-export { kebabCase }

package/src/strings/pad.d.ts

@@ -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/pad.js

@@ -20,10 +20,8 @@
  *  console.log(result);
  *  > 'FUNFUxyzxyzFUNFU'
  */
-function pad (string, length = 0, substr = ' ') {
+export function pad (string, length = 0, substr = ' ') {
   const strLen = string.length
   const padLen = (length - strLen) > 0 ? Math.ceil((length - strLen) / 2) : 0
   return string.padStart(length - padLen, substr).padEnd(length, substr)
 }
-
-export { pad }

package/src/strings/padEnd.d.ts

@@ -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/padEnd.js

@@ -20,13 +20,13 @@
  *  console.log(result);
  *  > 'abcabcfunfunfunf'
  */
-function padEnd (string, length = 0, substr = ' ') {
+export function padEnd (string, length = 0, substr = ' ') {
   let strLen = string.length
   const padLen = (length - string.length) > 0 ? length - string.length : 0
   let substrIdx = 0
   const stringArr = [...string, ...Array(padLen)]
 
-  const reducer = (acc, curr) => {
+  const reducer = (/** @type {string[]} */ acc, /** @type {string} */ curr) => {
     if (strLen !== 0) {
       acc.push(curr)
       strLen--
@@ -39,5 +39,3 @@ function padEnd (string, length = 0, substr = ' ') {
 
   return stringArr.reduce(reducer, []).join('')
 }
-
-export { padEnd }

package/src/strings/padStart.d.ts

@@ -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/padStart.js

@@ -20,12 +20,12 @@
  * console.log(result);
  * > 'funfunfunfabcabc'
  */
-function padStart (string, length = 0, substr = ' ') {
+export function padStart (string, length = 0, substr = ' ') {
   let padLen = (length - string.length) > 0 ? length - string.length : 0
   let substrIdx = 0
   const stringArr = [...Array(padLen), ...string]
 
-  const reducer = (acc, curr) => {
+  const reducer = (/** @type {string[]} */ acc, /** @type {string} */ curr) => {
     if (padLen !== 0) {
       acc.push(substr[substrIdx])
       substrIdx = (substrIdx + 1 < substr.length) ? substrIdx + 1 : 0
@@ -38,5 +38,3 @@ function padStart (string, length = 0, substr = ' ') {
 
   return stringArr.reduce(reducer, []).join('')
 }
-
-export { padStart }

package/src/strings/pascalCase.d.ts

@@ -1,12 +1,10 @@
 /**
  * pascalCase updates a string to pascalCase
- *
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns new pascalCase string
- *
  * @example
  * const result = strings.pascalCase('classes use pascal case');
  * console.log(result);
  * > 'ClassesUsePascalCase'
  */
-export function pascalCase(string?: string): string;
+export function pascalCase(string: string): string;

package/src/strings/pascalCase.js

@@ -1,17 +1,15 @@
 /**
  * pascalCase updates a string to pascalCase
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns new pascalCase string
  * @example
  * const result = strings.pascalCase('classes use pascal case');
  * console.log(result);
  * > 'ClassesUsePascalCase'
  */
-function pascalCase (string) {
+export function pascalCase (string) {
   const res = string.replace(/[\u2019']/, '').split(/[\u002D\u2014\-_\s]+/).reduce((acc, word) => {
     return acc + word.charAt(0).toUpperCase() + word.slice(1).toLowerCase()
   }, '')
   return res
 }
-
-export { pascalCase }

package/src/strings/repeat.d.ts

@@ -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/repeat.js

@@ -9,12 +9,10 @@
  * console.log(result);
  * > 'Moo Moo Moo '
  */
-function repeat (string, count = 0) {
+export function repeat (string, count = 0) {
   if (string.length === 0 || count < 1) return ''
 
   return new Array(count).fill('').reduce((res) => {
     return res + string
   }, '')
 }
-
-export { repeat }

package/src/strings/reverse.d.ts

@@ -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/reverse.js

@@ -7,10 +7,8 @@
  * console.log(result);
  * > desrever eb lliw gnirts sihT
  */
-function reverse (string) {
+export function reverse (string) {
   return string.split('').reduce((acc, curr) => {
     return curr + acc
   }, '')
 }
-
-export { reverse }

package/src/strings/snakeCase.d.ts

@@ -1,12 +1,10 @@
 /**
  * snakeCase updates a string to snakecase
- *
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns new snakeCase string
- *
  * @example
  * const result = strings.snakeCase('--BEST--friend--');
  * console.log(result);
  * > 'best_friend'
  */
-export function snakeCase(string?: string): string;
+export function snakeCase(string: string): string;

package/src/strings/snakeCase.js

@@ -1,13 +1,13 @@
 /**
  * snakeCase updates a string to snakecase
- * @param {string} [string] input string
+ * @param {string} string input string
  * @returns {string} returns new snakeCase string
  * @example
  * const result = strings.snakeCase('--BEST--friend--');
  * console.log(result);
  * > 'best_friend'
  */
-function snakeCase (string) {
+export function snakeCase (string) {
   let first = true
   return string.replace(/[\u2019']/, '').split(/[\u002D\u2014\-_\s]+/).reduce((acc, word) => {
     if (word.length > 0) {
@@ -21,5 +21,3 @@ function snakeCase (string) {
     return acc
   }, '')
 }
-
-export { snakeCase }