@hypernym/utils 2.3.0 → 3.0.1

package/README.md

@@ -1,11 +1,11 @@
-# Utils
+# @hypernym/utils
 
 A collection of reusable utilities.
 
 <sub><a href="https://github.com/hypernym-studio/utils">Repository</a> | <a href="https://www.npmjs.com/package/@hypernym/utils">Package</a> | <a href="https://github.com/hypernym-studio/utils/releases">Releases</a> | <a href="https://github.com/hypernym-studio/utils/discussions">Discussions</a></sub>
 
 ```sh
-npm i @hypernym/utils
+pnpm add @hypernym/utils
 ```
 
 ## Features
@@ -30,14 +30,8 @@ Feel free to ask questions or share new ideas.
 
 Use the official [discussions](https://github.com/hypernym-studio/utils/discussions) to get involved.
 
-## Contributing
-
-Check out the [guide](.github/CONTRIBUTING.md) for more info.
-
 ## License
 
-Developed in 🇭🇷 Croatia.
+Developed in 🇭🇷 Croatia, © Hypernym Studio.
 
 Released under the [MIT](LICENSE.txt) license.
-
-© Hypernym Studio

package/dist/index.mjs

@@ -24,11 +24,11 @@ const isSet = (v) => v instanceof Set;
 const isWeakSet = (v) => v instanceof WeakSet;
 const isSymbol = (v) => toString(v) === "Symbol";
 const isDate = (v) => v instanceof Date && !isNaN(v.valueOf());
-const isBigint = (v) => typeof v === "bigint";
+const isBigInt = (v) => typeof v === "bigint";
 const isInfinity = (v) => v === Infinity || v === -Infinity;
 const isURL = (v) => v instanceof URL;
 const isError = (v) => v instanceof Error;
-const isPrimitive = (v) => isString(v) || isNumber(v) || isBigint(v) || isBoolean(v) || isSymbol(v) || isNull(v) || isUndefined(v);
+const isPrimitive = (v) => isString(v) || isNumber(v) || isBigInt(v) || isBoolean(v) || isSymbol(v) || isNull(v) || isUndefined(v);
 const isElement = (v) => v instanceof Element;
 const isHtmlElement = (v) => v instanceof HTMLElement;
 const isSvgElement = (v) => v instanceof SVGElement;
@@ -37,4 +37,4 @@ const isNodeListEmpty = (v) => isNodeList(v) && v.length === 0;
 const isHtmlCollection = (v) => v instanceof HTMLCollection;
 const isHtmlCollectionEmpty = (v) => isHtmlCollection(v) && v.length === 0;
 
-export { isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFalse, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isHtmlElement, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSvgElement, isSymbol, isTrue, isURL, isUndefined, isWeakMap, isWeakSet, noop, toString };
+export { isArray, isArrayEmpty, isBigInt, isBoolean, isBrowser, isDate, isElement, isError, isFalse, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isHtmlElement, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSvgElement, isSymbol, isTrue, isURL, isUndefined, isWeakMap, isWeakSet, noop, toString };

package/dist/types/fs/index.d.ts

@@ -6,13 +6,9 @@ import { writeFile as writeFile$1 } from 'node:fs/promises';
  * @example
  *
  * ```ts
- * // New import
  * import { exists } from '@hypernym/utils/fs'
- * ```
  *
- * ```ts
- * // Deprecated import
- * import { exists } from '@hypernym/utils/node'
+ * exists('dir/file.ts') // => true
  * ```
  */
 declare function exists(path: string): Promise<boolean>;
@@ -24,6 +20,8 @@ declare function exists(path: string): Promise<boolean>;
  *
  * ```ts
  * import { writeFile } from '@hypernym/utils/fs'
+ *
+ * writeFile('dir/subdir/file.ts', `console.log('Hello World!')`)
  * ```
  */
 declare function writeFile(path: string, data: Parameters<typeof writeFile$1>[1], options?: Parameters<typeof writeFile$1>[2]): Promise<void>;

package/dist/types/index.d.ts

@@ -1,9 +1,25 @@
 /**
  * An empty arrow function that performs no operation.
+ *
+ * @example
+ *
+ * ```ts
+ * import { noop } from '@hypernym/utils'
+ *
+ * noop()
+ * ```
  */
 declare const noop: () => void;
 /**
  * Returns a string representing the object.
+ *
+ * @example
+ *
+ * ```ts
+ * import { toString } from '@hypernym/utils'
+ *
+ * toString({}) // => 'Object'
+ * ```
  */
 declare const toString: (v: any) => string;
 
@@ -18,138 +34,408 @@ type BuiltIn = Primitive | Date | RegExp;
 
 /**
  * Checks if the code is running in the browser.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isBrowser } from '@hypernym/utils'
+ *
+ * isBrowser // true
+ * ```
  */
 declare const isBrowser: boolean;
 /**
  * Returns a boolean if the given value is a `null`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isNull } from '@hypernym/utils'
+ *
+ * isNull(null) // => true
+ * ```
  */
 declare const isNull: (v: any) => v is null;
 /**
  * Returns a boolean if the given value is a `undefined`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isUndefined } from '@hypernym/utils'
+ *
+ * isUndefined(undefined) // => true
+ * ```
  */
 declare const isUndefined: (v: any) => v is undefined;
 /**
  * Returns a boolean if the given value is a `string`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isString } from '@hypernym/utils'
+ *
+ * isString('@hypernym/utils') // => true
+ * ```
  */
 declare const isString: (v: any) => v is string;
 /**
  * Returns a boolean if the given value is an empty `string`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isStringEmpty } from '@hypernym/utils'
+ *
+ * isStringEmpty('') // => true
+ * ```
  */
 declare const isStringEmpty: (v: any) => v is string;
 /**
  * Returns a boolean if the given value is a `boolean`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isBoolean } from '@hypernym/utils'
+ *
+ * isBoolean(true) // => true
+ * ```
  */
 declare const isBoolean: (v: any) => v is boolean;
 /**
  * Returns a boolean if the given value is a `true`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isTrue } from '@hypernym/utils'
+ *
+ * isTrue(true) // => true
+ * ```
  */
 declare const isTrue: (v: any) => v is true;
 /**
  * Returns a boolean if the given value is a `false`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isFalse } from '@hypernym/utils'
+ *
+ * isFalse(false) // => true
+ * ```
  */
 declare const isFalse: (v: any) => v is false;
 /**
  * Returns a boolean if the given value is a `number`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isNumber } from '@hypernym/utils'
+ *
+ * isNumber(33) // => true
+ * ```
  */
 declare const isNumber: (v: any) => v is number;
 /**
  * Returns a boolean if the given value is a `array`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isArray } from '@hypernym/utils'
+ *
+ * isArray([]) // => true
+ * ```
  */
 declare const isArray: (v: any) => v is any[];
 /**
  * Returns a boolean if the given value is an empty `array`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isArrayEmpty } from '@hypernym/utils'
+ *
+ * isArrayEmpty([]) // => true
+ * ```
  */
 declare const isArrayEmpty: (v: any) => v is any[];
 /**
  * Returns a boolean if the given value is a `object`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isObject } from '@hypernym/utils'
+ *
+ * isObject({}) // => true
+ * ```
  */
 declare const isObject: (v: any) => v is object;
 /**
  * Returns a boolean if the given value is an empty `object`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isObjectEmpty } from '@hypernym/utils'
+ *
+ * isObjectEmpty({}) // => true
+ * ```
  */
 declare const isObjectEmpty: (v: any) => v is object;
 /**
  * Returns a boolean if the given value is a `Function`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isFunction } from '@hypernym/utils'
+ *
+ * isFunction(() => {}) // => true
+ * ```
  */
 declare const isFunction: (v: any) => v is (...args: any[]) => unknown;
 /**
  * Returns a boolean if the given value is a `NaN`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isNaNValue } from '@hypernym/utils'
+ *
+ * isNaNValue(NaN) // => true
+ * ```
  */
-declare const isNaNValue: (v: any) => v is number;
+declare const isNaNValue: (v: any) => v is typeof NaN;
 /**
  * Returns a boolean if the given value is a `RegExp`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isRegExp } from '@hypernym/utils'
+ *
+ * isRegExp(/^hypernym/) // => true
+ * ```
  */
 declare const isRegExp: (v: any) => v is RegExp;
 /**
  * Returns a boolean if the given value is a `Map`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isMap } from '@hypernym/utils'
+ *
+ * isMap(new Map()) // => true
+ * ```
  */
 declare const isMap: (v: any) => v is Map<any, any>;
 /**
  * Returns a boolean if the given value is a `WeakMap`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isWeakMap } from '@hypernym/utils'
+ *
+ * isWeakMap(new WeakMap()) // => true
+ * ```
  */
 declare const isWeakMap: (v: any) => v is WeakMap<any, any>;
 /**
  * Returns a boolean if the given value is a `Set`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isSet } from '@hypernym/utils'
+ *
+ * isSet(new Set()) // => true
+ * ```
  */
 declare const isSet: (v: any) => v is Set<any>;
 /**
  * Returns a boolean if the given value is a `WeakSet`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isWeakSet } from '@hypernym/utils'
+ *
+ * isWeakSet(new WeakSet()) // => true
+ * ```
  */
 declare const isWeakSet: (v: any) => v is WeakSet<any>;
 /**
  * Returns a boolean if the given value is a `symbol`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isSymbol } from '@hypernym/utils'
+ *
+ * isSymbol(Symboly('hypernym')) // => true
+ * ```
  */
 declare const isSymbol: (v: any) => v is symbol;
 /**
  * Returns a boolean if the given value is a `Date`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isDate } from '@hypernym/utils'
+ *
+ * isDate(new Date()) // => true
+ * ```
  */
 declare const isDate: (v: any) => v is Date;
 /**
  * Returns a boolean if the given value is a `bigint`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isBigInt } from '@hypernym/utils'
+ *
+ * isBigInt(1n) // => true
+ * ```
  */
-declare const isBigint: (v: any) => v is bigint;
+declare const isBigInt: (v: any) => v is bigint;
 /**
  * Returns a boolean if the given value is a `Infinity`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isInfinity } from '@hypernym/utils'
+ *
+ * isInfinity(Infinity) // => true
+ * ```
  */
 declare const isInfinity: (v: any) => v is number;
 /**
  * Returns a boolean if the given value is a `URL`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isURL } from '@hypernym/utils'
+ *
+ * isURL(new URL('https://localhost:3000')) // => true
+ * ```
  */
 declare const isURL: (v: any) => v is URL;
 /**
  * Returns a boolean if the given value is a `Error`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isError } from '@hypernym/utils'
+ *
+ * isError(new Error()) // => true
+ * ```
  */
 declare const isError: (v: any) => v is Error;
 /**
  * Returns a boolean if the given value is a `Primitive`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isPrimitive } from '@hypernym/utils'
+ *
+ * isPrimitive(true) // => true
+ * ```
  */
 declare const isPrimitive: (v: any) => v is Primitive;
 /**
  * Returns a boolean if the given value is a `Element`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isElement } from '@hypernym/utils'
+ *
+ * isElement(el) // => true
+ * ```
  */
 declare const isElement: (v: any) => v is Element;
 /**
  * Returns a boolean if the given value is a `HTMLElement`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isHtmlElement } from '@hypernym/utils'
+ *
+ * isHtmlElement(htmlEl) // => true
+ * ```
  */
 declare const isHtmlElement: (v: any) => v is HTMLElement;
 /**
  * Returns a boolean if the given value is a `SVGElement`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isSvgElement } from '@hypernym/utils'
+ *
+ * isSvgElement(svgEl) // => true
+ * ```
  */
 declare const isSvgElement: (v: any) => v is SVGElement;
 /**
  * Returns a boolean if the given value is a `NodeList`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isNodeList } from '@hypernym/utils'
+ *
+ * isNodeList(document.querySelectorAll('div')) // => true
+ * ```
  */
 declare const isNodeList: (v: any) => v is NodeList;
 /**
  * Returns a boolean if the given value is an empty `NodeList`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isNodeListEmpty } from '@hypernym/utils'
+ *
+ * isNodeListEmpty(document.querySelectorAll('divs')) // => true
+ * ```
  */
 declare const isNodeListEmpty: (v: any) => v is NodeList;
 /**
  * Returns a boolean if the given value is a `HTMLCollection`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { isHtmlCollection } from '@hypernym/utils'
+ *
+ * isHtmlCollection(document.getElementsByClassName('el')) // => true
+ * ```
  */
 declare const isHtmlCollection: (v: any) => v is HTMLCollection;
 /**
  * Returns a boolean if the given value is an empty `HTMLCollection`.
+ *
+ * ```ts
+ * import { isHtmlCollectionEmpty } from '@hypernym/utils'
+ *
+ * isHtmlCollectionEmpty(document.getElementsByClassName('els')) // => true
+ * ```
  */
 declare const isHtmlCollectionEmpty: (v: any) => v is HTMLCollection;
 
@@ -210,4 +496,4 @@ type RequiredObjectDeep<T extends object, Options extends RequiredOptions = {
     [K in keyof T]-?: RequiredDeep<T[K], Options>;
 };
 
-export { type BuiltIn, type IsAny, type IsNever, type IsNull, type PartialDeep, type Primitive, type RequiredDeep, isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFalse, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isHtmlElement, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSvgElement, isSymbol, isTrue, isURL, isUndefined, isWeakMap, isWeakSet, noop, toString };
+export { type BuiltIn, type IsAny, type IsNever, type IsNull, type PartialDeep, type Primitive, type RequiredDeep, isArray, isArrayEmpty, isBigInt, isBoolean, isBrowser, isDate, isElement, isError, isFalse, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isHtmlElement, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSvgElement, isSymbol, isTrue, isURL, isUndefined, isWeakMap, isWeakSet, noop, toString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypernym/utils",
-  "version": "2.3.0",
+  "version": "3.0.1",
   "author": "Hypernym Studio",
   "description": "A collection of reusable utilities.",
   "license": "MIT",
@@ -16,10 +16,6 @@
     "./fs": {
       "types": "./dist/types/fs/index.d.ts",
       "import": "./dist/fs/index.mjs"
-    },
-    "./node": {
-      "types": "./dist/types/fs/index.d.ts",
-      "import": "./dist/fs/index.mjs"
     }
   },
   "files": [
@@ -40,17 +36,19 @@
   ],
   "scripts": {
     "dev:browser": "vite playgrounds/browser",
-    "dev:node": "vite-node -w playgrounds/node/main.ts",
+    "dev:server": "bun --watch playgrounds/server/main.ts",
     "build": "hyperbundler",
-    "test:types": "vitest -c .config/vitest.config.ts --typecheck.only",
-    "lint": "ESLINT_USE_FLAT_CONFIG=true eslint -c .config/eslint.config.js .",
-    "lint:fix": "ESLINT_USE_FLAT_CONFIG=true eslint -c .config/eslint.config.js --fix .",
-    "format": "prettier --config .config/prettier.config.js --write .",
+    "test:types": "vitest --typecheck.only",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "format": "prettier --write .",
     "prepublishOnly": "npm run build"
   },
   "sideEffects": false,
+  "packageManager": "pnpm@9.9.0",
   "engines": {
-    "node": ">=v18.0.0"
+    "node": ">=20.0.0",
+    "pnpm": ">=9.0.0"
   },
   "peerDependencies": {
     "@types/node": ">=20.0.0",
@@ -65,14 +63,14 @@
     }
   },
   "devDependencies": {
-    "@hypernym/bundler": "^0.6.3",
-    "@hypernym/eslint-config": "^2.0.3",
-    "@hypernym/prettier-config": "^2.0.3",
-    "@hypernym/tsconfig": "^1.1.0",
-    "@types/node": "^20.10.6",
-    "eslint": "^8.56.0",
-    "prettier": "^3.1.1",
-    "typescript": "^5.3.3",
-    "vitest": "^1.1.3"
+    "@hypernym/bundler": "^0.10.0",
+    "@hypernym/eslint-config": "^3.5.0",
+    "@hypernym/prettier-config": "^3.2.0",
+    "@hypernym/tsconfig": "^2.3.0",
+    "@types/node": "^20.16.5",
+    "eslint": "^9.10.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.5"
   }
 }