@hypernym/utils 2.1.0 → 2.3.0

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Ivo Dolenc, Hypernym Studio
+Copyright (c) 2024 Ivo Dolenc, Hypernym Studio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,4 @@
-# @hypernym/utils
+# Utils
 
 A collection of reusable utilities.
 
@@ -26,11 +26,17 @@ import type { IsAny, RequiredDeep, ... } from '@hypernym/utils'
 
 ## Community
 
-Feel free to use the official [discussions](https://github.com/hypernym-studio/utils/discussions) for any additional questions.
+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.
 
 Released under the [MIT](LICENSE.txt) license.
 

package/dist/index.mjs

@@ -8,6 +8,8 @@ const isUndefined = (v) => typeof v === "undefined";
 const isString = (v) => typeof v === "string";
 const isStringEmpty = (v) => isString(v) && v.trim().length === 0;
 const isBoolean = (v) => typeof v === "boolean";
+const isTrue = (v) => v === true;
+const isFalse = (v) => v === false;
 const isNumber = (v) => typeof v === "number" && !isNaN(v);
 const isArray = (v) => Array.isArray(v);
 const isArrayEmpty = (v) => isArray(v) && v.length === 0;
@@ -17,7 +19,9 @@ const isFunction = (v) => v instanceof Function;
 const isNaNValue = (v) => typeof v === "number" && isNaN(v);
 const isRegExp = (v) => v instanceof RegExp;
 const isMap = (v) => v instanceof Map;
+const isWeakMap = (v) => v instanceof WeakMap;
 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";
@@ -26,9 +30,11 @@ 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 isElement = (v) => v instanceof Element;
+const isHtmlElement = (v) => v instanceof HTMLElement;
+const isSvgElement = (v) => v instanceof SVGElement;
 const isNodeList = (v) => v instanceof NodeList;
 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, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, 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/index.d.ts

@@ -40,6 +40,14 @@ declare const isStringEmpty: (v: any) => v is string;
  * Returns a boolean if the given value is a `boolean`.
  */
 declare const isBoolean: (v: any) => v is boolean;
+/**
+ * Returns a boolean if the given value is a `true`.
+ */
+declare const isTrue: (v: any) => v is true;
+/**
+ * Returns a boolean if the given value is a `false`.
+ */
+declare const isFalse: (v: any) => v is false;
 /**
  * Returns a boolean if the given value is a `number`.
  */
@@ -73,13 +81,21 @@ declare const isNaNValue: (v: any) => v is number;
  */
 declare const isRegExp: (v: any) => v is RegExp;
 /**
- * Returns a boolean if the given value is a `map`.
+ * Returns a boolean if the given value is a `Map`.
  */
 declare const isMap: (v: any) => v is Map<any, any>;
 /**
- * Returns a boolean if the given value is a `set`.
+ * Returns a boolean if the given value is a `WeakMap`.
+ */
+declare const isWeakMap: (v: any) => v is WeakMap<any, any>;
+/**
+ * Returns a boolean if the given value is a `Set`.
  */
 declare const isSet: (v: any) => v is Set<any>;
+/**
+ * Returns a boolean if the given value is a `WeakSet`.
+ */
+declare const isWeakSet: (v: any) => v is WeakSet<any>;
 /**
  * Returns a boolean if the given value is a `symbol`.
  */
@@ -112,6 +128,14 @@ declare const isPrimitive: (v: any) => v is Primitive;
  * Returns a boolean if the given value is a `Element`.
  */
 declare const isElement: (v: any) => v is Element;
+/**
+ * Returns a boolean if the given value is a `HTMLElement`.
+ */
+declare const isHtmlElement: (v: any) => v is HTMLElement;
+/**
+ * Returns a boolean if the given value is a `SVGElement`.
+ */
+declare const isSvgElement: (v: any) => v is SVGElement;
 /**
  * Returns a boolean if the given value is a `NodeList`.
  */
@@ -186,4 +210,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, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, 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.1.0",
+  "version": "2.3.0",
   "author": "Hypernym Studio",
   "description": "A collection of reusable utilities.",
   "license": "MIT",
@@ -31,6 +31,7 @@
     "collection",
     "utilities",
     "helpers",
+    "shared",
     "utils",
     "types",
     "kit",
@@ -38,24 +39,40 @@
     "ts"
   ],
   "scripts": {
-    "dev": "vite playgrounds/client",
+    "dev:browser": "vite playgrounds/browser",
     "dev:node": "vite-node -w playgrounds/node/main.ts",
     "build": "hyperbundler",
-    "test:types": "vitest -c .config/vitest.config.ts typecheck",
+    "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 .",
     "prepublishOnly": "npm run build"
   },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=v18.0.0"
+  },
+  "peerDependencies": {
+    "@types/node": ">=20.0.0",
+    "typescript": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@types/node": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
   "devDependencies": {
-    "@hypernym/bundler": "^0.1.2",
-    "@hypernym/eslint-config": "^2.0.1",
-    "@hypernym/prettier-config": "^2.0.1",
+    "@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.8.4",
-    "eslint": "^8.51.0",
-    "prettier": "^3.0.3",
-    "typescript": "^5.2.2",
-    "vitest": "^0.34.6"
+    "@types/node": "^20.10.6",
+    "eslint": "^8.56.0",
+    "prettier": "^3.1.1",
+    "typescript": "^5.3.3",
+    "vitest": "^1.1.3"
   }
 }