@xylabs/typeof


Base functionality used throughout XY Labs TypeScript/JavaScript libraries
Reference
@xylabs/typeof
Type Aliases
Functions
functions
ifDefined
@xylabs/typeof
function ifDefined<T>(value, func): T | undefined;
Type Parameters
T
T
Parameters
value
T
func
(value) => void
Returns
T | undefined
ifTypeOf
@xylabs/typeof
function ifTypeOf<T, R>(
typeName,
value,
trueFunc,
isFunc?): R | undefined;
Type Parameters
T
T
R
R
Parameters
typeName
TypeOfTypes
value
unknown
trueFunc
(value) => R
isFunc?
(value) => boolean
Returns
R | undefined
isArray
@xylabs/typeof
Call Signature
function isArray(value): value is readonly unknown[];
Parameters
value
unknown
Returns
value is readonly unknown[]
Call Signature
function isArray<T>(value): value is Extract<T, readonly unknown[]>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, readonly unknown[]>
isArrayBufferView
@xylabs/typeof
Call Signature
function isArrayBufferView(value): value is ArrayBufferView<ArrayBufferLike>;
Parameters
value
unknown
Returns
value is ArrayBufferView<ArrayBufferLike>
Call Signature
function isArrayBufferView<T>(value): value is Extract<T, ArrayBufferView<ArrayBufferLike>>;
Type Parameters
T
T extends ArrayBufferView<ArrayBufferLike>
Parameters
value
T
Returns
value is Extract<T, ArrayBufferView<ArrayBufferLike>>
isBigInt
@xylabs/typeof
Call Signature
function isBigInt(value): value is bigint;
Parameters
value
unknown
Returns
value is bigint
Call Signature
function isBigInt<T>(value): value is Extract<T, bigint>;
Type Parameters
T
T extends bigint
Parameters
value
T
Returns
value is Extract<T, bigint>
isBlob
@xylabs/typeof
Call Signature
function isBlob(value): value is Blob;
Parameters
value
unknown
Returns
value is Blob
Call Signature
function isBlob<T>(value): value is Extract<T, Blob>;
Type Parameters
T
T extends Blob
Parameters
value
T
Returns
value is Extract<T, Blob>
isBoolean
@xylabs/typeof
Call Signature
function isBoolean(value): value is boolean;
Parameters
value
unknown
Returns
value is boolean
Call Signature
function isBoolean<T>(value): value is Extract<T, boolean>;
Type Parameters
T
T extends boolean
Parameters
value
T
Returns
value is Extract<T, boolean>
isDataView
@xylabs/typeof
Call Signature
function isDataView(value): value is DataView<ArrayBufferLike>;
Parameters
value
unknown
Returns
value is DataView<ArrayBufferLike>
Call Signature
function isDataView<T>(value): value is Extract<T, DataView<ArrayBufferLike>>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, DataView<ArrayBufferLike>>
isDate
@xylabs/typeof
Call Signature
function isDate(value): value is Date;
Parameters
value
unknown
Returns
value is Date
Call Signature
function isDate<T>(value): value is Extract<T, Date>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, Date>
isDateString
@xylabs/typeof
Call Signature
function isDateString(value): value is string;
Parameters
value
unknown
Returns
value is string
Call Signature
function isDateString<T>(value): value is Extract<T, string>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, string>
isDefined
@xylabs/typeof
function isDefined<T>(value): value is Exclude<T, undefined>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Exclude<T, undefined>
isDefinedNotNull
@xylabs/typeof
function isDefinedNotNull<T>(value): value is Exclude<T, null | undefined>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Exclude<T, null | undefined>
isEmpty
@xylabs/typeof
Call Signature
function isEmpty<T>(value): value is T;
Type Parameters
T
T
Parameters
value
unknown
Returns
value is T
Call Signature
function isEmpty<K, V, T>(value): value is Extract<T, Record<K, never>>;
Type Parameters
K
K extends RecordKey
V
V
T
T extends Record<K, V>
Parameters
value
T
Returns
value is Extract<T, Record<K, never>>
Call Signature
function isEmpty<T>(value): value is Extract<T, never[]>;
Type Parameters
T
T extends unknown[]
Parameters
value
T
Returns
value is Extract<T, never[]>
isEmptyArray
@xylabs/typeof
Call Signature
function isEmptyArray(value): value is [];
Parameters
value
unknown
Returns
value is []
Call Signature
function isEmptyArray<T>(value): value is Extract<T, unknown[]>;
Type Parameters
T
T extends unknown[]
Parameters
value
T
Returns
value is Extract<T, unknown[]>
isEmptyObject
@xylabs/typeof
Call Signature
function isEmptyObject(value): value is {};
Parameters
value
unknown
Returns
value is {}
Call Signature
function isEmptyObject<K, V, T>(value): value is Extract<T, Record<K, never>>;
Type Parameters
K
K extends RecordKey
V
V
T
T extends Record<K, V>
Parameters
value
T
Returns
value is Extract<T, Record<K, never>>
isEmptyString
@xylabs/typeof
Call Signature
function isEmptyString(value): value is "";
Parameters
value
unknown
Returns
value is ""
Call Signature
function isEmptyString<T>(value): value is Extract<T, "">;
Type Parameters
T
T extends string
Parameters
value
T
Returns
value is Extract<T, "">
isError
@xylabs/typeof
Call Signature
function isError(value): value is Error;
Parameters
value
unknown
Returns
value is Error
Call Signature
function isError<T>(value): value is Extract<T, Error>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, Error>
isFalsy
@xylabs/typeof
Call Signature
function isFalsy<T>(value): value is Extract<T, false | "" | 0 | 0n | null | undefined>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, false | "" | 0 | 0n | null | undefined>
Call Signature
function isFalsy<T>(value): value is Extract<T, false>;
Type Parameters
T
T extends boolean
Parameters
value
T
Returns
value is Extract<T, false>
Call Signature
function isFalsy<T>(value): value is Extract<T, 0>;
Type Parameters
T
T extends number
Parameters
value
T
Returns
value is Extract<T, 0>
Call Signature
function isFalsy<T>(value): value is Extract<T, 0n>;
Type Parameters
T
T extends bigint
Parameters
value
T
Returns
value is Extract<T, 0n>
Call Signature
function isFalsy<T>(value): value is Extract<T, null>;
Type Parameters
T
T extends null
Parameters
value
T
Returns
value is Extract<T, null>
Call Signature
function isFalsy<T>(value): value is Extract<T, undefined>;
Type Parameters
T
T extends undefined
Parameters
value
T
Returns
value is Extract<T, undefined>
Call Signature
function isFalsy<T>(value): value is Extract<T, "">;
Type Parameters
T
T extends string
Parameters
value
T
Returns
value is Extract<T, "">
isFile
@xylabs/typeof
Call Signature
function isFile(value): value is File;
Parameters
value
unknown
Returns
value is File
Call Signature
function isFile<T>(value): value is Extract<T, File>;
Type Parameters
T
T extends File
Parameters
value
T
Returns
value is Extract<T, File>
isFunction
@xylabs/typeof
Call Signature
function isFunction(value): value is AnyFunction;
Parameters
value
unknown
Returns
value is AnyFunction
Call Signature
function isFunction<T>(value): value is Extract<T, AnyFunction>;
Type Parameters
T
T extends AnyFunction
Parameters
value
T
Returns
value is Extract<T, AnyFunction>
isMap
@xylabs/typeof
Call Signature
function isMap(value): value is Map<unknown, unknown>;
Parameters
value
unknown
Returns
value is Map<unknown, unknown>
Call Signature
function isMap<K, V, T>(value): value is Extract<T, Map<K, V>>;
Type Parameters
K
K
V
V
T
T extends Map<K, V>
Parameters
value
T
Returns
value is Extract<T, Map<K, V>>
isNull
@xylabs/typeof
Call Signature
function isNull(value): value is null;
Parameters
value
unknown
Returns
value is null
Call Signature
function isNull<T>(value): value is Extract<T, null>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, null>
isNumber
@xylabs/typeof
Call Signature
function isNumber(value): value is number;
Parameters
value
unknown
Returns
value is number
Call Signature
function isNumber<T>(value): value is Extract<T, number>;
Type Parameters
T
T extends number
Parameters
value
T
Returns
value is Extract<T, number>
isObject
@xylabs/typeof
Call Signature
function isObject(value): value is object;
Parameters
value
unknown
Returns
value is object
Call Signature
function isObject<T>(value): value is Extract<T, object>;
Type Parameters
T
T extends object
Parameters
value
T
Returns
value is Extract<T, object>
isPopulatedArray
@xylabs/typeof
Call Signature
function isPopulatedArray(value): value is readonly unknown[];
Parameters
value
unknown
Returns
value is readonly unknown[]
Call Signature
function isPopulatedArray<T>(value): value is Extract<T, readonly unknown[]>;
Type Parameters
T
T extends unknown[]
Parameters
value
T
Returns
value is Extract<T, readonly unknown[]>
isPromise
@xylabs/typeof
Call Signature
function isPromise(value): value is Promise<unknown>;
Parameters
value
unknown
Returns
value is Promise<unknown>
Call Signature
function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, Promise<unknown>>
isPromiseLike
@xylabs/typeof
Call Signature
function isPromiseLike(value): value is Promise<unknown>;
Parameters
value
unknown
Returns
value is Promise<unknown>
Call Signature
function isPromiseLike<T>(value): value is Extract<T, Promise<unknown>>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, Promise<unknown>>
isRegExp
@xylabs/typeof
Call Signature
function isRegExp(value): value is RegExp;
Parameters
value
unknown
Returns
value is RegExp
Call Signature
function isRegExp<T>(value): value is Extract<T, RegExp>;
Type Parameters
T
T extends RegExp
Parameters
value
T
Returns
value is Extract<T, RegExp>
isSet
@xylabs/typeof
Call Signature
function isSet(value): value is Set<unknown>;
Parameters
value
unknown
Returns
value is Set<unknown>
Call Signature
function isSet<T>(value): value is Extract<T, Set<unknown>>;
Type Parameters
T
T extends Set<unknown>
Parameters
value
unknown
Returns
value is Extract<T, Set<unknown>>
isString
@xylabs/typeof
Call Signature
function isString(value): value is string;
Parameters
value
unknown
Returns
value is string
Call Signature
function isString<T>(value): value is Extract<T, string>;
Type Parameters
T
T extends string
Parameters
value
T
Returns
value is Extract<T, string>
isSymbol
@xylabs/typeof
Call Signature
function isSymbol(value): value is symbol;
Parameters
value
unknown
Returns
value is symbol
Call Signature
function isSymbol<T>(value): value is Extract<T, symbol>;
Type Parameters
T
T extends symbol
Parameters
value
T
Returns
value is Extract<T, symbol>
isTruthy
@xylabs/typeof
Call Signature
function isTruthy<T>(value): value is Exclude<T, false | "" | 0 | 0n | null | undefined>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Exclude<T, false | "" | 0 | 0n | null | undefined>
Call Signature
function isTruthy<T>(value): value is Extract<T, true>;
Type Parameters
T
T extends boolean
Parameters
value
T
Returns
value is Extract<T, true>
Call Signature
function isTruthy<T>(value): value is Extract<T, number>;
Type Parameters
T
T extends number
Parameters
value
T
Returns
value is Extract<T, number>
Call Signature
function isTruthy<T>(value): value is Extract<T, bigint>;
Type Parameters
T
T extends bigint
Parameters
value
T
Returns
value is Extract<T, bigint>
Call Signature
function isTruthy<T>(value): value is Extract<T, null>;
Type Parameters
T
T extends null
Parameters
value
T
Returns
value is Extract<T, null>
Call Signature
function isTruthy<T>(value): value is Extract<T, undefined>;
Type Parameters
T
T extends undefined
Parameters
value
T
Returns
value is Extract<T, undefined>
Call Signature
function isTruthy<T>(value): value is Extract<T, string>;
Type Parameters
T
T extends string
Parameters
value
T
Returns
value is Extract<T, string>
isType
@xylabs/typeof
function isType(value, expectedType): boolean;
Parameters
value
unknown
expectedType
FieldType
Returns
boolean
isTypedArray
@xylabs/typeof
function isTypedArray(value): value is TypedArray;
Parameters
value
unknown
Returns
value is TypedArray
isTypedKey
@xylabs/typeof
function isTypedKey(value): value is string | number | symbol;
Parameters
value
unknown
Returns
value is string | number | symbol
isTypedObject
@xylabs/typeof
function isTypedObject(value): value is TypedObject;
Parameters
value
unknown
Returns
value is TypedObject
isTypedValue
@xylabs/typeof
function isTypedValue(value): value is TypedValue;
Parameters
value
unknown
Returns
value is TypedValue
isUndefined
@xylabs/typeof
Call Signature
function isUndefined(value): value is undefined;
Parameters
value
unknown
Returns
value is undefined
Call Signature
function isUndefined<T>(value): value is Extract<T, undefined>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, undefined>
isUndefinedOrNull
@xylabs/typeof
Call Signature
function isUndefinedOrNull(value): value is null | undefined;
Parameters
value
unknown
Returns
value is null | undefined
Call Signature
function isUndefinedOrNull<T>(value): value is Extract<T, null | undefined>;
Type Parameters
T
T
Parameters
value
T
Returns
value is Extract<T, null | undefined>
isValidTypedFieldPair
@xylabs/typeof
function isValidTypedFieldPair(pair): pair is [key: string | number | symbol, value: TypedValue];
Parameters
pair
[unknown, unknown]
Returns
pair is [key: string | number | symbol, value: TypedValue]
isWeakMap
@xylabs/typeof
Call Signature
function isWeakMap(value): value is WeakMap<WeakKey, unknown>;
Parameters
value
unknown
Returns
value is WeakMap<WeakKey, unknown>
Call Signature
function isWeakMap<K, V, T>(value): value is Extract<T, WeakMap<K, V>>;
Type Parameters
K
K extends WeakKey
V
V
T
T extends WeakMap<K, V>
Parameters
value
T
Returns
value is Extract<T, WeakMap<K, V>>
isWeakSet
@xylabs/typeof
Call Signature
function isWeakSet(value): value is WeakSet<WeakKey>;
Parameters
value
unknown
Returns
value is WeakSet<WeakKey>
Call Signature
function isWeakSet<K, T>(value): value is Extract<T, WeakSet<K>>;
Type Parameters
K
K extends WeakKey
T
T extends WeakSet<K>
Parameters
value
T
Returns
value is Extract<T, WeakSet<K>>
typeOf
@xylabs/typeof
function typeOf<T>(item): TypeOfTypes;
Type Parameters
T
T
Parameters
item
T
Returns
TypeOfTypes
validateType
@xylabs/typeof
function validateType<T>(
typeName,
value,
optional?): [T | undefined, Error[]];
Type Parameters
T
T
Parameters
typeName
TypeOfTypes
value
T
optional?
boolean = false
Returns
[T | undefined, Error[]]
type-aliases
AnyFunction
@xylabs/typeof
type AnyFunction = (...args) => unknown;
Parameters
args
...unknown[]
Returns
unknown
Brand
@xylabs/typeof
type Brand<T, B> = T & { [K in keyof B]: B[K] };
Type Parameters
T
T
B
B
FieldType
@xylabs/typeof
type FieldType =
| "string"
| "number"
| "object"
| "symbol"
| "undefined"
| "null"
| "array"
| "function";
IdentityFunction
@xylabs/typeof
type IdentityFunction<T> = (value) => value is T;
Type Parameters
T
T
Parameters
value
unknown
Returns
value is T
ObjectTypeShape
@xylabs/typeof
type ObjectTypeShape = Record<string | number | symbol, FieldType>;
RecordKey
@xylabs/typeof
type RecordKey = string | number | symbol;
TypeOfTypes
@xylabs/typeof
type TypeOfTypes =
| "string"
| "number"
| "object"
| "array"
| "buffer"
| "null"
| "undefined"
| "bigint"
| "boolean"
| "function"
| "symbol";
TypedArray
@xylabs/typeof
type TypedArray = TypedValue[];
TypedKey
@xylabs/typeof
type TypedKey<T> = T extends string ? T : string | number | symbol;
Type Parameters
T
T extends string | void = void
TypedObject
@xylabs/typeof
type TypedObject =
| {
[key: string | number | symbol]: TypedValue;
}
| object;
TypedValue
@xylabs/typeof
type TypedValue =
| bigint
| string
| number
| boolean
| null
| TypedObject
| TypedArray
| Function
| symbol
| undefined;
Part of sdk-js
Maintainers
License
See the LICENSE file for license details
Credits
Made with 🔥 and ❄️ by XYLabs