@xylabs/typeof 4.4.18 → 4.4.19

package/dist/neutral/Typed.d.ts

@@ -0,0 +1,12 @@
+export type TypedValue = bigint | string | number | boolean | null | TypedObject | TypedArray | Function | symbol | undefined;
+export type TypedKey<T extends string | void = void> = T extends string ? T : string | number | symbol;
+export type TypedObject = {
+    [key: TypedKey]: TypedValue;
+} | object;
+export type TypedArray = TypedValue[];
+export declare const isTypedKey: (value: unknown) => value is TypedKey;
+export declare const isTypedValue: (value: unknown) => value is TypedValue;
+export declare const isTypedArray: (value: unknown) => value is TypedArray;
+export declare const isValidTypedFieldPair: (pair: [key: unknown, value: unknown]) => pair is [key: TypedKey, value: TypedValue];
+export declare const isTypedObject: (value: unknown) => value is TypedObject;
+//# sourceMappingURL=Typed.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Typed.d.ts","sourceRoot":"","sources":["../../src/Typed.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;AAC7H,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;AACtG,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,QAAQ,GAAG,UAAU,CAAA;CAAE,GAAG,MAAM,CAAA;AAClE,MAAM,MAAM,UAAU,GAAG,UAAU,EAAE,CAAA;AAErC,eAAO,MAAM,UAAU,UAAW,OAAO,KAAG,KAAK,IAAI,QAYpD,CAAA;AAED,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,UAWtD,CAAA;AAED,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,UAEtD,CAAA;AAED,eAAO,MAAM,qBAAqB,SAAU,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAG,IAAI,IAAI,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,CAGrH,CAAA;AAED,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,KAAK,IAAI,WAMvD,CAAA"}

package/dist/neutral/index.d.ts

@@ -2,6 +2,7 @@ export * from './ifDefined.ts';
 export * from './ifTypeOf.ts';
 export * from './isType.ts';
 export * from './ObjectTypeShape.ts';
+export * from './Typed.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,sBAAsB,CAAA;AACpC,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,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA"}

package/dist/neutral/index.mjs

@@ -51,6 +51,43 @@ var isType = (value, expectedType) => {
   }
 };
 
+// src/Typed.ts
+var isTypedKey = (value) => {
+  switch (typeof value) {
+    case "string":
+    case "bigint":
+    case "number":
+    case "symbol": {
+      return true;
+    }
+    default: {
+      return false;
+    }
+  }
+};
+var isTypedValue = (value) => {
+  switch (typeof value) {
+    case "string":
+    case "number":
+    case "boolean": {
+      return true;
+    }
+    default: {
+      return value === null || isTypedObject(value) || isTypedArray(value);
+    }
+  }
+};
+var isTypedArray = (value) => {
+  return Array.isArray(value) && !value.some((item) => !isTypedValue(item));
+};
+var isValidTypedFieldPair = (pair) => {
+  const [key, value] = pair;
+  return isTypedKey(key) && isTypedValue(value);
+};
+var isTypedObject = (value) => {
+  return isType(value, "object") && !Object.entries(value).some((item) => !isValidTypedFieldPair(item));
+};
+
 // src/validateType.ts
 var validateType = (typeName, value, optional = false) => {
   switch (typeOf(value)) {
@@ -69,6 +106,11 @@ export {
   ifDefined,
   ifTypeOf,
   isType,
+  isTypedArray,
+  isTypedKey,
+  isTypedObject,
+  isTypedValue,
+  isValidTypedFieldPair,
   typeOf,
   validateType
 };

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"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":[]}
+{"version":3,"sources":["../../src/typeOf.ts","../../src/ifDefined.ts","../../src/ifTypeOf.ts","../../src/isType.ts","../../src/Typed.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 { isType } from './isType.ts'\n\n// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\nexport type TypedValue = bigint | string | number | boolean | null | TypedObject | TypedArray | Function | symbol | undefined\nexport type TypedKey<T extends string | void = void> = T extends string ? T : string | number | symbol\nexport type TypedObject = { [key: TypedKey]: TypedValue } | object\nexport type TypedArray = TypedValue[]\n\nexport const isTypedKey = (value: unknown): value is TypedKey => {\n  switch (typeof value) {\n    case 'string':\n    case 'bigint':\n    case 'number':\n    case 'symbol': {\n      return true\n    }\n    default: {\n      return false\n    }\n  }\n}\n\nexport const isTypedValue = (value: unknown): value is TypedValue => {\n  switch (typeof value) {\n    case 'string':\n    case 'number':\n    case 'boolean': {\n      return true\n    }\n    default: {\n      return value === null || isTypedObject(value) || isTypedArray(value)\n    }\n  }\n}\n\nexport const isTypedArray = (value: unknown): value is TypedArray => {\n  return Array.isArray(value) && !value.some(item => !isTypedValue(item))\n}\n\nexport const isValidTypedFieldPair = (pair: [key: unknown, value: unknown]): pair is [key: TypedKey, value: TypedValue] => {\n  const [key, value] = pair\n  return isTypedKey(key) && isTypedValue(value)\n}\n\nexport const isTypedObject = (value: unknown): value is TypedObject => {\n  return (\n    isType(value, 'object')\n    // check if all keys are strings\n    && !Object.entries(value as object).some(item => !isValidTypedFieldPair(item))\n  )\n}\n\n// Object Type Test\n/*\ninterface TestObject {\n  value: number\n}\n\nconst x: TestObject = { value: 1 }\n\nconst f = (p: TypedValue): void => {\n  console.log(p)\n}\n\nf(x)\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;;;AClBO,IAAM,aAAa,CAAC,UAAsC;AAC/D,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK,UAAU;AACb,aAAO;AAAA,IACT;AAAA,IACA,SAAS;AACP,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEO,IAAM,eAAe,CAAC,UAAwC;AACnE,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK,WAAW;AACd,aAAO;AAAA,IACT;AAAA,IACA,SAAS;AACP,aAAO,UAAU,QAAQ,cAAc,KAAK,KAAK,aAAa,KAAK;AAAA,IACrE;AAAA,EACF;AACF;AAEO,IAAM,eAAe,CAAC,UAAwC;AACnE,SAAO,MAAM,QAAQ,KAAK,KAAK,CAAC,MAAM,KAAK,UAAQ,CAAC,aAAa,IAAI,CAAC;AACxE;AAEO,IAAM,wBAAwB,CAAC,SAAqF;AACzH,QAAM,CAAC,KAAK,KAAK,IAAI;AACrB,SAAO,WAAW,GAAG,KAAK,aAAa,KAAK;AAC9C;AAEO,IAAM,gBAAgB,CAAC,UAAyC;AACrE,SACE,OAAO,OAAO,QAAQ,KAEnB,CAAC,OAAO,QAAQ,KAAe,EAAE,KAAK,UAAQ,CAAC,sBAAsB,IAAI,CAAC;AAEjF;;;AC/CO,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/typeof",
-  "version": "4.4.18",
+  "version": "4.4.19",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "typeof",

package/src/Typed.ts

@@ -0,0 +1,66 @@
+import { isType } from './isType.ts'
+
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+export type TypedValue = bigint | string | number | boolean | null | TypedObject | TypedArray | Function | symbol | undefined
+export type TypedKey<T extends string | void = void> = T extends string ? T : string | number | symbol
+export type TypedObject = { [key: TypedKey]: TypedValue } | object
+export type TypedArray = TypedValue[]
+
+export const isTypedKey = (value: unknown): value is TypedKey => {
+  switch (typeof value) {
+    case 'string':
+    case 'bigint':
+    case 'number':
+    case 'symbol': {
+      return true
+    }
+    default: {
+      return false
+    }
+  }
+}
+
+export const isTypedValue = (value: unknown): value is TypedValue => {
+  switch (typeof value) {
+    case 'string':
+    case 'number':
+    case 'boolean': {
+      return true
+    }
+    default: {
+      return value === null || isTypedObject(value) || isTypedArray(value)
+    }
+  }
+}
+
+export const isTypedArray = (value: unknown): value is TypedArray => {
+  return Array.isArray(value) && !value.some(item => !isTypedValue(item))
+}
+
+export const isValidTypedFieldPair = (pair: [key: unknown, value: unknown]): pair is [key: TypedKey, value: TypedValue] => {
+  const [key, value] = pair
+  return isTypedKey(key) && isTypedValue(value)
+}
+
+export const isTypedObject = (value: unknown): value is TypedObject => {
+  return (
+    isType(value, 'object')
+    // check if all keys are strings
+    && !Object.entries(value as object).some(item => !isValidTypedFieldPair(item))
+  )
+}
+
+// Object Type Test
+/*
+interface TestObject {
+  value: number
+}
+
+const x: TestObject = { value: 1 }
+
+const f = (p: TypedValue): void => {
+  console.log(p)
+}
+
+f(x)
+*/

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './ifDefined.ts'
 export * from './ifTypeOf.ts'
 export * from './isType.ts'
 export * from './ObjectTypeShape.ts'
+export * from './Typed.ts'
 export * from './typeOf.ts'
 export * from './TypeOfTypes.ts'
 export * from './validateType.ts'