@thi.ng/checks 3.3.13 → 3.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-05-11T12:16:33Z
+- **Last updated**: 2023-08-04T10:58:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [3.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/checks@3.4.0) (2023-08-04)
+
+#### 🚀 Features
+
+- add isGenerator() ([af8ffb3](https://github.com/thi-ng/umbrella/commit/af8ffb3))
+
 ### [3.3.5](https://github.com/thi-ng/umbrella/tree/@thi.ng/checks@3.3.5) (2022-12-16)
 
 #### ♻️ Refactoring

package/README.md

@@ -47,7 +47,7 @@ For Node.js REPL:
 const checks = await import("@thi.ng/checks");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.59 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.60 KB
 
 ## Dependencies
 

package/index.d.ts

@@ -26,6 +26,7 @@ export * from "./is-file.js";
 export * from "./is-firefox.js";
 export * from "./is-float-string.js";
 export * from "./is-function.js";
+export * from "./is-generator.js";
 export * from "./is-hex.js";
 export * from "./is-hex-color.js";
 export * from "./is-ie.js";

package/index.js

@@ -26,6 +26,7 @@ export * from "./is-file.js";
 export * from "./is-firefox.js";
 export * from "./is-float-string.js";
 export * from "./is-function.js";
+export * from "./is-generator.js";
 export * from "./is-hex.js";
 export * from "./is-hex-color.js";
 export * from "./is-ie.js";

package/is-generator.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns true if `x` is an instantiated ES6 generator (i.e. it
+ * {@link isIterable} and {@link implementsFunction} `next`).
+ *
+ * @param x
+ */
+export declare const isGenerator: (x: any) => x is Generator<unknown, any, unknown>;
+//# sourceMappingURL=is-generator.d.ts.map

package/is-generator.js

@@ -0,0 +1,9 @@
+import { implementsFunction } from "./implements-function.js";
+import { isIterable } from "./is-iterable.js";
+/**
+ * Returns true if `x` is an instantiated ES6 generator (i.e. it
+ * {@link isIterable} and {@link implementsFunction} `next`).
+ *
+ * @param x
+ */
+export const isGenerator = (x) => isIterable(x) && implementsFunction(x, "next");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/checks",
-  "version": "3.3.13",
+  "version": "3.4.0",
   "description": "Collection of 70+ type, feature & value checks",
   "type": "module",
   "module": "./index.js",
@@ -38,16 +38,16 @@
     "test": "testament test"
   },
   "dependencies": {
-    "tslib": "^2.5.0"
+    "tslib": "^2.6.1"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.34.8",
-    "@thi.ng/testament": "^0.3.16",
-    "@types/node": "^20.1.0",
-    "rimraf": "^5.0.0",
+    "@microsoft/api-extractor": "^7.36.3",
+    "@thi.ng/testament": "^0.3.18",
+    "@types/node": "^20.4.6",
+    "rimraf": "^5.0.1",
     "tools": "^0.0.1",
-    "typedoc": "^0.24.6",
-    "typescript": "^5.0.4"
+    "typedoc": "^0.24.8",
+    "typescript": "^5.1.6"
   },
   "keywords": [
     "detect",
@@ -158,6 +158,9 @@
     "./is-function": {
       "default": "./is-function.js"
     },
+    "./is-generator": {
+      "default": "./is-generator.js"
+    },
     "./is-hex-color": {
       "default": "./is-hex-color.js"
     },
@@ -276,5 +279,5 @@
       "default": "./is-zero.js"
     }
   },
-  "gitHead": "20ab11b687a13228f6a8cecdc5f05ba9105122ea\n"
+  "gitHead": "9fa3f7f8169efa30e3c71b43c82f77393581c3b5\n"
 }