@develia/commons 0.4.12 → 0.4.14

package/src/string.ts

@@ -1,129 +1,129 @@
-
-/**
- * Ensures that a given string has a specific prefix.
- *
- * @param {string} str - The string to ensure the prefix on.
- * @param {string} prefix - The prefix to ensure on the string.
- * @return {string} - The resulting string with the ensured prefix.
- */
-export function ensurePrefix(str: string, prefix: string): string {
-    if (!str.startsWith(prefix))
-        return prefix + str
-    return str
-}
-
-
-/**
- * Ensures that a string ends with a specified suffix.
- *
- * @param {string} str - The original string.
- * @param {string} suffix - The suffix to ensure.
- * @return {string} - The modified string with the suffix added if it was not already present.
- */
-export function ensureSuffix(str: string, suffix: string): string {
-    if (!str.endsWith(suffix))
-        return str + suffix
-    return str
-}
-
-/**
- * Formats a string using a template and provided arguments.
- *
- * @param {string} template - The template string containing placeholders.
- * @param {any[]} args - Optional arguments to replace the placeholders in the template.
- * @return {string} The formatted string.
- */
-export function format(template: string, ...args: any[]): string {
-
-    let regex: RegExp;
-    if (args.length === 1 && typeof args[0] === 'object') {
-        args = args[0];
-        regex = /{(.+?)}/g;
-    } else {
-        regex = /{(\d+?)}/g;
-    }
-
-    return template.replace(regex, (match, key) => {
-        return typeof args[key] !== 'undefined' ? args[key] : "";
-    });
-}
-
-/**
- * Splits a string into its constituent words, regardless of the original case
- * style (camelCase, PascalCase, snake_case, kebab-case, CONSTANT_CASE,
- * space-separated, etc.).
- *
- * @param {string} str - The string to split into words.
- * @return {string[]} - The list of lowercase words extracted from the input.
- */
-function toWords(str: string): string[] {
-    if (!str) return [];
-
-    return str
-        // Insert a space between a lowercase/digit and an uppercase letter (camelCase -> camel Case)
-        .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
-        // Insert a space between consecutive uppercase letters followed by a lowercase letter (XMLParser -> XML Parser)
-        .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2')
-        // Replace any non-alphanumeric character with a space
-        .replace(/[^a-zA-Z0-9]+/g, ' ')
-        .trim()
-        .toLowerCase()
-        .split(/\s+/)
-        .filter(Boolean);
-}
-
-/**
- * Converts a string to snake_case.
- *
- * @param {string} str - The string to convert.
- * @return {string} - The string converted to snake_case.
- */
-export function toSnakeCase(str: string): string {
-    return toWords(str).join('_');
-}
-
-/**
- * Converts a string to kebab-case.
- *
- * @param {string} str - The string to convert.
- * @return {string} - The string converted to kebab-case.
- */
-export function toKebabCase(str: string): string {
-    return toWords(str).join('-');
-}
-
-/**
- * Converts a string to camelCase.
- *
- * @param {string} str - The string to convert.
- * @return {string} - The string converted to camelCase.
- */
-export function toCamelCase(str: string): string {
-    const words = toWords(str);
-    if (words.length === 0) return '';
-    return words
-        .map((word, i) => i === 0 ? word : word.charAt(0).toUpperCase() + word.slice(1))
-        .join('');
-}
-
-/**
- * Converts a string to PascalCase.
- *
- * @param {string} str - The string to convert.
- * @return {string} - The string converted to PascalCase.
- */
-export function toPascalCase(str: string): string {
-    return toWords(str)
-        .map(word => word.charAt(0).toUpperCase() + word.slice(1))
-        .join('');
-}
-
-/**
- * Converts a string to CONSTANT_CASE (a.k.a. SCREAMING_SNAKE_CASE).
- *
- * @param {string} str - The string to convert.
- * @return {string} - The string converted to CONSTANT_CASE.
- */
-export function toConstantCase(str: string): string {
-    return toWords(str).join('_').toUpperCase();
+
+/**
+ * Ensures that a given string has a specific prefix.
+ *
+ * @param {string} str - The string to ensure the prefix on.
+ * @param {string} prefix - The prefix to ensure on the string.
+ * @return {string} - The resulting string with the ensured prefix.
+ */
+export function ensurePrefix(str: string, prefix: string): string {
+    if (!str.startsWith(prefix))
+        return prefix + str
+    return str
+}
+
+
+/**
+ * Ensures that a string ends with a specified suffix.
+ *
+ * @param {string} str - The original string.
+ * @param {string} suffix - The suffix to ensure.
+ * @return {string} - The modified string with the suffix added if it was not already present.
+ */
+export function ensureSuffix(str: string, suffix: string): string {
+    if (!str.endsWith(suffix))
+        return str + suffix
+    return str
+}
+
+/**
+ * Formats a string using a template and provided arguments.
+ *
+ * @param {string} template - The template string containing placeholders.
+ * @param {any[]} args - Optional arguments to replace the placeholders in the template.
+ * @return {string} The formatted string.
+ */
+export function format(template: string, ...args: any[]): string {
+
+    let regex: RegExp;
+    if (args.length === 1 && typeof args[0] === 'object') {
+        args = args[0];
+        regex = /{(.+?)}/g;
+    } else {
+        regex = /{(\d+?)}/g;
+    }
+
+    return template.replace(regex, (match, key) => {
+        return typeof args[key] !== 'undefined' ? args[key] : "";
+    });
+}
+
+/**
+ * Splits a string into its constituent words, regardless of the original case
+ * style (camelCase, PascalCase, snake_case, kebab-case, CONSTANT_CASE,
+ * space-separated, etc.).
+ *
+ * @param {string} str - The string to split into words.
+ * @return {string[]} - The list of lowercase words extracted from the input.
+ */
+function toWords(str: string): string[] {
+    if (!str) return [];
+
+    return str
+        // Insert a space between a lowercase/digit and an uppercase letter (camelCase -> camel Case)
+        .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
+        // Insert a space between consecutive uppercase letters followed by a lowercase letter (XMLParser -> XML Parser)
+        .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2')
+        // Replace any non-alphanumeric character with a space
+        .replace(/[^a-zA-Z0-9]+/g, ' ')
+        .trim()
+        .toLowerCase()
+        .split(/\s+/)
+        .filter(Boolean);
+}
+
+/**
+ * Converts a string to snake_case.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to snake_case.
+ */
+export function toSnakeCase(str: string): string {
+    return toWords(str).join('_');
+}
+
+/**
+ * Converts a string to kebab-case.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to kebab-case.
+ */
+export function toKebabCase(str: string): string {
+    return toWords(str).join('-');
+}
+
+/**
+ * Converts a string to camelCase.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to camelCase.
+ */
+export function toCamelCase(str: string): string {
+    const words = toWords(str);
+    if (words.length === 0) return '';
+    return words
+        .map((word, i) => i === 0 ? word : word.charAt(0).toUpperCase() + word.slice(1))
+        .join('');
+}
+
+/**
+ * Converts a string to PascalCase.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to PascalCase.
+ */
+export function toPascalCase(str: string): string {
+    return toWords(str)
+        .map(word => word.charAt(0).toUpperCase() + word.slice(1))
+        .join('');
+}
+
+/**
+ * Converts a string to CONSTANT_CASE (a.k.a. SCREAMING_SNAKE_CASE).
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to CONSTANT_CASE.
+ */
+export function toConstantCase(str: string): string {
+    return toWords(str).join('_').toUpperCase();
 }

package/src/type-code.ts

@@ -1,16 +1,16 @@
-enum TypeCode {
-    String    = 'string',
-    Number    = 'number',
-    Boolean   = 'boolean',
-    Symbol    = 'symbol',
-    BigInt    = 'bigint',
-    Null      = 'null',
-    Undefined = 'undefined',
-    Object    = 'object',
-    Function  = 'function',
-    Array     = 'array',
-    Unknown   = 'unknown',
-}
-
-
+enum TypeCode {
+    String    = 'string',
+    Number    = 'number',
+    Boolean   = 'boolean',
+    Symbol    = 'symbol',
+    BigInt    = 'bigint',
+    Null      = 'null',
+    Undefined = 'undefined',
+    Object    = 'object',
+    Function  = 'function',
+    Array     = 'array',
+    Unknown   = 'unknown',
+}
+
+
 export default TypeCode;