es-toolkit 0.0.1-dev.20

package/esm/object/omitBy.mjs

@@ -0,0 +1,35 @@
+import { slicedToArray as _slicedToArray } from './_virtual/_rollupPluginBabelHelpers.mjs';
+
+/**
+ * Creates a new object composed of the properties that do not 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 false.
+ *
+ * @param {T} obj - The object to omit properties from.
+ * @param {(value: T[string], key: string) => boolean} shouldOmit - A predicate function that determines 
+ * whether a property should be omitted. It takes the property's key and value as arguments and returns `true` 
+ * if the property should be omitted, and `false` otherwise.
+ * @returns {Partial<T>} A new object with the properties that do not satisfy the predicate function.
+ *
+ * @example
+ * const obj = { a: 1, b: 'omit', c: 3 };
+ * const shouldOmit = (key, value) => typeof value === 'string';
+ * const result = omitBy(obj, shouldOmit);
+ * // result will be { a: 1, c: 3 }
+ */
+function omitBy(obj, shouldOmit) {
+  var result = {};
+  for (var _i = 0, _Object$entries = Object.entries(obj); _i < _Object$entries.length; _i++) {
+    var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+      key = _Object$entries$_i[0],
+      value = _Object$entries$_i[1];
+    if (shouldOmit(value, key)) {
+      continue;
+    }
+    result[key] = value;
+  }
+  return result;
+}
+
+export { omitBy };

package/esm/object/pick.mjs

@@ -0,0 +1,35 @@
+import { createForOfIteratorHelper as _createForOfIteratorHelper } from './_virtual/_rollupPluginBabelHelpers.mjs';
+
+/**
+ * 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 }
+ */
+function pick(obj, keys) {
+  var result = {};
+  var _iterator = _createForOfIteratorHelper(keys),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var key = _step.value;
+      result[key] = obj[key];
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return result;
+}
+
+export { pick };

package/esm/object/pickBy.mjs

@@ -0,0 +1,35 @@
+import { slicedToArray as _slicedToArray } from './_virtual/_rollupPluginBabelHelpers.mjs';
+
+/**
+ * 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' }
+ */
+function pickBy(obj, shouldPick) {
+  var result = {};
+  for (var _i = 0, _Object$entries = Object.entries(obj); _i < _Object$entries.length; _i++) {
+    var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+      key = _Object$entries$_i[0],
+      value = _Object$entries$_i[1];
+    if (!shouldPick(value, key)) {
+      continue;
+    }
+    result[key] = value;
+  }
+  return result;
+}
+
+export { pickBy };

package/esm/predicate/index.mjs

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

package/esm/predicate/isNil.mjs

@@ -0,0 +1,24 @@
+/**
+ * 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
+ */
+function isNil(x) {
+  return x == null || x == undefined;
+}
+
+export { isNil };

package/esm/predicate/isNotNil.mjs

@@ -0,0 +1,20 @@
+/**
+ * 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]
+ */
+function isNotNil(x) {
+  return x != null && x != undefined;
+}
+
+export { isNotNil };

package/esm/predicate/isNull.mjs

@@ -0,0 +1,25 @@
+/**
+ * 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
+ */
+function isNull(x) {
+  return x === null;
+}
+
+export { isNull };

package/esm/predicate/isUndefined.mjs

@@ -0,0 +1,25 @@
+/**
+ * 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
+ */
+function isUndefined(x) {
+  return x === undefined;
+}
+
+export { isUndefined };

package/esm/promise/delay.mjs

@@ -0,0 +1,25 @@
+/**
+ * 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();
+ */
+function delay(ms) {
+  return new Promise(function (resolve) {
+    setTimeout(resolve, ms);
+  });
+}
+
+export { delay };

package/esm/promise/index.mjs

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

package/package.json

@@ -0,0 +1,108 @@
+{
+  "name": "es-toolkit",
+  "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
+  "version": "0.0.1-dev.20+0e8c4504",
+  "workspaces": [
+    "docs"
+  ],
+  "packageManager": "yarn@4.2.2",
+  "exports": {
+    ".": {
+      "import": "./esm/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./array": {
+      "import": "./esm/array/index.mjs",
+      "require": "./dist/array/index.js"
+    },
+    "./function": {
+      "import": "./esm/function/index.mjs",
+      "require": "./dist/function/index.js"
+    },
+    "./math": {
+      "import": "./esm/math/index.mjs",
+      "require": "./dist/math/index.js"
+    },
+    "./object": {
+      "import": "./esm/object/index.mjs",
+      "require": "./dist/object/index.js"
+    },
+    "./predicate": {
+      "import": "./esm/predicate/index.mjs",
+      "require": "./dist/predicate/index.js"
+    },
+    "./promise": {
+      "import": "./esm/promise/index.mjs",
+      "require": "./dist/promise/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/**/*",
+    "esm/**/*"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": {
+        "import": "./esm/index.mjs",
+        "require": "./dist/index.js"
+      },
+      "./array": {
+        "import": "./esm/array/index.mjs",
+        "require": "./dist/array/index.js"
+      },
+      "./function": {
+        "import": "./esm/function/index.mjs",
+        "require": "./dist/function/index.js"
+      },
+      "./math": {
+        "import": "./esm/math/index.mjs",
+        "require": "./dist/math/index.js"
+      },
+      "./object": {
+        "import": "./esm/object/index.mjs",
+        "require": "./dist/object/index.js"
+      },
+      "./predicate": {
+        "import": "./esm/predicate/index.mjs",
+        "require": "./dist/predicate/index.js"
+      },
+      "./promise": {
+        "import": "./esm/promise/index.mjs",
+        "require": "./dist/promise/index.js"
+      },
+      "./package.json": "./package.json"
+    }
+  },
+  "devDependencies": {
+    "@babel/core": "^7.24.5",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.1",
+    "@toss/rollup-config": "0.2.0-canary.0",
+    "@types/babel__core": "^7",
+    "@types/babel__preset-env": "^7",
+    "@types/broken-link-checker": "^0",
+    "@types/lodash": "^4",
+    "@types/node": "^20.12.11",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "@vitest/coverage-istanbul": "^1.5.2",
+    "broken-link-checker": "^0.7.8",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^8.5.0",
+    "lodash": "^4.17.21",
+    "prettier": "^3.2.5",
+    "rollup": "^2.78.0",
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.2"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "prepack": "yarn build",
+    "build": "rm -rf dist esm && tsc -p tsconfig.json --declaration --emitDeclarationOnly --declarationDir dist && rollup -c rollup.config.js",
+    "test": "vitest run --coverage --typecheck"
+  }
+}