@rhombus-toolkit/type-guards 1.1.0

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@rhombus-toolkit/type-guards",
+  "version": "1.1.0",
+  "description": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rhombus-toolkit/ts.git",
+    "directory": "libraries/type-guards"
+  },
+  "main": "lib/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "test": "heft test --clean",
+    "build": "heft build --clean",
+    "build:watch": "heft build"
+  },
+  "keywords": [],
+  "author": "Thomas Butler",
+  "dependencies": {
+    "@rhombus-toolkit/func": "1.1.0"
+  },
+  "devDependencies": {
+    "@rushstack/heft-web-rig": "^0.10.24",
+    
+    "@rushstack/heft": "^0.46.6"
+  }
+}

package/src/assert-never.ts

@@ -0,0 +1,3 @@
+export function assertNever(x: never): never {
+    throw new Error("Unexpected object: " + x);
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from './assert-never';
+export * from './is-array';
+export * from './is-defined';
+export * from './is-function';
+export * from './is-promise';
+export * from './is-url';
+export * from './iterables';

package/src/is-array.ts

@@ -0,0 +1,3 @@
+export function isArray(value: any): value is Array<any>{
+    return Array.isArray(value);
+}

package/src/is-defined.ts

@@ -0,0 +1,8 @@
+
+export function isDefined<T>(p: T | null | undefined): p is T {
+  return p !== undefined && p !== null;
+}
+
+export function isNotDefined<T>(p: T | null | undefined): p is undefined | null {
+    return p === undefined || p === null;
+  }

package/src/is-function.ts

@@ -0,0 +1,3 @@
+export function isFunction(value: any): value is (...args:any[])=>any {
+    return typeof (value) === 'function';
+}

package/src/is-promise.ts

@@ -0,0 +1,7 @@
+import { isFunction } from './is-function';
+
+export function isPromiseLike(value: any): value is PromiseLike<any> {
+  return value instanceof Promise
+    || /\bPromise\b/.test(Object.prototype.toString.call(value))
+    || 'then' in value && isFunction(value?.then);
+}

package/src/is-url.ts

@@ -0,0 +1,4 @@
+
+export function isUrl(url: any): url is URL {
+  return url instanceof URL;
+}

package/src/iterables/_isIterator.ts

@@ -0,0 +1,11 @@
+import { isFunction } from '../is-function';
+
+export function _isIterator(value: any): value is Iterator<any> {
+  if (value?.[Symbol.toStringTag]?.split(/\s+/)?.includes('Iterator'))
+    return true;
+
+  if (/\bIterator\b/.test(Object.prototype.toString.call(value)))
+    return true;
+
+  return isFunction(value?.next);
+}

package/src/iterables/index.ts

@@ -0,0 +1,6 @@
+export * from './is-async-generator';
+export * from './is-async-iterable';
+export * from './is-async-iterator';
+export * from './is-generator';
+export * from './is-iterable';
+export * from './is-iterator';

package/src/iterables/is-async-generator.ts

@@ -0,0 +1,10 @@
+import { isAsyncIterator } from "./is-async-iterator";
+
+const AsyncGeneratorFunction = (async function* () { }()).constructor as AsyncGeneratorFunction;
+export function isAsyncGenerator(value: any): value is AsyncGenerator<any, any, any> {
+  if (value?.constructor === AsyncGeneratorFunction)
+    return true;
+  if (/\bAsyncGenerator\b/.test(Object.prototype.toString.call(value)))
+    return true;
+  return isAsyncIterator(value) && value?.next?.length === 1;
+}

package/src/iterables/is-async-iterable.ts

@@ -0,0 +1,4 @@
+export function isAsyncIterable(value: any): value is AsyncIterable<any> {
+  return Symbol.asyncIterator in value;
+}
+

package/src/iterables/is-async-iterator.ts

@@ -0,0 +1,6 @@
+import { _isIterator } from './_isIterator';
+import { isAsyncIterable } from "./is-async-iterable";
+
+export function isAsyncIterator(value: any): value is AsyncIterableIterator<any> {
+  return isAsyncIterable(value) && _isIterator(value);
+}

package/src/iterables/is-generator.ts

@@ -0,0 +1,10 @@
+import { isIterator } from "./is-iterator";
+const GeneratorFunction = (function* () { }()).constructor as GeneratorFunction;
+
+export function isGenerator(value: any): value is Generator<any, any, any> {
+  if (value?.constructor === GeneratorFunction)
+    return true;
+  if (/\bGenerator\b/.test(Object.prototype.toString.call(value)))
+    return true;
+  return isIterator(value) && value?.next?.length === 1;
+}

package/src/iterables/is-iterable.ts

@@ -0,0 +1,3 @@
+export function isIterable(value: any): value is Iterable<any> {
+  return Symbol.iterator in value;
+}

package/src/iterables/is-iterator.ts

@@ -0,0 +1,6 @@
+import { isIterable } from './is-iterable';
+import { _isIterator } from './_isIterator';
+
+export function isIterator(value: any): value is IterableIterator<any> {
+  return isIterable(value) && _isIterator(value);
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@rushstack/heft-web-rig/profiles/library/tsconfig-base.json",
+"compilerOptions": { "target": "ESNext", "lib": ["ESNext", "DOM"] }
+}

package/type-guards.build.log

@@ -0,0 +1,21 @@
+Invoking: heft build --clean 
+Using local Heft from /home/tom/src/rhombus-toolkit/ts/libraries/type-guards/node_modules/@rushstack/heft
+
+Project build folder is "/home/tom/src/rhombus-toolkit/ts/libraries/type-guards"
+Using rig configuration from ./node_modules/@rushstack/heft-web-rig/profiles/library
+Starting build
+ ---- Clean started ---- 
+ ---- Clean finished (4ms) ---- 
+ ---- Pre-compile started ---- 
+ ---- Pre-compile finished (41ms) ---- 
+ ---- Compile started ---- 
+[typescript] Using TypeScript version 4.6.4
+ ---- Compile finished (9412ms) ---- 
+ ---- Bundle started ---- 
+ ---- Bundle finished (3ms) ---- 
+ ---- Post-build started ---- 
+ ---- Post-build finished (35ms) ---- 
+-------------------- Finished (11.261s) --------------------
+Project: @rhombus-toolkit/type-guards@1.1.0
+Heft version: 0.46.6
+Node version: v16.16.0