Type.md

myhelpers / Type

Namespace: Type

Table of contents

Enumerations

• EnumTypes

Type aliases

• TObject
• TObjectKey
• TypedArray
• TypedArrayConstructor

Functions

• getContentType
• getEnumType
• is
• isAlphaSequence
• isArray
• isArrayType
• isAsyncFunction
• isAsyncIterable
• isBlob
• isBoolean
• isBuffer
• isDate
• isEmailFormat
• isEmpty
• isError
• isFloat32Array
• isFloat64Array
• isFunction
• isFunctionType
• isInt16Array
• isInt32Array
• isInt8Array
• isInteger
• isIterable
• isKind
• isKindEqual
• isMap
• isNull
• isNullOrUndefined
• isNumber
• isNumeric
• isNumericSequence
• isObject
• isPlainObject
• isPrimitive
• isPromise
• isRegExp
• isSequence
• isSet
• isString
• isSymbol
• isTypedArray
• isUint16Array
• isUint32Array
• isUint8Array
• isUint8ClampedArray
• isUndefined
• isUrlRelative
• kindOf

Type aliases

TObject

Ƭ TObject: Record<TObjectKey, unknown>

---

TObjectKey

Ƭ TObjectKey: string | symbol | number

---

TypedArray

Ƭ TypedArray: Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array

TypedArray Types

---

TypedArrayConstructor

Ƭ TypedArrayConstructor: Int8ArrayConstructor | Uint8ArrayConstructor | Uint8ClampedArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Int32ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor | Float64ArrayConstructor

Functions

getContentType

▸ getContentType(ext): string

Return content type from extension

Parameters

Name	Type
ext	string

Returns

string

---

getEnumType

▸ getEnumType(arg): EnumTypes

Return the Enum value of the type of the argument

Parameters

Name	Type
arg	unknown

Returns

EnumTypes

---

is

▸ is(arg1, arg2): boolean

Check if to arguments are equal "==="

Parameters

Name	Type
arg1	unknown
arg2	unknown

Returns

boolean

---

isAlphaSequence

▸ isAlphaSequence(arg, regex?): boolean

Check if argument is a alpha sequence of type a..z or as defined by regex argument

Parameters

Name	Type
arg	unknown
regex?	RegExp

Returns

boolean

---

isArray

▸ isArray(arg): boolean

Check if argument is an array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isArrayType

▸ isArrayType(arg): boolean

Check if argument is Array or TypedArray

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isAsyncFunction

▸ isAsyncFunction(arg): boolean

Check if argument is AsyncFunction

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isAsyncIterable

▸ isAsyncIterable(arg): boolean

Check if argument is AsyncIterable

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isBlob

▸ isBlob(arg): boolean

Check if argument is a blob

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isBoolean

▸ isBoolean(arg): boolean

Check if argument is Boolean

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isBuffer

▸ isBuffer(arg): boolean

Check if argument is Buffer

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isDate

▸ isDate(arg): boolean

Check if argument is Date

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isEmailFormat

▸ isEmailFormat(arg, matches?): boolean | null | string[]

Simple check if argument is in e-mail format

Parameters

Name	Type	Default value
arg	string	undefined
matches	boolean	false

Returns

boolean | null | string[]

---

isEmpty

▸ isEmpty(arg): boolean

Check if argument is empty

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isError

▸ isError(arg): boolean

Check if argument is Error

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isFloat32Array

▸ isFloat32Array(arg): boolean

Check if argument is Float32Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isFloat64Array

▸ isFloat64Array(arg): boolean

Check if argument is Float64Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isFunction

▸ isFunction(arg): boolean

Check if argument is function

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isFunctionType

▸ isFunctionType(arg): boolean

Check if argument is Function or AsyncFunction

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isInt16Array

▸ isInt16Array(arg): boolean

Check if argument is Int16Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isInt32Array

▸ isInt32Array(arg): boolean

Check if argument is Int32Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isInt8Array

▸ isInt8Array(arg): boolean

Check if argument is Int8Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isInteger

▸ isInteger(arg): boolean

Check if argument is Integer

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isIterable

▸ isIterable(arg): boolean

Check if argument is Iterable

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isKind

▸ isKind(arg, kind): boolean

Check if argument is of the kind

Parameters

Name	Type	Description
arg	unknown
kind	string	Kind to match the type

Returns

boolean

---

isKindEqual

▸ isKindEqual(arg1, arg2): boolean

Check if two arguments are of same type

Parameters

Name	Type
arg1	unknown
arg2	unknown

Returns

boolean

---

isMap

▸ isMap(arg): boolean

Check if argument is Map

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isNull

▸ isNull(arg): boolean

Check if argument is null

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isNullOrUndefined

▸ isNullOrUndefined(arg): boolean

Check if argument is null or undefined

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isNumber

▸ isNumber(arg): boolean

Check if argument is Number

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isNumeric

▸ isNumeric(arg): boolean

Check if argument is numeric type, check if is number or a string that can be converted into number

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isNumericSequence

▸ isNumericSequence(arg, regex?): boolean

Check if argument is a numeric sequence of type 1..5 or as defined by regex argument

Parameters

Name	Type
arg	unknown
regex?	RegExp

Returns

boolean

---

isObject

▸ isObject(arg): boolean

Check if argument is Object

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isPlainObject

▸ isPlainObject(arg): boolean

Check if argument is a plain object

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isPrimitive

▸ isPrimitive(arg): boolean

Check if argument is of primitive type

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isPromise

▸ isPromise(arg): boolean

Check if argument is a Promise

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isRegExp

▸ isRegExp(arg): boolean

Check if argument is RegExp

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isSequence

▸ isSequence(arg, regex): boolean

Check if argument is a sequence based on given regexp

Parameters

Name	Type
arg	unknown
regex	RegExp

Returns

boolean

---

isSet

▸ isSet(arg): boolean

Check if argument is Set

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isString

▸ isString(arg): boolean

Check if argument is String

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isSymbol

▸ isSymbol(arg): boolean

Check if argument is Symbol

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isTypedArray

▸ isTypedArray(arg): boolean

Check if argument is TypedArray

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isUint16Array

▸ isUint16Array(arg): boolean

Check if argument is Uint16Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isUint32Array

▸ isUint32Array(arg): boolean

Check if argument is Uint32Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isUint8Array

▸ isUint8Array(arg): boolean

Check if argument is Uint8Array

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isUint8ClampedArray

▸ isUint8ClampedArray(arg): boolean

Check if argument is Uint8ClampedArray

Parameters

Name	Type
arg	unknown

Returns

boolean

---

isUndefined

▸ isUndefined(arg?): boolean

Check if argument is Undefined

Parameters

Name	Type
arg?	unknown

Returns

boolean

---

isUrlRelative

▸ isUrlRelative(url): boolean

Returns a value indicating whether a URL is relative. A relative URL does not have host info part.

Parameters

Name	Type	Description
url	string	the URL to be checked

Returns

boolean

whether the URL is relative

---

kindOf

▸ kindOf(arg): string

Return a string with the type of the object

Parameters

Name	Type
arg	unknown

Returns

string