@xylabs/typeof 4.3.4 → 4.3.6

package/dist/neutral/ObjectTypeShape.d.ts

@@ -0,0 +1,3 @@
+export type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'symbol' | 'undefined' | 'null' | 'array' | 'function';
+export type ObjectTypeShape = Record<string | number | symbol, FieldType>;
+//# sourceMappingURL=ObjectTypeShape.d.ts.map

package/dist/neutral/ObjectTypeShape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectTypeShape.d.ts","sourceRoot":"","sources":["../../src/ObjectTypeShape.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CAAA;AAE1H,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,SAAS,CAAC,CAAA"}

package/dist/neutral/index.d.ts

@@ -1,5 +1,7 @@
 export * from './ifDefined.ts';
 export * from './ifTypeOf.ts';
+export * from './isType.ts';
+export * from './ObjectTypeShape.ts';
 export * from './typeOf.ts';
 export * from './TypeOfTypes.ts';
 export * from './validateType.ts';

package/dist/neutral/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA"}

package/dist/neutral/index.mjs

@@ -26,6 +26,31 @@ var ifTypeOf = (typeName, value, trueFunc, isFunc) => {
   }
 };
 
+// src/isType.ts
+var isType = (value, expectedType) => {
+  const typeofValue = typeof value;
+  switch (expectedType) {
+    case "array": {
+      return Array.isArray(value);
+    }
+    case "null": {
+      return value === null;
+    }
+    case "undefined": {
+      return value === void 0;
+    }
+    case "object": {
+      if (value === null) {
+        return false;
+      }
+      return typeofValue === "object" && !Array.isArray(value);
+    }
+    default: {
+      return typeofValue === expectedType;
+    }
+  }
+};
+
 // src/validateType.ts
 var validateType = (typeName, value, optional = false) => {
   switch (typeOf(value)) {
@@ -43,6 +68,7 @@ var validateType = (typeName, value, optional = false) => {
 export {
   ifDefined,
   ifTypeOf,
+  isType,
   typeOf,
   validateType
 };

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/typeOf.ts","../../src/ifDefined.ts","../../src/ifTypeOf.ts","../../src/validateType.ts"],"sourcesContent":["import type { TypeOfTypes } from './TypeOfTypes.ts'\n\nexport const typeOf = <T>(item: T): TypeOfTypes => {\n  return Array.isArray(item) ? 'array' : typeof item\n}\n","import { typeOf } from './typeOf.ts'\n\nexport const ifDefined = <T>(value: T, func: (value: T) => void) => {\n  switch (typeOf(value)) {\n    case 'undefined':\n    case 'null': {\n      break\n    }\n    default: {\n      func(value)\n      return value\n    }\n  }\n}\n","import { typeOf } from './typeOf.ts'\nimport type { TypeOfTypes } from './TypeOfTypes.ts'\n\nexport const ifTypeOf = <T, R>(typeName: TypeOfTypes, value: unknown, trueFunc: (value: T) => R, isFunc?: (value: T) => boolean) => {\n  switch (typeOf(value)) {\n    case typeName: {\n      return !isFunc || isFunc(value as T) ? trueFunc(value as T) : undefined\n    }\n  }\n}\n","import { typeOf } from './typeOf.ts'\nimport type { TypeOfTypes } from './TypeOfTypes.ts'\n\nexport const validateType = <T>(typeName: TypeOfTypes, value: T, optional = false): [T | undefined, Error[]] => {\n  switch (typeOf(value)) {\n    case typeName: {\n      return [value, []]\n    }\n    default: {\n      if (optional && typeOf(value) === 'undefined') {\n        return [value, []]\n      }\n      return [undefined, [new Error(`value type is not '${typeName}:${typeof value}'`)]]\n    }\n  }\n}\n"],"mappings":";AAEO,IAAM,SAAS,CAAI,SAAyB;AACjD,SAAO,MAAM,QAAQ,IAAI,IAAI,UAAU,OAAO;AAChD;;;ACFO,IAAM,YAAY,CAAI,OAAU,SAA6B;AAClE,UAAQ,OAAO,KAAK,GAAG;AAAA,IACrB,KAAK;AAAA,IACL,KAAK,QAAQ;AACX;AAAA,IACF;AAAA,IACA,SAAS;AACP,WAAK,KAAK;AACV,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACVO,IAAM,WAAW,CAAO,UAAuB,OAAgB,UAA2B,WAAmC;AAClI,UAAQ,OAAO,KAAK,GAAG;AAAA,IACrB,KAAK,UAAU;AACb,aAAO,CAAC,UAAU,OAAO,KAAU,IAAI,SAAS,KAAU,IAAI;AAAA,IAChE;AAAA,EACF;AACF;;;ACNO,IAAM,eAAe,CAAI,UAAuB,OAAU,WAAW,UAAoC;AAC9G,UAAQ,OAAO,KAAK,GAAG;AAAA,IACrB,KAAK,UAAU;AACb,aAAO,CAAC,OAAO,CAAC,CAAC;AAAA,IACnB;AAAA,IACA,SAAS;AACP,UAAI,YAAY,OAAO,KAAK,MAAM,aAAa;AAC7C,eAAO,CAAC,OAAO,CAAC,CAAC;AAAA,MACnB;AACA,aAAO,CAAC,QAAW,CAAC,IAAI,MAAM,sBAAsB,QAAQ,IAAI,OAAO,KAAK,GAAG,CAAC,CAAC;AAAA,IACnF;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/typeOf.ts","../../src/ifDefined.ts","../../src/ifTypeOf.ts","../../src/isType.ts","../../src/validateType.ts"],"sourcesContent":["import type { TypeOfTypes } from './TypeOfTypes.ts'\n\nexport const typeOf = <T>(item: T): TypeOfTypes => {\n  return Array.isArray(item) ? 'array' : typeof item\n}\n","import { typeOf } from './typeOf.ts'\n\nexport const ifDefined = <T>(value: T, func: (value: T) => void) => {\n  switch (typeOf(value)) {\n    case 'undefined':\n    case 'null': {\n      break\n    }\n    default: {\n      func(value)\n      return value\n    }\n  }\n}\n","import { typeOf } from './typeOf.ts'\nimport type { TypeOfTypes } from './TypeOfTypes.ts'\n\nexport const ifTypeOf = <T, R>(typeName: TypeOfTypes, value: unknown, trueFunc: (value: T) => R, isFunc?: (value: T) => boolean) => {\n  switch (typeOf(value)) {\n    case typeName: {\n      return !isFunc || isFunc(value as T) ? trueFunc(value as T) : undefined\n    }\n  }\n}\n","import type { FieldType } from './ObjectTypeShape.ts'\n\nexport const isType = (value: unknown, expectedType: FieldType) => {\n  const typeofValue = typeof value\n  switch (expectedType) {\n    case 'array': {\n      return Array.isArray(value)\n    }\n    case 'null': {\n      return value === null\n    }\n    case 'undefined': {\n      return value === undefined\n    }\n    case 'object': {\n      // nulls resolve to objects, so exclude them\n      if (value === null) {\n        return false\n      }\n      // arrays resolve to objects, so exclude them\n      return typeofValue === 'object' && !Array.isArray(value)\n    }\n    default: {\n      return typeofValue === expectedType\n    }\n  }\n}\n","import { typeOf } from './typeOf.ts'\nimport type { TypeOfTypes } from './TypeOfTypes.ts'\n\nexport const validateType = <T>(typeName: TypeOfTypes, value: T, optional = false): [T | undefined, Error[]] => {\n  switch (typeOf(value)) {\n    case typeName: {\n      return [value, []]\n    }\n    default: {\n      if (optional && typeOf(value) === 'undefined') {\n        return [value, []]\n      }\n      return [undefined, [new Error(`value type is not '${typeName}:${typeof value}'`)]]\n    }\n  }\n}\n"],"mappings":";AAEO,IAAM,SAAS,CAAI,SAAyB;AACjD,SAAO,MAAM,QAAQ,IAAI,IAAI,UAAU,OAAO;AAChD;;;ACFO,IAAM,YAAY,CAAI,OAAU,SAA6B;AAClE,UAAQ,OAAO,KAAK,GAAG;AAAA,IACrB,KAAK;AAAA,IACL,KAAK,QAAQ;AACX;AAAA,IACF;AAAA,IACA,SAAS;AACP,WAAK,KAAK;AACV,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACVO,IAAM,WAAW,CAAO,UAAuB,OAAgB,UAA2B,WAAmC;AAClI,UAAQ,OAAO,KAAK,GAAG;AAAA,IACrB,KAAK,UAAU;AACb,aAAO,CAAC,UAAU,OAAO,KAAU,IAAI,SAAS,KAAU,IAAI;AAAA,IAChE;AAAA,EACF;AACF;;;ACPO,IAAM,SAAS,CAAC,OAAgB,iBAA4B;AACjE,QAAM,cAAc,OAAO;AAC3B,UAAQ,cAAc;AAAA,IACpB,KAAK,SAAS;AACZ,aAAO,MAAM,QAAQ,KAAK;AAAA,IAC5B;AAAA,IACA,KAAK,QAAQ;AACX,aAAO,UAAU;AAAA,IACnB;AAAA,IACA,KAAK,aAAa;AAChB,aAAO,UAAU;AAAA,IACnB;AAAA,IACA,KAAK,UAAU;AAEb,UAAI,UAAU,MAAM;AAClB,eAAO;AAAA,MACT;AAEA,aAAO,gBAAgB,YAAY,CAAC,MAAM,QAAQ,KAAK;AAAA,IACzD;AAAA,IACA,SAAS;AACP,aAAO,gBAAgB;AAAA,IACzB;AAAA,EACF;AACF;;;ACvBO,IAAM,eAAe,CAAI,UAAuB,OAAU,WAAW,UAAoC;AAC9G,UAAQ,OAAO,KAAK,GAAG;AAAA,IACrB,KAAK,UAAU;AACb,aAAO,CAAC,OAAO,CAAC,CAAC;AAAA,IACnB;AAAA,IACA,SAAS;AACP,UAAI,YAAY,OAAO,KAAK,MAAM,aAAa;AAC7C,eAAO,CAAC,OAAO,CAAC,CAAC;AAAA,MACnB;AACA,aAAO,CAAC,QAAW,CAAC,IAAI,MAAM,sBAAsB,QAAQ,IAAI,OAAO,KAAK,GAAG,CAAC,CAAC;AAAA,IACnF;AAAA,EACF;AACF;","names":[]}

package/dist/neutral/isType.d.ts

@@ -0,0 +1,3 @@
+import type { FieldType } from './ObjectTypeShape.ts';
+export declare const isType: (value: unknown, expectedType: FieldType) => boolean;
+//# sourceMappingURL=isType.d.ts.map

package/dist/neutral/isType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isType.d.ts","sourceRoot":"","sources":["../../src/isType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,eAAO,MAAM,MAAM,UAAW,OAAO,gBAAgB,SAAS,YAwB7D,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/typeof",
-  "version": "4.3.4",
+  "version": "4.3.6",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "typeof",
@@ -36,8 +36,8 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.3",
-    "@xylabs/tsconfig": "^4.2.3",
+    "@xylabs/ts-scripts-yarn3": "^4.2.4",
+    "@xylabs/tsconfig": "^4.2.4",
     "typescript": "^5.6.3"
   },
   "engines": {

package/src/ObjectTypeShape.ts

@@ -0,0 +1,3 @@
+export type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'symbol' | 'undefined' | 'null' | 'array' | 'function'
+
+export type ObjectTypeShape = Record<string | number | symbol, FieldType>

package/src/index.ts

@@ -1,5 +1,7 @@
 export * from './ifDefined.ts'
 export * from './ifTypeOf.ts'
+export * from './isType.ts'
+export * from './ObjectTypeShape.ts'
 export * from './typeOf.ts'
 export * from './TypeOfTypes.ts'
 export * from './validateType.ts'

package/src/isType.ts

@@ -0,0 +1,27 @@
+import type { FieldType } from './ObjectTypeShape.ts'
+
+export const isType = (value: unknown, expectedType: FieldType) => {
+  const typeofValue = typeof value
+  switch (expectedType) {
+    case 'array': {
+      return Array.isArray(value)
+    }
+    case 'null': {
+      return value === null
+    }
+    case 'undefined': {
+      return value === undefined
+    }
+    case 'object': {
+      // nulls resolve to objects, so exclude them
+      if (value === null) {
+        return false
+      }
+      // arrays resolve to objects, so exclude them
+      return typeofValue === 'object' && !Array.isArray(value)
+    }
+    default: {
+      return typeofValue === expectedType
+    }
+  }
+}

package/typedoc.json

@@ -1,5 +1,4 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
+  "entryPoints": ["./src/index.ts"]
 }