is-what 5.1.0 → 5.2.0

package/README.md

@@ -51,6 +51,8 @@ isNull(null) // true
 isString('') // true
 isEmptyString('') // true
 isFullString('') // false
+isHexDecimal('60adf084f0fbdcab42de841e') // true
+isHexDecimal('60adf084f0fbdcab42de841e', 24) // check specific length of 24 (eg. MongoDB ObjectId)
 
 // numbers
 isNumber(0) // true
@@ -95,7 +97,16 @@ isPromise(new Promise((resolve) => {})) // true
 
 // primitives
 isPrimitive('') // true
-// true for any of: boolean, null, undefined, number, string, symbol
+//     true for any of: boolean, null, undefined, number, string, symbol
+
+// iterables
+isIterable([1, 2, 3]) // true
+isIterable('hello') // true
+isIterable(new Map()) // true
+isIterable(new Set()) // true
+isIterable(function* generator() {
+  yield 1
+}) // true
 ```
 
 ### Let's talk about NaN

package/dist/index.d.ts

@@ -15,6 +15,7 @@ export { isFullObject } from './isFullObject.js';
 export { isFullString } from './isFullString.js';
 export { isFunction } from './isFunction.js';
 export type { AnyFunction } from './isFunction.js';
+export { isHexDecimal } from './isHexDecimal.js';
 export { isInstanceOf } from './isInstanceOf.js';
 export { isIterable } from './isIterable.js';
 export { isMap } from './isMap.js';

package/dist/index.js

@@ -13,6 +13,7 @@ export { isFullArray } from './isFullArray.js';
 export { isFullObject } from './isFullObject.js';
 export { isFullString } from './isFullString.js';
 export { isFunction } from './isFunction.js';
+export { isHexDecimal } from './isHexDecimal.js';
 export { isInstanceOf } from './isInstanceOf.js';
 export { isIterable } from './isIterable.js';
 export { isMap } from './isMap.js';

package/dist/isHexDecimal.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Checks if a string is a valid hexadecimal string. If a length is provided, it also checks that
+ * the string has that length.
+ */
+export declare function isHexDecimal(payload: unknown, length?: number): payload is string;

package/dist/isHexDecimal.js

@@ -0,0 +1,12 @@
+import { isString } from './isString.js';
+/**
+ * Checks if a string is a valid hexadecimal string. If a length is provided, it also checks that
+ * the string has that length.
+ */
+export function isHexDecimal(payload, length) {
+    if (!isString(payload))
+        return false;
+    if (!/^[0-9a-fA-F]+$/.test(payload))
+        return false;
+    return length === undefined || payload.length === length;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "is-what",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "JS type check (TypeScript supported) functions like `isPlainObject() isArray()` etc. A simple & small integration.",
   "type": "module",
   "sideEffects": false,
@@ -16,10 +16,10 @@
     "lint": "tsc --noEmit && eslint ./src",
     "build": "del-cli dist && tsc",
     "build:docs": "typedoc",
-    "release": "npm run lint && npm run build && np"
+    "release": "npm run lint && npm run build && np --no-publish"
   },
   "devDependencies": {
-    "@cycraft/eslint": "^0.4.1",
+    "@cycraft/eslint": "^0.4.3",
     "@cycraft/tsconfig": "^0.1.2",
     "del-cli": "^6.0.0",
     "np": "^10.2.0",