@xylabs/typeof 4.13.15 → 4.13.17

package/README.md

@@ -1,6 +1,33 @@
-[![logo][]](https://xyo.network)
+# @xylabs/typeof
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
+[![npm-badge][]][npm-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
+[![socket-badge][]][socket-link]
+
+Version: 4.13.15
+
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
+
+## Documentation
+
+Coming Soon!
+
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
+
+## Maintainers
+
+-   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+-   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
+-   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
@@ -8,6 +35,26 @@ Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-c
 
 ## Credits
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
+
+[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/typeof.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/typeof
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/typeof
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/typeof
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/typeof/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/typeof
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/typeof
+[socket-link]: https://socket.dev/npm/package/@xylabs/typeof

package/dist/neutral/index.d.ts

@@ -1,111 +1,10 @@
-declare const ifDefined: <T>(value: T, func: (value: T) => void) => T | undefined;
-
-type TypeOfTypes = 'string' | 'number' | 'object' | 'array' | 'buffer' | 'null' | 'undefined' | 'bigint' | 'boolean' | 'function' | 'symbol';
-
-declare const ifTypeOf: <T, R>(typeName: TypeOfTypes, value: unknown, trueFunc: (value: T) => R, isFunc?: (value: T) => boolean) => R | undefined;
-
-type AnyFunction = (...args: unknown[]) => unknown;
-type RecordKey = string | number | symbol;
-declare function isUndefined(value: unknown): value is undefined;
-declare function isUndefined<T>(value: T): value is Extract<T, undefined>;
-declare function isDefined<T>(value: T): value is Exclude<T, undefined>;
-declare function isNull(value: unknown): value is null;
-declare function isNull<T>(value: T): value is Extract<T, null>;
-declare function isDefinedNotNull<T>(value: T): value is Exclude<T, undefined | null>;
-declare function isUndefinedOrNull(value: unknown): value is undefined | null;
-declare function isUndefinedOrNull<T>(value: T): value is Extract<T, undefined | null>;
-declare function isBigInt(value: unknown): value is bigint;
-declare function isBigInt<T extends bigint>(value: T): value is Extract<T, bigint>;
-declare function isString(value: unknown): value is string;
-declare function isString<T extends string>(value: T): value is Extract<T, string>;
-declare function isNumber(value: unknown): value is number;
-declare function isNumber<T extends number>(value: T): value is Extract<T, number>;
-declare function isObject(value: unknown): value is object;
-declare function isObject<T extends object>(value: T): value is Extract<T, object>;
-declare function isArray(value: unknown): value is [];
-declare function isArray<T extends []>(value: T): value is Extract<T, Array<unknown>>;
-declare function isFunction(value: unknown): value is AnyFunction;
-declare function isFunction<T extends AnyFunction>(value: T): value is Extract<T, AnyFunction>;
-declare function isSymbol(value: unknown): value is symbol;
-declare function isSymbol<T extends symbol>(value: T): value is Extract<T, symbol>;
-declare function isEmptyObject(value: unknown): value is {};
-declare function isEmptyObject<K extends RecordKey, V, T extends Record<K, V>>(value: T): value is Extract<T, Record<K, never>>;
-declare function isEmptyString(value: unknown): value is '';
-declare function isEmptyString<T extends string>(value: T): value is Extract<T, ''>;
-declare function isEmptyArray(value: unknown): value is [];
-declare function isEmptyArray<T extends Array<unknown>>(value: T): value is Extract<T, Array<unknown>>;
-declare function isPopulatedArray(value: unknown): value is [];
-declare function isPopulatedArray<T extends Array<unknown>>(value: T): value is Extract<T, Array<unknown>>;
-declare function isEmpty<T>(value: unknown): value is T;
-declare function isEmpty<K extends RecordKey, V, T extends Record<K, V>>(value: T): value is Extract<T, Record<K, never>>;
-declare function isEmpty<T extends Array<unknown>>(value: T): value is Extract<T, Array<never>>;
-declare function isFalsy<T>(value: T): value is Extract<T, 0 | null | undefined | false | '' | 0n>;
-declare function isFalsy<T extends boolean>(value: T): value is Extract<T, false>;
-declare function isFalsy<T extends number>(value: T): value is Extract<T, 0>;
-declare function isFalsy<T extends bigint>(value: T): value is Extract<T, 0n>;
-declare function isFalsy<T extends null>(value: T): value is Extract<T, null>;
-declare function isFalsy<T extends undefined>(value: T): value is Extract<T, undefined>;
-declare function isFalsy<T extends string>(value: T): value is Extract<T, ''>;
-declare function isTruthy<T>(value: T): value is Exclude<T, 0 | null | undefined | false | '' | 0n>;
-declare function isTruthy<T extends boolean>(value: T): value is Extract<T, true>;
-declare function isTruthy<T extends number>(value: T): value is Extract<T, number>;
-declare function isTruthy<T extends bigint>(value: T): value is Extract<T, bigint>;
-declare function isTruthy<T extends null>(value: T): value is Extract<T, null>;
-declare function isTruthy<T extends undefined>(value: T): value is Extract<T, undefined>;
-declare function isTruthy<T extends string>(value: T): value is Extract<T, string>;
-declare function isBoolean(value: unknown): value is boolean;
-declare function isBoolean<T extends boolean>(value: T): value is Extract<T, boolean>;
-declare function isDateString(value: unknown): value is string;
-declare function isDateString<T>(value: T): value is Extract<T, string>;
-declare function isDate(value: unknown): value is Date;
-declare function isDate<T>(value: T): value is Extract<T, Date>;
-declare function isRegExp(value: unknown): value is RegExp;
-declare function isRegExp<T extends RegExp>(value: T): value is Extract<T, RegExp>;
-declare function isError(value: unknown): value is Error;
-declare function isError<T>(value: T): value is Extract<T, Error>;
-declare function isPromise(value: unknown): value is Promise<unknown>;
-declare function isPromise<T>(value: T): value is Extract<T, Promise<unknown>>;
-declare function isPromiseLike(value: unknown): value is Promise<unknown>;
-declare function isPromiseLike<T>(value: T): value is Extract<T, Promise<unknown>>;
-declare function isMap(value: unknown): value is Map<unknown, unknown>;
-declare function isMap<K, V, T extends Map<K, V>>(value: T): value is Extract<T, Map<K, V>>;
-declare function isArrayBufferView(value: unknown): value is ArrayBufferView;
-declare function isArrayBufferView<T extends ArrayBufferView>(value: T): value is Extract<T, ArrayBufferView>;
-declare function isSet(value: unknown): value is Set<unknown>;
-declare function isSet<T extends Set<unknown>>(value: unknown | Set<T>): value is Extract<T, Set<unknown>>;
-declare function isWeakMap(value: unknown): value is WeakMap<WeakKey, unknown>;
-declare function isWeakMap<K extends WeakKey, V, T extends WeakMap<K, V>>(value: T): value is Extract<T, WeakMap<K, V>>;
-declare function isWeakSet(value: unknown): value is WeakSet<WeakKey>;
-declare function isWeakSet<K extends WeakKey, T extends WeakSet<K>>(value: T): value is Extract<T, WeakSet<K>>;
-declare function isArrayBuffer(value: unknown): value is ArrayBuffer;
-declare function isArrayBuffer<T extends ArrayBuffer>(value: T): value is Extract<T, ArrayBuffer>;
-declare function isDataView(value: unknown): value is DataView;
-declare function isDataView<T>(value: T): value is Extract<T, DataView>;
-declare function isBlob(value: unknown): value is Blob;
-declare function isBlob<T extends Blob>(value: T): value is Extract<T, Blob>;
-declare function isFile(value: unknown): value is File;
-declare function isFile<T extends File>(value: T): value is Extract<T, File>;
-
-type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'undefined' | 'null' | 'array' | 'function';
-type ObjectTypeShape = Record<string | number | symbol, FieldType>;
-
-declare const isType: (value: unknown, expectedType: FieldType) => boolean;
-
-type TypedValue = bigint | string | number | boolean | null | TypedObject | TypedArray | Function | symbol | undefined;
-type TypedKey<T extends string | void = void> = T extends string ? T : string | number | symbol;
-type TypedObject = {
-    [key: TypedKey]: TypedValue;
-} | object;
-type TypedArray = TypedValue[];
-declare const isTypedKey: (value: unknown) => value is TypedKey;
-declare const isTypedValue: (value: unknown) => value is TypedValue;
-declare const isTypedArray: (value: unknown) => value is TypedArray;
-declare const isValidTypedFieldPair: (pair: [key: unknown, value: unknown]) => pair is [key: TypedKey, value: TypedValue];
-declare const isTypedObject: (value: unknown) => value is TypedObject;
-
-declare const typeOf: <T>(item: T) => TypeOfTypes;
-
-declare const validateType: <T>(typeName: TypeOfTypes, value: T, optional?: boolean) => [T | undefined, Error[]];
-
-export { ifDefined, ifTypeOf, isArray, isArrayBuffer, isArrayBufferView, isBigInt, isBlob, isBoolean, isDataView, isDate, isDateString, isDefined, isDefinedNotNull, isEmpty, isEmptyArray, isEmptyObject, isEmptyString, isError, isFalsy, isFile, isFunction, isMap, isNull, isNumber, isObject, isPopulatedArray, isPromise, isPromiseLike, isRegExp, isSet, isString, isSymbol, isTruthy, isType, isTypedArray, isTypedKey, isTypedObject, isTypedValue, isUndefined, isUndefinedOrNull, isValidTypedFieldPair, isWeakMap, isWeakSet, typeOf, validateType };
-export type { AnyFunction, FieldType, ObjectTypeShape, RecordKey, TypeOfTypes, TypedArray, TypedKey, TypedObject, TypedValue };
+export * from './ifDefined.ts';
+export * from './ifTypeOf.ts';
+export * from './is.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';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/spec/is.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=is.spec.d.ts.map

package/dist/neutral/spec/is.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/is.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/typeof",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "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": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/build/neutral/index.d.ts

@@ -1,10 +0,0 @@
-export * from './ifDefined.ts';
-export * from './ifTypeOf.ts';
-export * from './is.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';
-//# sourceMappingURL=index.d.ts.map