@xylabs/typeof 4.13.3 → 4.13.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/neutral/index.d.ts +111 -199
  2. package/package.json +3 -3
package/dist/neutral/index.d.ts CHANGED
@@ -1,199 +1,111 @@
1
- export declare type AnyFunction = (...args: unknown[]) => unknown;
2
-
3
- export declare type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'undefined' | 'null' | 'array' | 'function';
4
-
5
- export declare const ifDefined: <T>(value: T, func: (value: T) => void) => T | undefined;
6
-
7
- export declare const ifTypeOf: <T, R>(typeName: TypeOfTypes, value: unknown, trueFunc: (value: T) => R, isFunc?: (value: T) => boolean) => R | undefined;
8
-
9
- export declare function isArray(value: unknown): value is [];
10
-
11
- export declare function isArray<T extends []>(value: T): value is Extract<T, Array<unknown>>;
12
-
13
- export declare function isArrayBuffer(value: unknown): value is ArrayBuffer;
14
-
15
- export declare function isArrayBuffer<T extends ArrayBuffer>(value: T): value is Extract<T, ArrayBuffer>;
16
-
17
- export declare function isArrayBufferView(value: unknown): value is ArrayBufferView;
18
-
19
- export declare function isArrayBufferView<T extends ArrayBufferView>(value: T): value is Extract<T, ArrayBufferView>;
20
-
21
- export declare function isBigInt(value: unknown): value is bigint;
22
-
23
- export declare function isBigInt<T extends bigint>(value: T): value is Extract<T, bigint>;
24
-
25
- export declare function isBlob(value: unknown): value is Blob;
26
-
27
- export declare function isBlob<T extends Blob>(value: T): value is Extract<T, Blob>;
28
-
29
- export declare function isBoolean(value: unknown): value is boolean;
30
-
31
- export declare function isBoolean<T extends boolean>(value: T): value is Extract<T, boolean>;
32
-
33
- export declare function isDataView(value: unknown): value is DataView;
34
-
35
- export declare function isDataView<T>(value: T): value is Extract<T, DataView>;
36
-
37
- export declare function isDate(value: unknown): value is Date;
38
-
39
- export declare function isDate<T>(value: T): value is Extract<T, Date>;
40
-
41
- export declare function isDateString(value: unknown): value is string;
42
-
43
- export declare function isDateString<T>(value: T): value is Extract<T, string>;
44
-
45
- export declare function isDefined<T>(value: T): value is Exclude<T, undefined>;
46
-
47
- export declare function isDefinedNotNull<T>(value: T): value is Exclude<T, undefined | null>;
48
-
49
- export declare function isEmpty<T>(value: unknown): value is T;
50
-
51
- export declare function isEmpty<K extends RecordKey, V, T extends Record<K, V>>(value: T): value is Extract<T, Record<K, never>>;
52
-
53
- export declare function isEmpty<T extends Array<unknown>>(value: T): value is Extract<T, Array<never>>;
54
-
55
- export declare function isEmptyArray(value: unknown): value is [];
56
-
57
- export declare function isEmptyArray<T extends Array<unknown>>(value: T): value is Extract<T, Array<unknown>>;
58
-
59
- export declare function isEmptyObject(value: unknown): value is {};
60
-
61
- export declare function isEmptyObject<K extends RecordKey, V, T extends Record<K, V>>(value: T): value is Extract<T, Record<K, never>>;
62
-
63
- export declare function isEmptyString(value: unknown): value is '';
64
-
65
- export declare function isEmptyString<T extends string>(value: T): value is Extract<T, ''>;
66
-
67
- export declare function isError(value: unknown): value is Error;
68
-
69
- export declare function isError<T>(value: T): value is Extract<T, Error>;
70
-
71
- export declare function isFalsy<T>(value: T): value is Extract<T, 0 | null | undefined | false | '' | 0n>;
72
-
73
- export declare function isFalsy<T extends boolean>(value: T): value is Extract<T, false>;
74
-
75
- export declare function isFalsy<T extends number>(value: T): value is Extract<T, 0>;
76
-
77
- export declare function isFalsy<T extends bigint>(value: T): value is Extract<T, 0n>;
78
-
79
- export declare function isFalsy<T extends null>(value: T): value is Extract<T, null>;
80
-
81
- export declare function isFalsy<T extends undefined>(value: T): value is Extract<T, undefined>;
82
-
83
- export declare function isFalsy<T extends string>(value: T): value is Extract<T, ''>;
84
-
85
- export declare function isFile(value: unknown): value is File;
86
-
87
- export declare function isFile<T extends File>(value: T): value is Extract<T, File>;
88
-
89
- export declare function isFunction(value: unknown): value is AnyFunction;
90
-
91
- export declare function isFunction<T extends AnyFunction>(value: T): value is Extract<T, AnyFunction>;
92
-
93
- export declare function isMap(value: unknown): value is Map<unknown, unknown>;
94
-
95
- export declare function isMap<K, V, T extends Map<K, V>>(value: T): value is Extract<T, Map<K, V>>;
96
-
97
- export declare function isNull(value: unknown): value is null;
98
-
99
- export declare function isNull<T>(value: T): value is Extract<T, null>;
100
-
101
- export declare function isNumber(value: unknown): value is number;
102
-
103
- export declare function isNumber<T extends number>(value: T): value is Extract<T, number>;
104
-
105
- export declare function isObject(value: unknown): value is object;
106
-
107
- export declare function isObject<T extends object>(value: T): value is Extract<T, object>;
108
-
109
- export declare function isPopulatedArray(value: unknown): value is [];
110
-
111
- export declare function isPopulatedArray<T extends Array<unknown>>(value: T): value is Extract<T, Array<unknown>>;
112
-
113
- export declare function isPromise(value: unknown): value is Promise<unknown>;
114
-
115
- export declare function isPromise<T>(value: T): value is Extract<T, Promise<unknown>>;
116
-
117
- export declare function isPromiseLike(value: unknown): value is Promise<unknown>;
118
-
119
- export declare function isPromiseLike<T>(value: T): value is Extract<T, Promise<unknown>>;
120
-
121
- export declare function isRegExp(value: unknown): value is RegExp;
122
-
123
- export declare function isRegExp<T extends RegExp>(value: T): value is Extract<T, RegExp>;
124
-
125
- export declare function isSet(value: unknown): value is Set<unknown>;
126
-
127
- export declare function isSet<T extends Set<unknown>>(value: unknown | Set<T>): value is Extract<T, Set<unknown>>;
128
-
129
- export declare function isString(value: unknown): value is string;
130
-
131
- export declare function isString<T extends string>(value: T): value is Extract<T, string>;
132
-
133
- export declare function isSymbol(value: unknown): value is symbol;
134
-
135
- export declare function isSymbol<T extends symbol>(value: T): value is Extract<T, symbol>;
136
-
137
- export declare function isTruthy<T>(value: T): value is Exclude<T, 0 | null | undefined | false | '' | 0n>;
138
-
139
- export declare function isTruthy<T extends boolean>(value: T): value is Extract<T, true>;
140
-
141
- export declare function isTruthy<T extends number>(value: T): value is Extract<T, number>;
142
-
143
- export declare function isTruthy<T extends bigint>(value: T): value is Extract<T, bigint>;
144
-
145
- export declare function isTruthy<T extends null>(value: T): value is Extract<T, null>;
146
-
147
- export declare function isTruthy<T extends undefined>(value: T): value is Extract<T, undefined>;
148
-
149
- export declare function isTruthy<T extends string>(value: T): value is Extract<T, string>;
150
-
151
- export declare const isType: (value: unknown, expectedType: FieldType) => boolean;
152
-
153
- export declare const isTypedArray: (value: unknown) => value is TypedArray;
154
-
155
- export declare const isTypedKey: (value: unknown) => value is TypedKey;
156
-
157
- export declare const isTypedObject: (value: unknown) => value is TypedObject;
158
-
159
- export declare const isTypedValue: (value: unknown) => value is TypedValue;
160
-
161
- export declare function isUndefined(value: unknown): value is undefined;
162
-
163
- export declare function isUndefined<T>(value: T): value is Extract<T, undefined>;
164
-
165
- export declare function isUndefinedOrNull(value: unknown): value is undefined | null;
166
-
167
- export declare function isUndefinedOrNull<T>(value: T): value is Extract<T, undefined | null>;
168
-
169
- export declare const isValidTypedFieldPair: (pair: [key: unknown, value: unknown]) => pair is [key: TypedKey, value: TypedValue];
170
-
171
- export declare function isWeakMap(value: unknown): value is WeakMap<WeakKey, unknown>;
172
-
173
- export declare function isWeakMap<K extends WeakKey, V, T extends WeakMap<K, V>>(value: T): value is Extract<T, WeakMap<K, V>>;
174
-
175
- export declare function isWeakSet(value: unknown): value is WeakSet<WeakKey>;
176
-
177
- export declare function isWeakSet<K extends WeakKey, T extends WeakSet<K>>(value: T): value is Extract<T, WeakSet<K>>;
178
-
179
- export declare type ObjectTypeShape = Record<string | number | symbol, FieldType>;
180
-
181
- export declare type RecordKey = string | number | symbol;
182
-
183
- export declare type TypedArray = TypedValue[];
184
-
185
- export declare type TypedKey<T extends string | void = void> = T extends string ? T : string | number | symbol;
186
-
187
- export declare type TypedObject = {
188
- [key: TypedKey]: TypedValue;
189
- } | object;
190
-
191
- export declare type TypedValue = bigint | string | number | boolean | null | TypedObject | TypedArray | Function | symbol | undefined;
192
-
193
- export declare const typeOf: <T>(item: T) => TypeOfTypes;
194
-
195
- export declare type TypeOfTypes = 'string' | 'number' | 'object' | 'array' | 'buffer' | 'null' | 'undefined' | 'bigint' | 'boolean' | 'function' | 'symbol';
196
-
197
- export declare const validateType: <T>(typeName: TypeOfTypes, value: T, optional?: boolean) => [T | undefined, Error[]];
198
-
199
- export { }
1
+ declare const ifDefined: <T>(value: T, func: (value: T) => void) => T | undefined;
2
+
3
+ type TypeOfTypes = 'string' | 'number' | 'object' | 'array' | 'buffer' | 'null' | 'undefined' | 'bigint' | 'boolean' | 'function' | 'symbol';
4
+
5
+ declare const ifTypeOf: <T, R>(typeName: TypeOfTypes, value: unknown, trueFunc: (value: T) => R, isFunc?: (value: T) => boolean) => R | undefined;
6
+
7
+ type AnyFunction = (...args: unknown[]) => unknown;
8
+ type RecordKey = string | number | symbol;
9
+ declare function isUndefined(value: unknown): value is undefined;
10
+ declare function isUndefined<T>(value: T): value is Extract<T, undefined>;
11
+ declare function isDefined<T>(value: T): value is Exclude<T, undefined>;
12
+ declare function isNull(value: unknown): value is null;
13
+ declare function isNull<T>(value: T): value is Extract<T, null>;
14
+ declare function isDefinedNotNull<T>(value: T): value is Exclude<T, undefined | null>;
15
+ declare function isUndefinedOrNull(value: unknown): value is undefined | null;
16
+ declare function isUndefinedOrNull<T>(value: T): value is Extract<T, undefined | null>;
17
+ declare function isBigInt(value: unknown): value is bigint;
18
+ declare function isBigInt<T extends bigint>(value: T): value is Extract<T, bigint>;
19
+ declare function isString(value: unknown): value is string;
20
+ declare function isString<T extends string>(value: T): value is Extract<T, string>;
21
+ declare function isNumber(value: unknown): value is number;
22
+ declare function isNumber<T extends number>(value: T): value is Extract<T, number>;
23
+ declare function isObject(value: unknown): value is object;
24
+ declare function isObject<T extends object>(value: T): value is Extract<T, object>;
25
+ declare function isArray(value: unknown): value is [];
26
+ declare function isArray<T extends []>(value: T): value is Extract<T, Array<unknown>>;
27
+ declare function isFunction(value: unknown): value is AnyFunction;
28
+ declare function isFunction<T extends AnyFunction>(value: T): value is Extract<T, AnyFunction>;
29
+ declare function isSymbol(value: unknown): value is symbol;
30
+ declare function isSymbol<T extends symbol>(value: T): value is Extract<T, symbol>;
31
+ declare function isEmptyObject(value: unknown): value is {};
32
+ declare function isEmptyObject<K extends RecordKey, V, T extends Record<K, V>>(value: T): value is Extract<T, Record<K, never>>;
33
+ declare function isEmptyString(value: unknown): value is '';
34
+ declare function isEmptyString<T extends string>(value: T): value is Extract<T, ''>;
35
+ declare function isEmptyArray(value: unknown): value is [];
36
+ declare function isEmptyArray<T extends Array<unknown>>(value: T): value is Extract<T, Array<unknown>>;
37
+ declare function isPopulatedArray(value: unknown): value is [];
38
+ declare function isPopulatedArray<T extends Array<unknown>>(value: T): value is Extract<T, Array<unknown>>;
39
+ declare function isEmpty<T>(value: unknown): value is T;
40
+ declare function isEmpty<K extends RecordKey, V, T extends Record<K, V>>(value: T): value is Extract<T, Record<K, never>>;
41
+ declare function isEmpty<T extends Array<unknown>>(value: T): value is Extract<T, Array<never>>;
42
+ declare function isFalsy<T>(value: T): value is Extract<T, 0 | null | undefined | false | '' | 0n>;
43
+ declare function isFalsy<T extends boolean>(value: T): value is Extract<T, false>;
44
+ declare function isFalsy<T extends number>(value: T): value is Extract<T, 0>;
45
+ declare function isFalsy<T extends bigint>(value: T): value is Extract<T, 0n>;
46
+ declare function isFalsy<T extends null>(value: T): value is Extract<T, null>;
47
+ declare function isFalsy<T extends undefined>(value: T): value is Extract<T, undefined>;
48
+ declare function isFalsy<T extends string>(value: T): value is Extract<T, ''>;
49
+ declare function isTruthy<T>(value: T): value is Exclude<T, 0 | null | undefined | false | '' | 0n>;
50
+ declare function isTruthy<T extends boolean>(value: T): value is Extract<T, true>;
51
+ declare function isTruthy<T extends number>(value: T): value is Extract<T, number>;
52
+ declare function isTruthy<T extends bigint>(value: T): value is Extract<T, bigint>;
53
+ declare function isTruthy<T extends null>(value: T): value is Extract<T, null>;
54
+ declare function isTruthy<T extends undefined>(value: T): value is Extract<T, undefined>;
55
+ declare function isTruthy<T extends string>(value: T): value is Extract<T, string>;
56
+ declare function isBoolean(value: unknown): value is boolean;
57
+ declare function isBoolean<T extends boolean>(value: T): value is Extract<T, boolean>;
58
+ declare function isDateString(value: unknown): value is string;
59
+ declare function isDateString<T>(value: T): value is Extract<T, string>;
60
+ declare function isDate(value: unknown): value is Date;
61
+ declare function isDate<T>(value: T): value is Extract<T, Date>;
62
+ declare function isRegExp(value: unknown): value is RegExp;
63
+ declare function isRegExp<T extends RegExp>(value: T): value is Extract<T, RegExp>;
64
+ declare function isError(value: unknown): value is Error;
65
+ declare function isError<T>(value: T): value is Extract<T, Error>;
66
+ declare function isPromise(value: unknown): value is Promise<unknown>;
67
+ declare function isPromise<T>(value: T): value is Extract<T, Promise<unknown>>;
68
+ declare function isPromiseLike(value: unknown): value is Promise<unknown>;
69
+ declare function isPromiseLike<T>(value: T): value is Extract<T, Promise<unknown>>;
70
+ declare function isMap(value: unknown): value is Map<unknown, unknown>;
71
+ declare function isMap<K, V, T extends Map<K, V>>(value: T): value is Extract<T, Map<K, V>>;
72
+ declare function isArrayBufferView(value: unknown): value is ArrayBufferView;
73
+ declare function isArrayBufferView<T extends ArrayBufferView>(value: T): value is Extract<T, ArrayBufferView>;
74
+ declare function isSet(value: unknown): value is Set<unknown>;
75
+ declare function isSet<T extends Set<unknown>>(value: unknown | Set<T>): value is Extract<T, Set<unknown>>;
76
+ declare function isWeakMap(value: unknown): value is WeakMap<WeakKey, unknown>;
77
+ declare function isWeakMap<K extends WeakKey, V, T extends WeakMap<K, V>>(value: T): value is Extract<T, WeakMap<K, V>>;
78
+ declare function isWeakSet(value: unknown): value is WeakSet<WeakKey>;
79
+ declare function isWeakSet<K extends WeakKey, T extends WeakSet<K>>(value: T): value is Extract<T, WeakSet<K>>;
80
+ declare function isArrayBuffer(value: unknown): value is ArrayBuffer;
81
+ declare function isArrayBuffer<T extends ArrayBuffer>(value: T): value is Extract<T, ArrayBuffer>;
82
+ declare function isDataView(value: unknown): value is DataView;
83
+ declare function isDataView<T>(value: T): value is Extract<T, DataView>;
84
+ declare function isBlob(value: unknown): value is Blob;
85
+ declare function isBlob<T extends Blob>(value: T): value is Extract<T, Blob>;
86
+ declare function isFile(value: unknown): value is File;
87
+ declare function isFile<T extends File>(value: T): value is Extract<T, File>;
88
+
89
+ type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'undefined' | 'null' | 'array' | 'function';
90
+ type ObjectTypeShape = Record<string | number | symbol, FieldType>;
91
+
92
+ declare const isType: (value: unknown, expectedType: FieldType) => boolean;
93
+
94
+ type TypedValue = bigint | string | number | boolean | null | TypedObject | TypedArray | Function | symbol | undefined;
95
+ type TypedKey<T extends string | void = void> = T extends string ? T : string | number | symbol;
96
+ type TypedObject = {
97
+ [key: TypedKey]: TypedValue;
98
+ } | object;
99
+ type TypedArray = TypedValue[];
100
+ declare const isTypedKey: (value: unknown) => value is TypedKey;
101
+ declare const isTypedValue: (value: unknown) => value is TypedValue;
102
+ declare const isTypedArray: (value: unknown) => value is TypedArray;
103
+ declare const isValidTypedFieldPair: (pair: [key: unknown, value: unknown]) => pair is [key: TypedKey, value: TypedValue];
104
+ declare const isTypedObject: (value: unknown) => value is TypedObject;
105
+
106
+ declare const typeOf: <T>(item: T) => TypeOfTypes;
107
+
108
+ declare const validateType: <T>(typeName: TypeOfTypes, value: T, optional?: boolean) => [T | undefined, Error[]];
109
+
110
+ 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 };
111
+ export type { AnyFunction, FieldType, ObjectTypeShape, RecordKey, TypeOfTypes, TypedArray, TypedKey, TypedObject, TypedValue };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/typeof",
3
- "version": "4.13.3",
3
+ "version": "4.13.5",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "typeof",
@@ -36,8 +36,8 @@
36
36
  "module": "dist/neutral/index.mjs",
37
37
  "types": "dist/neutral/index.d.ts",
38
38
  "devDependencies": {
39
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.7",
40
- "@xylabs/tsconfig": "^7.0.0-rc.7",
39
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.8",
40
+ "@xylabs/tsconfig": "^7.0.0-rc.8",
41
41
  "typescript": "^5.8.3",
42
42
  "vitest": "^3.2.4"
43
43
  },