@xylabs/typeof

[![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]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/typeof

*

Type Aliases

- FieldType
- ObjectTypeShape
- TypeOfTypes
- TypedValue
- TypedKey
- TypedObject
- TypedArray
- AnyFunction
- RecordKey

Functions

- isTypedKey
- isTypedValue
- isTypedArray
- isValidTypedFieldPair
- isTypedObject
- ifDefined
- ifTypeOf
- isUndefined
- isDefined
- isNull
- isDefinedNotNull
- isUndefinedOrNull
- isBigInt
- isString
- isNumber
- isObject
- isArray
- isFunction
- isSymbol
- isEmptyObject
- isEmptyString
- isEmptyArray
- isPopulatedArray
- isEmpty
- isFalsy
- isTruthy
- isBoolean
- isDateString
- isDate
- isRegExp
- isError
- isPromise
- isPromiseLike
- isMap
- isArrayBufferView
- isSet
- isWeakMap
- isWeakSet
- isArrayBuffer
- isDataView
- isBlob
- isFile
- isType
- typeOf
- validateType

$3

### ifDefined

@xylabs/typeof

*

``ts
function ifDefined(value, func): undefined | T;
`

Type Parameters

$3

T

Parameters

$3

T

$3

(value) => void

Returns

undefined \| T

### ifTypeOf

@xylabs/typeof

*

`ts
function ifTypeOf(
typeName,
value,
trueFunc,
isFunc?): undefined | R;
`

Type Parameters

$3

T

$3

R

Parameters

$3

TypeOfTypes

$3

unknown

$3

(value) => R

$3

(value) => boolean

Returns

undefined \| R

### isArray

@xylabs/typeof

*

Call Signature

`ts
function isArray(value): value is [];
`

$3

$3

unknown

$3

value is []

Call Signature

`ts
function isArray(value): value is Extract;
`

$3

$3

T extends \[\]

$3

$3

T

$3

value is Extract

### isArrayBuffer

@xylabs/typeof

*

Call Signature

`ts
function isArrayBuffer(value): value is ArrayBuffer;
`

$3

$3

unknown

$3

value is ArrayBuffer

Call Signature

`ts
function isArrayBuffer(value): value is Extract;
`

$3

$3

T extends ArrayBuffer

$3

$3

T

$3

value is Extract

### isArrayBufferView

@xylabs/typeof

*

Call Signature

`ts
function isArrayBufferView(value): value is ArrayBufferView;
`

$3

$3

unknown

$3

value is ArrayBufferView

Call Signature

`ts
function isArrayBufferView(value): value is Extract>;
`

$3

$3

T extends ArrayBufferView\<ArrayBufferLike\>

$3

$3

T

$3

value is Extract>

### isBigInt

@xylabs/typeof

*

Call Signature

`ts
function isBigInt(value): value is bigint;
`

$3

$3

unknown

$3

value is bigint

Call Signature

`ts
function isBigInt(value): value is Extract;
`

$3

$3

T extends bigint

$3

$3

T

$3

value is Extract

### isBlob

@xylabs/typeof

*

Call Signature

`ts
function isBlob(value): value is Blob;
`

$3

$3

unknown

$3

value is Blob

Call Signature

`ts
function isBlob(value): value is Extract;
`

$3

$3

T extends Blob

$3

$3

T

$3

value is Extract

### isBoolean

@xylabs/typeof

*

Call Signature

`ts
function isBoolean(value): value is boolean;
`

$3

$3

unknown

$3

value is boolean

Call Signature

`ts
function isBoolean(value): value is Extract;
`

$3

$3

T extends boolean

$3

$3

T

$3

value is Extract

### isDataView

@xylabs/typeof

*

Call Signature

`ts
function isDataView(value): value is DataView;
`

$3

$3

unknown

$3

value is DataView

Call Signature

`ts
function isDataView(value): value is Extract>;
`

$3

$3

T

$3

$3

T

$3

value is Extract>

### isDate

@xylabs/typeof

*

Call Signature

`ts
function isDate(value): value is Date;
`

$3

$3

unknown

$3

value is Date

Call Signature

`ts
function isDate(value): value is Extract;
`

$3

$3

T

$3

$3

T

$3

value is Extract

### isDateString

@xylabs/typeof

*

Call Signature

`ts
function isDateString(value): value is string;
`

$3

$3

unknown

$3

value is string

Call Signature

`ts
function isDateString(value): value is Extract;
`

$3

$3

T

$3

$3

T

$3

value is Extract

### isDefined

@xylabs/typeof

*

`ts
function isDefined(value): value is Exclude;
`

Type Parameters

$3

T

Parameters

$3

T

Returns

value is Exclude

### isDefinedNotNull

@xylabs/typeof

*

`ts
function isDefinedNotNull(value): value is Exclude;
`

Type Parameters

$3

T

Parameters

$3

T

Returns

value is Exclude\

### isEmpty

@xylabs/typeof

*

Call Signature

`ts
function isEmpty(value): value is T;
`

$3

$3

T

$3

$3

unknown

$3

value is T

Call Signature

`ts
function isEmpty(value): value is Extract>;
`

$3

$3

K extends RecordKey

$3

V

$3

T extends Record\<K, V\>

$3

$3

T

$3

value is Extract>

Call Signature

`ts
function isEmpty(value): value is Extract;
`

$3

$3

T extends unknown[]

$3

$3

T

$3

value is Extract

### isEmptyArray

@xylabs/typeof

*

Call Signature

`ts
function isEmptyArray(value): value is [];
`

$3

$3

unknown

$3

value is []

Call Signature

`ts
function isEmptyArray(value): value is Extract;
`

$3

$3

T extends unknown[]

$3

$3

T

$3

value is Extract

### isEmptyObject

@xylabs/typeof

*

Call Signature

`ts
function isEmptyObject(value): value is {};
`

$3

$3

unknown

$3

value is {}

Call Signature

`ts
function isEmptyObject(value): value is Extract>;
`

$3

$3

K extends RecordKey

$3

V

$3

T extends Record\<K, V\>

$3

$3

T

$3

value is Extract>

### isEmptyString

@xylabs/typeof

*

Call Signature

`ts
function isEmptyString(value): value is "";
`

$3

$3

unknown

$3

value is ""

Call Signature

`ts
function isEmptyString(value): value is Extract;
`

$3

$3

T extends string

$3

$3

T

$3

value is Extract

### isError

@xylabs/typeof

*

Call Signature

`ts
function isError(value): value is Error;
`

$3

$3

unknown

$3

value is Error

Call Signature

`ts
function isError(value): value is Extract;
`

$3

$3

T

$3

$3

T

$3

value is Extract

### isFalsy

@xylabs/typeof

*

Call Signature

`ts
function isFalsy(value): value is Extract;
`

$3

$3

T

$3

$3

T

$3

value is Extract\

Call Signature

`ts
function isFalsy(value): value is Extract;
`

$3

$3

T extends boolean

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isFalsy(value): value is Extract;
`

$3

$3

T extends number

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isFalsy(value): value is Extract;
`

$3

$3

T extends bigint

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isFalsy(value): value is Extract;
`

$3

$3

T extends null

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isFalsy(value): value is Extract;
`

$3

$3

T extends undefined

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isFalsy(value): value is Extract;
`

$3

$3

T extends string

$3

$3

T

$3

value is Extract

### isFile

@xylabs/typeof

*

Call Signature

`ts
function isFile(value): value is File;
`

$3

$3

unknown

$3

value is File

Call Signature

`ts
function isFile(value): value is Extract;
`

$3

$3

T extends File

$3

$3

T

$3

value is Extract

### isFunction

@xylabs/typeof

*

Call Signature

`ts
function isFunction(value): value is AnyFunction;
`

$3

$3

unknown

$3

value is AnyFunction

Call Signature

`ts
function isFunction(value): value is Extract;
`

$3

$3

T extends AnyFunction

$3

$3

T

$3

value is Extract

### isMap

@xylabs/typeof

*

Call Signature

`ts
function isMap(value): value is Map;
`

$3

$3

unknown

$3

value is Map

Call Signature

`ts
function isMap(value): value is Extract>;
`

$3

$3

K

$3

V

$3

T extends Map\<K, V\>

$3

$3

T

$3

value is Extract>

### isNull

@xylabs/typeof

*

Call Signature

`ts
function isNull(value): value is null;
`

$3

$3

unknown

$3

value is null

Call Signature

`ts
function isNull(value): value is Extract;
`

$3

$3

T

$3

$3

T

$3

value is Extract

### isNumber

@xylabs/typeof

*

Call Signature

`ts
function isNumber(value): value is number;
`

$3

$3

unknown

$3

value is number

Call Signature

`ts
function isNumber(value): value is Extract;
`

$3

$3

T extends number

$3

$3

T

$3

value is Extract

### isObject

@xylabs/typeof

*

Call Signature

`ts
function isObject(value): value is object;
`

$3

$3

unknown

$3

value is object

Call Signature

`ts
function isObject(value): value is Extract;
`

$3

$3

T extends object

$3

$3

T

$3

value is Extract

### isPopulatedArray

@xylabs/typeof

*

Call Signature

`ts
function isPopulatedArray(value): value is [];
`

$3

$3

unknown

$3

value is []

Call Signature

`ts
function isPopulatedArray(value): value is Extract;
`

$3

$3

T extends unknown[]

$3

$3

T

$3

value is Extract

### isPromise

@xylabs/typeof

*

Call Signature

`ts
function isPromise(value): value is Promise;
`

$3

$3

unknown

$3

value is Promise

Call Signature

`ts
function isPromise(value): value is Extract>;
`

$3

$3

T

$3

$3

T

$3

value is Extract>

### isPromiseLike

@xylabs/typeof

*

Call Signature

`ts
function isPromiseLike(value): value is Promise;
`

$3

$3

unknown

$3

value is Promise

Call Signature

`ts
function isPromiseLike(value): value is Extract>;
`

$3

$3

T

$3

$3

T

$3

value is Extract>

### isRegExp

@xylabs/typeof

*

Call Signature

`ts
function isRegExp(value): value is RegExp;
`

$3

$3

unknown

$3

value is RegExp

Call Signature

`ts
function isRegExp(value): value is Extract;
`

$3

$3

T extends RegExp

$3

$3

T

$3

value is Extract

### isSet

@xylabs/typeof

*

Call Signature

`ts
function isSet(value): value is Set;
`

$3

$3

unknown

$3

value is Set

Call Signature

`ts
function isSet(value): value is Extract>;
`

$3

$3

T extends Set\<unknown\>

$3

$3

unknown

$3

value is Extract>

### isString

@xylabs/typeof

*

Call Signature

`ts
function isString(value): value is string;
`

$3

$3

unknown

$3

value is string

Call Signature

`ts
function isString(value): value is Extract;
`

$3

$3

T extends string

$3

$3

T

$3

value is Extract

### isSymbol

@xylabs/typeof

*

Call Signature

`ts
function isSymbol(value): value is symbol;
`

$3

$3

unknown

$3

value is symbol

Call Signature

`ts
function isSymbol(value): value is Extract;
`

$3

$3

T extends symbol

$3

$3

T

$3

value is Extract

### isTruthy

@xylabs/typeof

*

Call Signature

`ts
function isTruthy(value): value is Exclude;
`

$3

$3

T

$3

$3

T

$3

value is Exclude\

Call Signature

`ts
function isTruthy(value): value is Extract;
`

$3

$3

T extends boolean

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isTruthy(value): value is Extract;
`

$3

$3

T extends number

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isTruthy(value): value is Extract;
`

$3

$3

T extends bigint

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isTruthy(value): value is Extract;
`

$3

$3

T extends null

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isTruthy(value): value is Extract;
`

$3

$3

T extends undefined

$3

$3

T

$3

value is Extract

Call Signature

`ts
function isTruthy(value): value is Extract;
`

$3

$3

T extends string

$3

$3

T

$3

value is Extract

### isType

@xylabs/typeof

*

`ts
function isType(value, expectedType): boolean;
`

Parameters

$3

unknown

$3

FieldType

Returns

boolean

### isTypedArray

@xylabs/typeof

*

`ts
function isTypedArray(value): value is TypedArray;
`

Parameters

$3

unknown

Returns

value is TypedArray

### isTypedKey

@xylabs/typeof

*

`ts
function isTypedKey(value): value is string | number | symbol;
`

Parameters

$3

unknown

Returns

value is string \| number \| symbol

### isTypedObject

@xylabs/typeof

*

`ts
function isTypedObject(value): value is TypedObject;
`

Parameters

$3

unknown

Returns

value is TypedObject

### isTypedValue

@xylabs/typeof

*

`ts
function isTypedValue(value): value is TypedValue;
`

Parameters

$3

unknown

Returns

value is TypedValue

### isUndefined

@xylabs/typeof

*

Call Signature

`ts
function isUndefined(value): value is undefined;
`

$3

$3

unknown

$3

value is undefined

Call Signature

`ts
function isUndefined(value): value is Extract;
`

$3

$3

T

$3

$3

T

$3

value is Extract

### isUndefinedOrNull

@xylabs/typeof

*

Call Signature

`ts
function isUndefinedOrNull(value): value is undefined | null;
`

$3

$3

unknown

$3

value is undefined \| null

Call Signature

`ts
function isUndefinedOrNull(value): value is Extract;
`

$3

$3

T

$3

$3

T

$3

value is Extract\

### isValidTypedFieldPair

@xylabs/typeof

*

`ts
function isValidTypedFieldPair(pair): pair is [key: string | number | symbol, value: TypedValue];
`

Parameters

$3

\[unknown, unknown\]

Returns

pair is \[key: string \| number \| symbol, value: TypedValue\]

### isWeakMap

@xylabs/typeof

*

Call Signature

`ts
function isWeakMap(value): value is WeakMap;
`

$3

$3

unknown

$3

value is WeakMap

Call Signature

`ts
function isWeakMap(value): value is Extract>;
`

$3

$3

K extends WeakKey

$3

V

$3

T extends WeakMap\<K, V\>

$3

$3

T

$3

value is Extract>

### isWeakSet

@xylabs/typeof

*

Call Signature

`ts
function isWeakSet(value): value is WeakSet;
`

$3

$3

unknown

$3

value is WeakSet

Call Signature

`ts
function isWeakSet(value): value is Extract>;
`

$3

$3

K extends WeakKey

$3

T extends WeakSet\<K\>

$3

$3

T

$3

value is Extract>

### typeOf

@xylabs/typeof

*

`ts
function typeOf(item): TypeOfTypes;
`

Type Parameters

$3

T

Parameters

$3

T

Returns

TypeOfTypes

### validateType

@xylabs/typeof

*

`ts
function validateType(
typeName,
value,
optional): [undefined | T, Error[]];
`

Type Parameters

$3

T

Parameters

$3

TypeOfTypes

$3

T

$3

boolean = false

Returns

\[undefined \| T, Error[]\]

$3

### AnyFunction

@xylabs/typeof

*

`ts
type AnyFunction = (...args) => unknown;
`

Parameters

$3

...unknown[]

Returns

unknown

### FieldType

@xylabs/typeof

*

`ts
type FieldType =
| "string"
| "number"
| "object"
| "symbol"
| "undefined"
| "null"
| "array"
| "function";
`

### ObjectTypeShape

@xylabs/typeof

*

`ts
type ObjectTypeShape = Record;
`

### RecordKey

@xylabs/typeof

*

`ts
type RecordKey = string | number | symbol;
`

### TypeOfTypes

@xylabs/typeof

*

`ts
type TypeOfTypes =
| "string"
| "number"
| "object"
| "array"
| "buffer"
| "null"
| "undefined"
| "bigint"
| "boolean"
| "function"
| "symbol";
`

### TypedArray

@xylabs/typeof

*

`ts
type TypedArray = TypedValue[];
`

### TypedKey

@xylabs/typeof

*

`ts
type TypedKey = T extends string ? T : string | number | symbol;
`

Type Parameters

$3

T extends string \| void = void

### TypedObject

@xylabs/typeof

*

`ts
type TypedObject =
| {
[key: string | number | symbol]: TypedValue;
}
| object;
`

### TypedValue

@xylabs/typeof

*

`ts
type TypedValue =
| bigint
| string
| number
| boolean
| null
| TypedObject
| TypedArray
| Function
| symbol
| undefined;
``

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[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

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/typeof
[socket-link]: https://socket.dev/npm/package/@xylabs/typeof