@zairakai/js-utils 1.0.0

package/dist/formatters.d.cts

@@ -0,0 +1,180 @@
+/**
+ * String manipulation and formatting utilities
+ */
+/**
+ * Capitalize the first letter of a string and lowercase the rest.
+ *
+ * @param {unknown} value The value to capitalize
+ * @returns {string} The capitalized string
+ */
+declare const capitalize: (value: unknown) => string;
+/**
+ * Convert a string into a URL-friendly "slug".
+ *
+ * @param {unknown} text The text to slugify
+ * @returns {string} The slugified string
+ */
+declare const slugify: (text: unknown) => string;
+/**
+ * Limit the number of characters in a string.
+ *
+ * @param {unknown} value The string to limit
+ * @param {number} size The maximum number of characters
+ * @returns {string} The limited string
+ */
+declare const strLimit: (value: unknown, size: number) => string;
+/**
+ * Normalize a string by trimming, lowercasing, and removing accents.
+ *
+ * @param {string | null | undefined} value The string to normalize
+ * @returns {string | null | undefined} The normalized string
+ */
+declare const normalizeString: (value: string | null | undefined) => string | null | undefined;
+/**
+ * Determine if a string contains all of the given values.
+ *
+ * @param {string} haystack The string to search in
+ * @param {string[]} needles The values to search for
+ * @returns {boolean} True if all values are found
+ */
+declare const strContainsAll: (haystack: string, needles: string[]) => boolean;
+/**
+ * Determine if a string contains any of the given values.
+ *
+ * @param {string} haystack The string to search in
+ * @param {string[]} needles The values to search for
+ * @returns {boolean} True if any value is found
+ */
+declare const strContainsAny: (haystack: string, needles: string[]) => boolean;
+/**
+ * Cap a string with a single instance of a given value.
+ *
+ * @param {string} value The source string
+ * @param {string} cap The value to append if not present
+ * @returns {string} The capped string
+ */
+declare const strFinish: (value: string, cap: string) => string;
+/**
+ * Begin a string with a single instance of a given value.
+ *
+ * @param {string} value The source string
+ * @param {string} prefix The value to prepend if not present
+ * @returns {string} The prefixed string
+ */
+declare const strStart: (value: string, prefix: string) => string;
+/**
+ * Pad both sides of a string with another.
+ *
+ * @param {string} str The source string
+ * @param {number} length The desired length
+ * @param {string} [pad=' '] The value to pad with
+ * @returns {string} The padded string
+ */
+declare const strPadBoth: (str: string, length: number, pad?: string) => string;
+/**
+ * Pad the left side of a string with another.
+ *
+ * @param {string} str The source string
+ * @param {number} length The desired length
+ * @param {string} [pad=' '] The value to pad with
+ * @returns {string} The padded string
+ */
+declare const strPadLeft: (str: string, length: number, pad?: string) => string;
+/**
+ * Pad the right side of a string with another.
+ *
+ * @param {string} str The source string
+ * @param {number} length The desired length
+ * @param {string} [pad=' '] The value to pad with
+ * @returns {string} The padded string
+ */
+declare const strPadRight: (str: string, length: number, pad?: string) => string;
+/**
+ * Reverse the given string.
+ *
+ * @param {string} value The string to reverse
+ * @returns {string} The reversed string
+ */
+declare const strReverse: (value: string) => string;
+/**
+ * Remove any occurrence of the given string in the subject.
+ *
+ * @param {string} search The string to remove
+ * @param {string} subject The source string
+ * @param {boolean} [caseSensitive=true] Whether to perform case-sensitive removal
+ * @returns {string} The resulting string
+ */
+declare const strRemove: (search: string, subject: string, caseSensitive?: boolean) => string;
+/**
+ * Mask a portion of a string with a repeated character.
+ *
+ * @param {string} str The source string
+ * @param {string} character The character to use for masking
+ * @param {number} index The starting index
+ * @param {number} [length] The number of characters to mask
+ * @returns {string} The masked string
+ */
+declare const strMask: (str: string, character: string, index: number, length?: number) => string;
+/**
+ * Count the number of words in a string.
+ *
+ * @param {string} str The string to count words in
+ * @param {string} [characters] Optional characters to treat as word boundaries
+ * @returns {number} The word count
+ */
+declare const strWordCount: (str: string, characters?: string) => number;
+/**
+ * Limit the number of words in a string.
+ *
+ * @param {string} value The string to limit
+ * @param {number} [words=100] The maximum number of words
+ * @param {string} [end='...'] The string to append if truncated
+ * @returns {string} The limited string
+ */
+declare const strWords: (value: string, words?: number, end?: string) => string;
+/**
+ * Convert a string to camelCase.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The camelCased string
+ */
+declare const camelCase: (value: string) => string;
+/**
+ * Convert a string to snake_case.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The snake_cased string
+ */
+declare const snakeCase: (value: string) => string;
+/**
+ * Convert a string to kebab-case.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The kebab-cased string
+ */
+declare const kebabCase: (value: string) => string;
+/**
+ * Convert a string to StudlyCase.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The studlyCased string
+ */
+declare const studlyCase: (value: string) => string;
+/**
+ * Convert a string to Title Case.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The titleCased string
+ */
+declare const titleCase: (value: string) => string;
+/**
+ * Format a number with grouped thousands and decimal point.
+ *
+ * @param {number} value The number to format
+ * @param {number} [decimals=2] The number of decimal points
+ * @param {string} [locale='en-US'] The locale to use for formatting
+ * @returns {string} The formatted number
+ */
+declare const numberFormat: (value: number, decimals?: number, locale?: string) => string;
+
+export { camelCase, capitalize, kebabCase, normalizeString, numberFormat, slugify, snakeCase, strContainsAll, strContainsAny, strFinish, strLimit, strMask, strPadBoth, strPadLeft, strPadRight, strRemove, strReverse, strStart, strWordCount, strWords, studlyCase, titleCase };

package/dist/formatters.d.ts

@@ -0,0 +1,180 @@
+/**
+ * String manipulation and formatting utilities
+ */
+/**
+ * Capitalize the first letter of a string and lowercase the rest.
+ *
+ * @param {unknown} value The value to capitalize
+ * @returns {string} The capitalized string
+ */
+declare const capitalize: (value: unknown) => string;
+/**
+ * Convert a string into a URL-friendly "slug".
+ *
+ * @param {unknown} text The text to slugify
+ * @returns {string} The slugified string
+ */
+declare const slugify: (text: unknown) => string;
+/**
+ * Limit the number of characters in a string.
+ *
+ * @param {unknown} value The string to limit
+ * @param {number} size The maximum number of characters
+ * @returns {string} The limited string
+ */
+declare const strLimit: (value: unknown, size: number) => string;
+/**
+ * Normalize a string by trimming, lowercasing, and removing accents.
+ *
+ * @param {string | null | undefined} value The string to normalize
+ * @returns {string | null | undefined} The normalized string
+ */
+declare const normalizeString: (value: string | null | undefined) => string | null | undefined;
+/**
+ * Determine if a string contains all of the given values.
+ *
+ * @param {string} haystack The string to search in
+ * @param {string[]} needles The values to search for
+ * @returns {boolean} True if all values are found
+ */
+declare const strContainsAll: (haystack: string, needles: string[]) => boolean;
+/**
+ * Determine if a string contains any of the given values.
+ *
+ * @param {string} haystack The string to search in
+ * @param {string[]} needles The values to search for
+ * @returns {boolean} True if any value is found
+ */
+declare const strContainsAny: (haystack: string, needles: string[]) => boolean;
+/**
+ * Cap a string with a single instance of a given value.
+ *
+ * @param {string} value The source string
+ * @param {string} cap The value to append if not present
+ * @returns {string} The capped string
+ */
+declare const strFinish: (value: string, cap: string) => string;
+/**
+ * Begin a string with a single instance of a given value.
+ *
+ * @param {string} value The source string
+ * @param {string} prefix The value to prepend if not present
+ * @returns {string} The prefixed string
+ */
+declare const strStart: (value: string, prefix: string) => string;
+/**
+ * Pad both sides of a string with another.
+ *
+ * @param {string} str The source string
+ * @param {number} length The desired length
+ * @param {string} [pad=' '] The value to pad with
+ * @returns {string} The padded string
+ */
+declare const strPadBoth: (str: string, length: number, pad?: string) => string;
+/**
+ * Pad the left side of a string with another.
+ *
+ * @param {string} str The source string
+ * @param {number} length The desired length
+ * @param {string} [pad=' '] The value to pad with
+ * @returns {string} The padded string
+ */
+declare const strPadLeft: (str: string, length: number, pad?: string) => string;
+/**
+ * Pad the right side of a string with another.
+ *
+ * @param {string} str The source string
+ * @param {number} length The desired length
+ * @param {string} [pad=' '] The value to pad with
+ * @returns {string} The padded string
+ */
+declare const strPadRight: (str: string, length: number, pad?: string) => string;
+/**
+ * Reverse the given string.
+ *
+ * @param {string} value The string to reverse
+ * @returns {string} The reversed string
+ */
+declare const strReverse: (value: string) => string;
+/**
+ * Remove any occurrence of the given string in the subject.
+ *
+ * @param {string} search The string to remove
+ * @param {string} subject The source string
+ * @param {boolean} [caseSensitive=true] Whether to perform case-sensitive removal
+ * @returns {string} The resulting string
+ */
+declare const strRemove: (search: string, subject: string, caseSensitive?: boolean) => string;
+/**
+ * Mask a portion of a string with a repeated character.
+ *
+ * @param {string} str The source string
+ * @param {string} character The character to use for masking
+ * @param {number} index The starting index
+ * @param {number} [length] The number of characters to mask
+ * @returns {string} The masked string
+ */
+declare const strMask: (str: string, character: string, index: number, length?: number) => string;
+/**
+ * Count the number of words in a string.
+ *
+ * @param {string} str The string to count words in
+ * @param {string} [characters] Optional characters to treat as word boundaries
+ * @returns {number} The word count
+ */
+declare const strWordCount: (str: string, characters?: string) => number;
+/**
+ * Limit the number of words in a string.
+ *
+ * @param {string} value The string to limit
+ * @param {number} [words=100] The maximum number of words
+ * @param {string} [end='...'] The string to append if truncated
+ * @returns {string} The limited string
+ */
+declare const strWords: (value: string, words?: number, end?: string) => string;
+/**
+ * Convert a string to camelCase.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The camelCased string
+ */
+declare const camelCase: (value: string) => string;
+/**
+ * Convert a string to snake_case.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The snake_cased string
+ */
+declare const snakeCase: (value: string) => string;
+/**
+ * Convert a string to kebab-case.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The kebab-cased string
+ */
+declare const kebabCase: (value: string) => string;
+/**
+ * Convert a string to StudlyCase.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The studlyCased string
+ */
+declare const studlyCase: (value: string) => string;
+/**
+ * Convert a string to Title Case.
+ *
+ * @param {string} value The string to convert
+ * @returns {string} The titleCased string
+ */
+declare const titleCase: (value: string) => string;
+/**
+ * Format a number with grouped thousands and decimal point.
+ *
+ * @param {number} value The number to format
+ * @param {number} [decimals=2] The number of decimal points
+ * @param {string} [locale='en-US'] The locale to use for formatting
+ * @returns {string} The formatted number
+ */
+declare const numberFormat: (value: number, decimals?: number, locale?: string) => string;
+
+export { camelCase, capitalize, kebabCase, normalizeString, numberFormat, slugify, snakeCase, strContainsAll, strContainsAny, strFinish, strLimit, strMask, strPadBoth, strPadLeft, strPadRight, strRemove, strReverse, strStart, strWordCount, strWords, studlyCase, titleCase };

package/dist/formatters.js

@@ -0,0 +1,48 @@
+import {
+  camelCase,
+  capitalize,
+  kebabCase,
+  normalizeString,
+  numberFormat,
+  slugify,
+  snakeCase,
+  strContainsAll,
+  strContainsAny,
+  strFinish,
+  strLimit,
+  strMask,
+  strPadBoth,
+  strPadLeft,
+  strPadRight,
+  strRemove,
+  strReverse,
+  strStart,
+  strWordCount,
+  strWords,
+  studlyCase,
+  titleCase
+} from "./chunk-F6RSTW65.js";
+export {
+  camelCase,
+  capitalize,
+  kebabCase,
+  normalizeString,
+  numberFormat,
+  slugify,
+  snakeCase,
+  strContainsAll,
+  strContainsAny,
+  strFinish,
+  strLimit,
+  strMask,
+  strPadBoth,
+  strPadLeft,
+  strPadRight,
+  strRemove,
+  strReverse,
+  strStart,
+  strWordCount,
+  strWords,
+  studlyCase,
+  titleCase
+};