es-toolkit 1.0.0-dev.24 → 1.0.2-canary.0

package/esm/object/{omitBy.mjs → omitBy.js}

@@ -1,4 +1,4 @@
-import { slicedToArray as _slicedToArray } from './_virtual/_rollupPluginBabelHelpers.mjs';
+import { slicedToArray as _slicedToArray } from './_virtual/_rollupPluginBabelHelpers.js';
 
 /**
  * Creates a new object composed of the properties that do not satisfy the predicate function.

package/esm/object/omitBy.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/object/pick.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Creates a new object composed of the picked object properties.
+ *
+ * This function takes an object and an array of keys, and returns a new object that
+ * includes only the properties corresponding to the specified keys.
+ *
+ * @param {T} obj - The object to pick keys from.
+ * @param {K[]} keys - An array of keys to be picked from the object.
+ * @returns {Pick<T, K>} A new object with the specified keys picked.
+ *
+ * @example
+ *  * const obj = { a: 1, b: 2, c: 3 };
+ * const result = pick(obj, ['a', 'c']);
+ * // result will be { a: 1, c: 3 }
+ */
+export declare function pick<T, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;

package/esm/object/{pick.mjs → pick.js}

@@ -1,4 +1,4 @@
-import { createForOfIteratorHelper as _createForOfIteratorHelper } from './_virtual/_rollupPluginBabelHelpers.mjs';
+import { createForOfIteratorHelper as _createForOfIteratorHelper } from './_virtual/_rollupPluginBabelHelpers.js';
 
 /**
  * Creates a new object composed of the picked object properties.

package/esm/object/pick.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/object/pickBy.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Creates a new object composed of the properties that satisfy the predicate function.
+ *
+ * This function takes an object and a predicate function, and returns a new object that
+ * includes only the properties for which the predicate function returns true.
+ *
+ * @param {T} obj - The object to pick properties from.
+ * @param {(value: T[keyof T], key: string) => boolean} shouldPick - A predicate function that determines
+ * whether a property should be picked. It takes the property's key and value as arguments and returns `true`
+ * if the property should be picked, and `false` otherwise.
+ * @returns {Partial<T>} A new object with the properties that satisfy the predicate function.
+ *
+ * @example
+ * const obj = { a: 1, b: 'pick', c: 3 };
+ * const shouldPick = (value) => typeof value === 'string';
+ * const result = pickBy(obj, shouldPick);
+ * // result will be { b: 'pick' }
+ */
+export declare function pickBy<T extends Record<string, any>>(obj: T, shouldPick: (value: T[keyof T], key: string) => boolean): Partial<T>;

package/esm/object/{pickBy.mjs → pickBy.js}

@@ -1,4 +1,4 @@
-import { slicedToArray as _slicedToArray } from './_virtual/_rollupPluginBabelHelpers.mjs';
+import { slicedToArray as _slicedToArray } from './_virtual/_rollupPluginBabelHelpers.js';
 
 /**
  * Creates a new object composed of the properties that satisfy the predicate function.

package/esm/object/pickBy.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/esm/predicate/index.d.ts

@@ -0,0 +1,4 @@
+export { isNil } from './isNil';
+export { isNotNil } from './isNotNil';
+export { isNull } from './isNull';
+export { isUndefined } from './isUndefined';

package/esm/predicate/index.js

@@ -0,0 +1,4 @@
+export { isNil } from './isNil.js';
+export { isNotNil } from './isNotNil.js';
+export { isNull } from './isNull.js';
+export { isUndefined } from './isUndefined.js';

package/esm/predicate/isNil.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Checks if a given value is null or undefined.
+ *
+ * This function tests whether the provided value is either `null` or `undefined`.
+ * It returns `true` if the value is `null` or `undefined`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null` or `undefined`.
+ *
+ * @param {unknown} x - The value to test for null or undefined.
+ * @returns {boolean} `true` if the value is null or undefined, `false` otherwise.
+ *
+ * @example
+ *  * const value1 = null;
+ * const value2 = undefined;
+ * const value3 = 42;
+ * const result1 = isNil(value1); // true
+ * const result2 = isNil(value2); // true
+ * const result3 = isNil(value3); // false
+ */
+export declare function isNil(x: unknown): x is null | undefined;

package/esm/predicate/isNil.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/predicate/isNotNil.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Checks if the given value is not null nor undefined.
+ *
+ * The main use of this function is to be used with TypeScript as a type predicate.
+ *
+ * @param {T | null | undefined} x - The value to test if it is not null nor undefined.
+ * @returns {x is T} True if the value is not null nor undefined, false otherwise.
+ *
+ * @example
+ * // Here the type of `arr` is (number | undefined)[]
+ * const arr = [1, undefined, 3];
+ * // Here the type of `result` is number[]
+ * const result = arr.filter(isNotNil);
+ * // result will be [1, 3]
+ */
+export declare function isNotNil<T>(x: T | null | undefined): x is T;

package/esm/predicate/isNotNil.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/predicate/isNull.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Checks if the given value is null.
+ *
+ * This function tests whether the provided value is strictly equal to `null`.
+ * It returns `true` if the value is `null`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null`.
+ *
+ * @param {unknown} x - The value to test if it is null.
+ * @returns {x is null} True if the value is null, false otherwise.
+ *
+ * @example
+ *  * const value1 = null;
+ * const value2 = undefined;
+ * const value3 = 42;
+ *
+ * console.log(isNull(value1)); // true
+ * console.log(isNull(value2)); // false
+ * console.log(isNull(value3)); // false
+ */
+export declare function isNull(x: unknown): x is null;

package/esm/predicate/isNull.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/predicate/isUndefined.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Checks if the given value is undefined.
+ *
+ * This function tests whether the provided value is strictly equal to `undefined`.
+ * It returns `true` if the value is `undefined`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `undefined`.
+ *
+ * @param {unknown} x - The value to test if it is undefined.
+ * @returns {x is undefined} true if the value is undefined, false otherwise.
+ *
+ * @example
+ *  * const value1 = undefined;
+ * const value2 = null;
+ * const value3 = 42;
+ *
+ * console.log(isUndefined(value1)); // true
+ * console.log(isUndefined(value2)); // false
+ * console.log(isUndefined(value3)); // false
+ */
+export declare function isUndefined(x: unknown): x is undefined;

package/esm/predicate/isUndefined.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/promise/delay.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Delays the execution of code for a specified number of milliseconds.
+ *
+ * This function returns a Promise that resolves after the specified delay, allowing you to use it
+ * with async/await to pause execution.
+ *
+ * @param {number} ms - The number of milliseconds to delay.
+ * @returns {Promise<void>} A Promise that resolves after the specified delay.
+ *
+ * @example
+ * async function foo() {
+ *   console.log('Start');
+ *   await delay(1000); // Delays execution for 1 second
+ *   console.log('End');
+ * }
+ *
+ * foo();
+ */
+export declare function delay(ms: number): Promise<void>;

package/esm/promise/delay.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/promise/index.d.ts

@@ -0,0 +1 @@
+export { delay } from './delay';

package/esm/promise/index.js

@@ -0,0 +1 @@
+export { delay } from './delay.js';

package/function.d.ts

@@ -0,0 +1 @@
+export * from './dist/function';

package/math.d.ts

@@ -0,0 +1 @@
+export * from './dist/math';

package/object.d.ts

@@ -0,0 +1 @@
+export * from './dist/object';

package/package.json

@@ -1,75 +1,76 @@
 {
   "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.0.0-dev.24+7203b563",
+  "version": "1.0.2-canary.0",
   "workspaces": [
     "docs"
   ],
   "packageManager": "yarn@4.2.2",
   "exports": {
     ".": {
-      "import": "./esm/index.mjs",
+      "import": "./esm/index.js",
       "require": "./dist/index.js"
     },
     "./array": {
-      "import": "./esm/array/index.mjs",
+      "import": "./esm/array/index.js",
       "require": "./dist/array/index.js"
     },
     "./function": {
-      "import": "./esm/function/index.mjs",
+      "import": "./esm/function/index.js",
       "require": "./dist/function/index.js"
     },
     "./math": {
-      "import": "./esm/math/index.mjs",
+      "import": "./esm/math/index.js",
       "require": "./dist/math/index.js"
     },
     "./object": {
-      "import": "./esm/object/index.mjs",
+      "import": "./esm/object/index.js",
       "require": "./dist/object/index.js"
     },
     "./predicate": {
-      "import": "./esm/predicate/index.mjs",
+      "import": "./esm/predicate/index.js",
       "require": "./dist/predicate/index.js"
     },
     "./promise": {
-      "import": "./esm/promise/index.mjs",
+      "import": "./esm/promise/index.js",
       "require": "./dist/promise/index.js"
     },
     "./package.json": "./package.json"
   },
   "files": [
     "dist/**/*",
-    "esm/**/*"
+    "esm/**/*",
+    "*.d.ts"
   ],
   "publishConfig": {
     "access": "public",
     "exports": {
       ".": {
-        "import": "./esm/index.mjs",
+        "import": "./esm/index.js",
         "require": "./dist/index.js"
       },
       "./array": {
-        "import": "./esm/array/index.mjs",
+        "import": "./esm/array/index.js",
         "require": "./dist/array/index.js"
       },
       "./function": {
-        "import": "./esm/function/index.mjs",
+        "import": "./esm/function/index.js",
         "require": "./dist/function/index.js"
       },
       "./math": {
-        "import": "./esm/math/index.mjs",
+        "import": "./esm/math/index.js",
         "require": "./dist/math/index.js"
       },
       "./object": {
-        "import": "./esm/object/index.mjs",
+        "import": "./esm/object/index.js",
         "require": "./dist/object/index.js"
       },
       "./predicate": {
-        "import": "./esm/predicate/index.mjs",
+        "import": "./esm/predicate/index.js",
         "require": "./dist/predicate/index.js"
       },
       "./promise": {
-        "import": "./esm/promise/index.mjs",
+        "import": "./esm/promise/index.js",
         "require": "./dist/promise/index.js"
       },
       "./package.json": "./package.json"
@@ -102,7 +103,7 @@
   "sideEffects": false,
   "scripts": {
     "prepack": "yarn build",
-    "build": "rm -rf dist esm && tsc -p tsconfig.json --declaration --emitDeclarationOnly --declarationDir dist && rollup -c rollup.config.js",
+    "build": "rm -rf dist esm && tsc -p tsconfig.json --declaration --emitDeclarationOnly --declarationDir dist && tsc -p tsconfig.json --declaration --emitDeclarationOnly --declarationDir esm && rollup -c rollup.config.js && ./.scripts/postbuild.sh",
     "test": "vitest run --coverage --typecheck"
   }
 }

package/predicate.d.ts

@@ -0,0 +1 @@
+export * from './dist/predicate';

package/promise.d.ts

@@ -0,0 +1 @@
+export * from './dist/promise';

package/esm/array/index.mjs

@@ -1,30 +0,0 @@
-export { chunk } from './chunk.mjs';
-export { difference } from './difference.mjs';
-export { differenceBy } from './differenceBy.mjs';
-export { differenceWith } from './differenceWith.mjs';
-export { drop } from './drop.mjs';
-export { dropRight } from './dropRight.mjs';
-export { dropRightWhile } from './dropRightWhile.mjs';
-export { dropWhile } from './dropWhile.mjs';
-export { groupBy } from './groupBy.mjs';
-export { intersection } from './intersection.mjs';
-export { intersectionBy } from './intersectionBy.mjs';
-export { intersectionWith } from './intersectionWith.mjs';
-export { partition } from './partition.mjs';
-export { sample } from './sample.mjs';
-export { shuffle } from './shuffle.mjs';
-export { take } from './take.mjs';
-export { takeRight } from './takeRight.mjs';
-export { takeRightWhile } from './takeRightWhile.mjs';
-export { takeWhile } from './takeWhile.mjs';
-export { union } from './union.mjs';
-export { unionBy } from './unionBy.mjs';
-export { unionWith } from './unionWith.mjs';
-export { uniq } from './uniq.mjs';
-export { uniqBy } from './uniqBy.mjs';
-export { uniqWith } from './uniqWith.mjs';
-export { xor } from './xor.mjs';
-export { xorBy } from './xorBy.mjs';
-export { xorWith } from './xorWith.mjs';
-export { zip } from './zip.mjs';
-export { zipWith } from './zipWith.mjs';

package/esm/function/index.mjs

@@ -1,3 +0,0 @@
-export { debounce } from './debounce.mjs';
-export { once } from './once.mjs';
-export { throttle } from './throttle.mjs';

package/esm/index.mjs

@@ -1,45 +0,0 @@
-export { chunk } from './array/chunk.mjs';
-export { difference } from './array/difference.mjs';
-export { differenceBy } from './array/differenceBy.mjs';
-export { differenceWith } from './array/differenceWith.mjs';
-export { drop } from './array/drop.mjs';
-export { dropRight } from './array/dropRight.mjs';
-export { dropRightWhile } from './array/dropRightWhile.mjs';
-export { dropWhile } from './array/dropWhile.mjs';
-export { groupBy } from './array/groupBy.mjs';
-export { intersection } from './array/intersection.mjs';
-export { intersectionBy } from './array/intersectionBy.mjs';
-export { intersectionWith } from './array/intersectionWith.mjs';
-export { partition } from './array/partition.mjs';
-export { sample } from './array/sample.mjs';
-export { shuffle } from './array/shuffle.mjs';
-export { take } from './array/take.mjs';
-export { takeRight } from './array/takeRight.mjs';
-export { takeRightWhile } from './array/takeRightWhile.mjs';
-export { takeWhile } from './array/takeWhile.mjs';
-export { union } from './array/union.mjs';
-export { unionBy } from './array/unionBy.mjs';
-export { unionWith } from './array/unionWith.mjs';
-export { uniq } from './array/uniq.mjs';
-export { uniqBy } from './array/uniqBy.mjs';
-export { uniqWith } from './array/uniqWith.mjs';
-export { xor } from './array/xor.mjs';
-export { xorBy } from './array/xorBy.mjs';
-export { xorWith } from './array/xorWith.mjs';
-export { zip } from './array/zip.mjs';
-export { zipWith } from './array/zipWith.mjs';
-export { debounce } from './function/debounce.mjs';
-export { once } from './function/once.mjs';
-export { throttle } from './function/throttle.mjs';
-export { clamp } from './math/clamp.mjs';
-export { round } from './math/round.mjs';
-export { sum } from './math/sum.mjs';
-export { omit } from './object/omit.mjs';
-export { omitBy } from './object/omitBy.mjs';
-export { pick } from './object/pick.mjs';
-export { pickBy } from './object/pickBy.mjs';
-export { isNil } from './predicate/isNil.mjs';
-export { isNotNil } from './predicate/isNotNil.mjs';
-export { isNull } from './predicate/isNull.mjs';
-export { isUndefined } from './predicate/isUndefined.mjs';
-export { delay } from './promise/delay.mjs';

package/esm/math/index.mjs

@@ -1,3 +0,0 @@
-export { clamp } from './clamp.mjs';
-export { round } from './round.mjs';
-export { sum } from './sum.mjs';

package/esm/object/index.mjs

@@ -1,4 +0,0 @@
-export { omit } from './omit.mjs';
-export { omitBy } from './omitBy.mjs';
-export { pick } from './pick.mjs';
-export { pickBy } from './pickBy.mjs';

package/esm/predicate/index.mjs

@@ -1,4 +0,0 @@
-export { isNil } from './isNil.mjs';
-export { isNotNil } from './isNotNil.mjs';
-export { isNull } from './isNull.mjs';
-export { isUndefined } from './isUndefined.mjs';

package/esm/promise/index.mjs

@@ -1 +0,0 @@
-export { delay } from './delay.mjs';