es-toolkit 1.20.0 → 1.21.0-dev.660

package/dist/predicate/index.d.mts

@@ -1,5 +1,6 @@
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
+export { isError } from './isError.mjs';
 export { isNil } from './isNil.mjs';
 export { isNotNil } from './isNotNil.mjs';
 export { isNull } from './isNull.mjs';

package/dist/predicate/index.d.ts

@@ -1,5 +1,6 @@
 export { isDate } from './isDate.js';
 export { isEqual } from './isEqual.js';
+export { isError } from './isError.js';
 export { isNil } from './isNil.js';
 export { isNotNil } from './isNotNil.js';
 export { isNull } from './isNull.js';

package/dist/predicate/index.js

@@ -2,11 +2,11 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const isWeakSet = require('../_chunk/isWeakSet-E_VMwB.js');
+const isWeakSet = require('../_chunk/isWeakSet-1xFSnK.js');
 const isPlainObject = require('../_chunk/isPlainObject-BIekvL.js');
 
-function isRegExp(value) {
-    return value instanceof RegExp;
+function isError(value) {
+    return value instanceof Error;
 }
 
 function isBoolean(x) {
@@ -28,6 +28,7 @@ exports.isLength = isWeakSet.isLength;
 exports.isNil = isWeakSet.isNil;
 exports.isNotNil = isWeakSet.isNotNil;
 exports.isNull = isWeakSet.isNull;
+exports.isRegExp = isWeakSet.isRegExp;
 exports.isUndefined = isWeakSet.isUndefined;
 exports.isWeakMap = isWeakSet.isWeakMap;
 exports.isWeakSet = isWeakSet.isWeakSet;
@@ -35,6 +36,6 @@ exports.isPlainObject = isPlainObject.isPlainObject;
 exports.isPrimitive = isPlainObject.isPrimitive;
 exports.isTypedArray = isPlainObject.isTypedArray;
 exports.isBoolean = isBoolean;
-exports.isRegExp = isRegExp;
+exports.isError = isError;
 exports.isString = isString;
 exports.isSymbol = isSymbol;

package/dist/predicate/index.mjs

@@ -1,5 +1,6 @@
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
+export { isError } from './isError.mjs';
 export { isNil } from './isNil.mjs';
 export { isNotNil } from './isNotNil.mjs';
 export { isNull } from './isNull.mjs';

package/dist/predicate/isError.d.mts

@@ -0,0 +1,16 @@
+/**
+ * Checks if `value` is an Error object.
+ *
+ * @param {unknown} value The value to check.
+ * @returns {value is Error} Returns `true` if `value` is an Error object, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * console.log(isError(new Error())); // true
+ * console.log(isError('Error')); // false
+ * console.log(isError({ name: 'Error', message: '' })); // false
+ * ```
+ */
+declare function isError(value: unknown): value is Error;
+
+export { isError };

package/dist/predicate/isError.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Checks if `value` is an Error object.
+ *
+ * @param {unknown} value The value to check.
+ * @returns {value is Error} Returns `true` if `value` is an Error object, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * console.log(isError(new Error())); // true
+ * console.log(isError('Error')); // false
+ * console.log(isError({ name: 'Error', message: '' })); // false
+ * ```
+ */
+declare function isError(value: unknown): value is Error;
+
+export { isError };

package/dist/predicate/isError.mjs

@@ -0,0 +1,5 @@
+function isError(value) {
+    return value instanceof Error;
+}
+
+export { isError };

package/dist/promise/withTimeout.d.mts

@@ -11,10 +11,16 @@
  * @returns {Promise<T>} A promise that resolves with the result of the `run` function or rejects if the timeout is reached.
  *
  * @example
+ * async function fetchData() {
+ *   const response = await fetch('https://example.com/data');
+ *   return response.json();
+ * }
+ *
  * try {
- *   await withTimeout(() => {}, 1000); // Timeout exception after 1 second
+ *   const data = await withTimeout(fetchData, 1000);
+ *   console.log(data); // Logs the fetched data if `fetchData` is resolved within 1 second.
  * } catch (error) {
- *   console.error(error); // Will log 'TimeoutError'
+ *   console.error(error); // Will log 'TimeoutError' if `fetchData` is not resolved within 1 second.
  * }
  */
 declare function withTimeout<T>(run: () => Promise<T>, ms: number): Promise<T>;

package/dist/promise/withTimeout.d.ts

@@ -11,10 +11,16 @@
  * @returns {Promise<T>} A promise that resolves with the result of the `run` function or rejects if the timeout is reached.
  *
  * @example
+ * async function fetchData() {
+ *   const response = await fetch('https://example.com/data');
+ *   return response.json();
+ * }
+ *
  * try {
- *   await withTimeout(() => {}, 1000); // Timeout exception after 1 second
+ *   const data = await withTimeout(fetchData, 1000);
+ *   console.log(data); // Logs the fetched data if `fetchData` is resolved within 1 second.
  * } catch (error) {
- *   console.error(error); // Will log 'TimeoutError'
+ *   console.error(error); // Will log 'TimeoutError' if `fetchData` is not resolved within 1 second.
  * }
  */
 declare function withTimeout<T>(run: () => Promise<T>, ms: number): Promise<T>;

package/dist/string/_internal/getWords.mjs

@@ -1,4 +1,4 @@
-const CASE_SPLIT_PATTERN = /[A-Z]?[a-z]+|[0-9]+|[A-Z]+(?![a-z])/g;
+const CASE_SPLIT_PATTERN = /[A-Z]?[a-z]+|[0-9]+|[A-Z]+(?![a-z])|\p{Emoji_Presentation}|\p{Extended_Pictographic}|\p{L}+/gu;
 function getWords(str) {
     return Array.from(str.match(CASE_SPLIT_PATTERN) ?? []);
 }

package/dist/string/camelCase.d.mts

@@ -12,6 +12,7 @@
  * const convertedStr2 = camelCase('some whitespace') // returns 'someWhitespace'
  * const convertedStr3 = camelCase('hyphen-text') // returns 'hyphenText'
  * const convertedStr4 = camelCase('HTTPRequest') // returns 'httpRequest'
+ * const convertedStr5 = camelCase('Keep unicode 😅') // returns 'keepUnicode😅'
  */
 declare function camelCase(str: string): string;
 

package/dist/string/camelCase.d.ts

@@ -12,6 +12,7 @@
  * const convertedStr2 = camelCase('some whitespace') // returns 'someWhitespace'
  * const convertedStr3 = camelCase('hyphen-text') // returns 'hyphenText'
  * const convertedStr4 = camelCase('HTTPRequest') // returns 'httpRequest'
+ * const convertedStr5 = camelCase('Keep unicode 😅') // returns 'keepUnicode😅'
  */
 declare function camelCase(str: string): string;
 

package/dist/string/constantCase.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Converts a string to constant case.
+ *
+ * Constant case is a naming convention where each word is written in uppercase letters and separated by an underscore (`_`). For example, `CONSTANT_CASE`.
+ *
+ * @param {string} str - The string that is to be changed to constant case.
+ * @returns {string} - The converted string to constant case.
+ *
+ * @example
+ * const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'
+ * const convertedStr2 = constantCase('some whitespace') // returns 'SOME_WHITESPACE'
+ * const convertedStr3 = constantCase('hyphen-text') // returns 'HYPHEN_TEXT'
+ * const convertedStr4 = constantCase('HTTPRequest') // returns 'HTTP_REQUEST'
+ */
+declare function constantCase(str: string): string;
+
+export { constantCase };

package/dist/string/constantCase.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Converts a string to constant case.
+ *
+ * Constant case is a naming convention where each word is written in uppercase letters and separated by an underscore (`_`). For example, `CONSTANT_CASE`.
+ *
+ * @param {string} str - The string that is to be changed to constant case.
+ * @returns {string} - The converted string to constant case.
+ *
+ * @example
+ * const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'
+ * const convertedStr2 = constantCase('some whitespace') // returns 'SOME_WHITESPACE'
+ * const convertedStr3 = constantCase('hyphen-text') // returns 'HYPHEN_TEXT'
+ * const convertedStr4 = constantCase('HTTPRequest') // returns 'HTTP_REQUEST'
+ */
+declare function constantCase(str: string): string;
+
+export { constantCase };

package/dist/string/constantCase.mjs

@@ -0,0 +1,8 @@
+import { getWords } from './_internal/getWords.mjs';
+
+function constantCase(str) {
+    const words = getWords(str);
+    return words.map(word => word.toUpperCase()).join('_');
+}
+
+export { constantCase };

package/dist/string/index.d.mts

@@ -6,6 +6,7 @@ export { lowerCase } from './lowerCase.mjs';
 export { startCase } from './startCase.mjs';
 export { capitalize } from './capitalize.mjs';
 export { pascalCase } from './pascalCase.mjs';
+export { constantCase } from './constantCase.mjs';
 export { trim } from './trim.mjs';
 export { trimStart } from './trimStart.mjs';
 export { trimEnd } from './trimEnd.mjs';

package/dist/string/index.d.ts

@@ -6,6 +6,7 @@ export { lowerCase } from './lowerCase.js';
 export { startCase } from './startCase.js';
 export { capitalize } from './capitalize.js';
 export { pascalCase } from './pascalCase.js';
+export { constantCase } from './constantCase.js';
 export { trim } from './trim.js';
 export { trimStart } from './trimStart.js';
 export { trimEnd } from './trimEnd.js';

package/dist/string/index.js

@@ -6,7 +6,7 @@ function capitalize(str) {
     return (str.charAt(0).toUpperCase() + str.slice(1).toLowerCase());
 }
 
-const CASE_SPLIT_PATTERN = /[A-Z]?[a-z]+|[0-9]+|[A-Z]+(?![a-z])/g;
+const CASE_SPLIT_PATTERN = /[A-Z]?[a-z]+|[0-9]+|[A-Z]+(?![a-z])|\p{Emoji_Presentation}|\p{Extended_Pictographic}|\p{L}+/gu;
 function getWords(str) {
     return Array.from(str.match(CASE_SPLIT_PATTERN) ?? []);
 }
@@ -50,16 +50,12 @@ function lowerCase(str) {
 function startCase(str) {
     const words = getWords(str.trim());
     let result = '';
-    for (const word of words) {
+    for (let i = 0; i < words.length; i++) {
+        const word = words[i];
         if (result) {
             result += ' ';
         }
-        if (word === word.toUpperCase()) {
-            result += word;
-        }
-        else {
-            result += word[0].toUpperCase() + word.slice(1).toLowerCase();
-        }
+        result += word[0].toUpperCase() + word.slice(1).toLowerCase();
     }
     return result;
 }
@@ -69,6 +65,11 @@ function pascalCase(str) {
     return words.map(word => capitalize(word)).join('');
 }
 
+function constantCase(str) {
+    const words = getWords(str);
+    return words.map(word => word.toUpperCase()).join('_');
+}
+
 function trimStart(str, chars) {
     if (chars === undefined) {
         return str.trimStart();
@@ -202,6 +203,7 @@ function pad(str, length, chars = ' ') {
 
 exports.camelCase = camelCase;
 exports.capitalize = capitalize;
+exports.constantCase = constantCase;
 exports.deburr = deburr;
 exports.escape = escape;
 exports.escapeRegExp = escapeRegExp;

package/dist/string/index.mjs

@@ -6,6 +6,7 @@ export { lowerCase } from './lowerCase.mjs';
 export { startCase } from './startCase.mjs';
 export { capitalize } from './capitalize.mjs';
 export { pascalCase } from './pascalCase.mjs';
+export { constantCase } from './constantCase.mjs';
 export { trim } from './trim.mjs';
 export { trimStart } from './trimStart.mjs';
 export { trimEnd } from './trimEnd.mjs';

package/dist/string/startCase.d.mts

@@ -7,7 +7,7 @@
  *
  * @example
  * const result1 = startCase('hello world');  // result will be 'Hello World'
- * const result2 = startCase('HELLO WORLD');  // result will be 'HELLO WORLD'
+ * const result2 = startCase('HELLO WORLD');  // result will be 'Hello World'
  * const result3 = startCase('hello-world');  // result will be 'Hello World'
  * const result4 = startCase('hello_world');  // result will be 'Hello World'
  */

package/dist/string/startCase.d.ts

@@ -7,7 +7,7 @@
  *
  * @example
  * const result1 = startCase('hello world');  // result will be 'Hello World'
- * const result2 = startCase('HELLO WORLD');  // result will be 'HELLO WORLD'
+ * const result2 = startCase('HELLO WORLD');  // result will be 'Hello World'
  * const result3 = startCase('hello-world');  // result will be 'Hello World'
  * const result4 = startCase('hello_world');  // result will be 'Hello World'
  */

package/dist/string/startCase.mjs

@@ -3,16 +3,12 @@ import { getWords } from './_internal/getWords.mjs';
 function startCase(str) {
     const words = getWords(str.trim());
     let result = '';
-    for (const word of words) {
+    for (let i = 0; i < words.length; i++) {
+        const word = words[i];
         if (result) {
             result += ' ';
         }
-        if (word === word.toUpperCase()) {
-            result += word;
-        }
-        else {
-            result += word[0].toUpperCase() + word.slice(1).toLowerCase();
-        }
+        result += word[0].toUpperCase() + word.slice(1).toLowerCase();
     }
     return result;
 }

package/dist/string/trimStart.d.mts

@@ -2,7 +2,7 @@
  * Removes leading whitespace or specified characters from a string.
  *
  * @param {string} str - The string from which leading characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string.
+ * @param {string | string[]} chars - The character(s) to remove from the start of the string.
  * @returns {string} - The resulting string after the specified leading character has been removed.
  *
  * @example

package/dist/string/trimStart.d.ts

@@ -2,7 +2,7 @@
  * Removes leading whitespace or specified characters from a string.
  *
  * @param {string} str - The string from which leading characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string.
+ * @param {string | string[]} chars - The character(s) to remove from the start of the string.
  * @returns {string} - The resulting string after the specified leading character has been removed.
  *
  * @example

package/dist/string/upperFirst.d.mts

@@ -5,9 +5,9 @@
  * @returns {string} - The converted string.
  *
  * @example
- * const convertedStr1 = upperCase('fred') // returns 'fred'
- * const convertedStr2 = upperCase('Fred') // returns 'Fred'
- * const convertedStr3 = upperCase('FRED') // returns 'FRED'
+ * const convertedStr1 = upperFirst('fred') // returns 'Fred'
+ * const convertedStr2 = upperFirst('Fred') // returns 'Fred'
+ * const convertedStr3 = upperFirst('FRED') // returns 'FRED'
  */
 declare function upperFirst(str: string): string;
 

package/dist/string/upperFirst.d.ts

@@ -5,9 +5,9 @@
  * @returns {string} - The converted string.
  *
  * @example
- * const convertedStr1 = upperCase('fred') // returns 'fred'
- * const convertedStr2 = upperCase('Fred') // returns 'Fred'
- * const convertedStr3 = upperCase('FRED') // returns 'FRED'
+ * const convertedStr1 = upperFirst('fred') // returns 'Fred'
+ * const convertedStr2 = upperFirst('Fred') // returns 'Fred'
+ * const convertedStr3 = upperFirst('FRED') // returns 'FRED'
  */
 declare function upperFirst(str: string): string;
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.20.0",
+  "version": "1.21.0-dev.660+d2164703",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {
@@ -228,6 +228,7 @@
     "eslint": "^9.9.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jsdoc": "^50.2.2",
+    "eslint-plugin-no-for-of-array": "^0.0.1",
     "eslint-plugin-vue": "^9.28.0",
     "execa": "^9.3.0",
     "globals": "^15.9.0",