@utilify/types

Type Utilities

Type utility functions provide methods to check, compare, and manipulate data types. They help identify if a value is of a specific type, such as checking if a value is a number, string, function, or a primitive value, as well as other useful checks.

Installation

To install the type utility functions, use one of the following commands, depending on your package manager:

npm install @utilify/types

yarn add @utilify/types

pnpm add @utilify/types

Once installed, you can import the functions into your project, using either ESM or CJS.

Usage

This library supports both the ESM and CJS module systems.

import { isString } from '@utilify/types'; 

const { isString } = require('@utilify/types');  

Overview

Here is an overview of the functions available in the type utilities category:

getInstanceTypeType

function getInstanceTypeType(value: object): string | undefined 

Returns the instance type of the value.

getType

function getType(value: any): string 

Returns the primitive type or the type of the object (such as "string", "object", "function", etc.).

isArray

function isArray(value: any): boolean

Checks if the value is an array.

isAsync

function isAsync(callback: Function): boolean

Checks if the function is asynchronous.

isBigint

function isBigint(value: any): boolean  

Checks if the value is a BigInt.

isBoolean

function isBoolean(value: any): boolean  

Checks if the value is a boolean.

isDate

function isDate(value: any): boolean  

Checks if the value is an instance of Date.

isError

function isError(value: unknown): value is Error  

Checks if the value is an instance of Error.

isEqualType

function isEqualType(value1: any, value2: any): boolean  

Compares the types of two values and returns if they are the same.

isFalsy

function isFalsy(value: any): boolean  

Checks if the value is "falsy" (such as false, 0, null, undefined, NaN, or an empty string).

isFunction

function isFunction(value: any): boolean  

Checks if the value is a function.

isJSON

function isJSON(value: any): boolean  

Checks if the value is a valid JSON object.

isMap

function isMap(value: any): boolean  

Checks if the value is an instance of Map.

isNaN

function isNaN(value: any): boolean  

Checks if the value is NaN (Not-a-Number).

isNull

function isNull(value: any): boolean  

Checks if the value is null.

isNumber

function isNumber(value: any): boolean  

Checks if the value is a number.

isObject

function isObject(value: any): boolean  

Checks if the provided value is a plain object or an object created from a non-native class.

isPlainObject

function isPlainObject(value: any): boolean  

Checks if the value is a plain object (not an instance of Map, Set, or other objects).

isPrimitive

function isPrimitive(value: any): boolean  

Checks if the value is a primitive type (string, number, bigint, boolean, symbol, undefined, null).

isPromise

function isPromise(value: object): boolean  

Checks if the value is a Promise.

isRegExp

function isRegExp(value: any): boolean  

Checks if the value is a regular expression.

isSet

function isSet(value: any): boolean  

Checks if the value is an instance of Set.

isString

function isString(value: any): boolean  

Checks if the value is a string.

isSymbol

function isSymbol(value: any): boolean  

Checks if the value is a Symbol.

isTruthy

function isTruthy(value: any): boolean  

Checks if the value is "truthy" (any value that is not false, 0, null, undefined, NaN, or an empty string).

isUndefined

function isUndefined(value: any): boolean  

Checks if the value is undefined.

isWeakMap

function isWeakMap(value: unknown): value is WeakMap<any, any>  

Checks if the value is an instance of WeakMap.

isWeakSet

function isWeakSet(value: unknown): value is WeakSet<any>  

Checks if the value is an instance of WeakSet.