@vanillaes/absurdum 2.0.7 → 2.0.11

package/src/strings/startsWith.d.ts

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

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this late
+
 /**
  * StartsWith tests a string to see if it starts with a substring
  * @param {string} string input string
@@ -12,7 +14,7 @@
  * console.log(result);
  * > false
  */
-function startsWith (string, substr) {
+export function startsWith (string, substr) {
   let chars = string.split('')
 
   const reducer = (acc, curr, idx, arr) => {
@@ -31,5 +33,3 @@ function startsWith (string, substr) {
 
   return chars.reduce(reducer, null)
 }
-
-export { startsWith }

package/src/strings/trimEnd.d.ts

@@ -1,13 +1,11 @@
 /**
  * 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} string input 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);
  * > '-_-abc'
  */
-export function trimEnd(string?: string, chars?: string): string;
+export function trimEnd(string: string, chars?: string): string;

package/src/strings/trimEnd.js

@@ -1,6 +1,6 @@
 /**
  * TrimEnd trims any whitespace or the selected characters from the end of the string
- * @param {string} [string] input string
+ * @param {string} string input 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
@@ -8,7 +8,7 @@
  * console.log(result);
  * > '-_-abc'
  */
-function trimEnd (string, chars = ' ') {
+export function trimEnd (string, chars = ' ') {
   const testChars = new Set([...chars])
   let end = true
   return [...string].reduceRight((acc, curr) => {
@@ -24,5 +24,3 @@ function trimEnd (string, chars = ' ') {
     }
   }, '')
 }
-
-export { trimEnd }

package/src/strings/trimStart.d.ts

@@ -1,13 +1,11 @@
 /**
  * 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} string input 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);
  * > 'abc-_-'
  */
-export function trimStart(string?: string, chars?: string): string;
+export function trimStart(string: string, chars?: string): string;

package/src/strings/trimStart.js

@@ -1,6 +1,6 @@
 /**
  * TrimStart trims any whitespace or the selected characters from the beginning of the string
- * @param {string} [string] input string
+ * @param {string} string input string
  * @param {string} [chars] characters to remove from beginning of string (default ' ')
  * @returns {string} string with the characters removed from beginning
  * @example
@@ -8,7 +8,7 @@
  * console.log(result);
  * > 'abc-_-'
  */
-function trimStart (string, chars = ' ') {
+export function trimStart (string, chars = ' ') {
   const testChars = new Set([...chars])
   let first = true
   return [...string].reduce((acc, curr) => {
@@ -24,5 +24,3 @@ function trimStart (string, chars = ' ') {
     }
   }, '')
 }
-
-export { trimStart }

package/src/strings/truncate.d.ts

@@ -1,21 +1,19 @@
 /**
  * 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 {string} string string to truncate
+ * @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
- **/
-export function truncate(string?: string, options?: {
-    length?: number;
-    omission?: string;
-    separator?: string | RegExp;
+ */
+export function truncate(string: string, options?: {
+    length?: number | undefined;
+    omission?: string | undefined;
+    separator?: string | RegExp | undefined;
 }): string;

package/src/strings/truncate.js

@@ -1,7 +1,7 @@
 /**
  * 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 {string} string string to truncate
  * @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 '...')
@@ -12,7 +12,7 @@
  * console.log(result);
  * > true
  */
-function truncate (string, options = {}) {
+export function truncate (string, options = {}) {
   let length = 30
   let omission = '...'
   let separator
@@ -29,7 +29,7 @@ function truncate (string, options = {}) {
   let result = string.slice(0, end)
   if (separator === undefined) { return result + omission }
 
-  let strSeparator
+  let strSeparator = ''
   let regexSeparator
   if (typeof separator === 'string') {
     strSeparator = separator
@@ -60,5 +60,3 @@ function truncate (string, options = {}) {
   }
   return result + omission
 }
-
-export { truncate }

package/src/strings/words.d.ts

@@ -1,23 +1,19 @@
 /**
  * Splits `string` into an array of its words.
- *
- * @param {string} [string] string to inspect for 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
- *
+ * @returns {string[]} 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);
  * // => ['I', 'can', 'I', 'should', '&', 'I', 'will']
  */
-export function words(string?: string, pattern?: string | RegExp): any[];
+export function words(string: string, pattern?: RegExp | string): string[];

package/src/strings/words.js

@@ -2,9 +2,9 @@
 
 /**
  * Splits `string` into an array of its words.
- * @param {string} [string] string to inspect for 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
+ * @returns {string[]} Returns an array of words
  * @example
  * const result = words('I can, I should, & I will');
  * console.log(result);
@@ -18,7 +18,7 @@
  * console.log(result);
  * // => ['I', 'can', 'I', 'should', '&', 'I', 'will']
  */
-function words (string, pattern) {
+export function words (string, pattern) {
   if (pattern === undefined) { return string.match(reUnicodeWords) || [] }
   if (typeof pattern === 'string') {
     return string.match(new RegExp('[^' + pattern + ']+', 'g')) || []
@@ -84,5 +84,3 @@ const reUnicodeWords = RegExp([
   `${rsDigit}+`,
   rsEmoji
 ].join('|'), 'g')
-
-export { words }