type-checks
A collection of JavaScript type checks, written in TypeScript.
Install
Install via npm:
npm install @amandaghassaei/type-checks
import { isNumber, isInteger } from '@amandaghassaei/type-checks';
Table of contents
Functions
- isNumber
- isFiniteNumber
- isInteger
- isPositiveNumber
- isPositiveInteger
- isNegativeNumber
- isNegativeInteger
- isNonNegativeNumber
- isNonNegativeInteger
- isNonPositiveNumber
- isNonPositiveInteger
- isNumberInRange
- isIntegerInRange
- isString
- isTypedArray
- isArray
- isObject
- isBoolean
Functions
isNumber
▸ isNumber(value): boolean
Checks if value is a number (including Infinity).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isFiniteNumber
▸ isFiniteNumber(value): boolean
Checks if value is finite number.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isInteger
▸ isInteger(value): boolean
Checks if value is integer.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isPositiveNumber
▸ isPositiveNumber(value): boolean
Checks if value is positive number (> 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isPositiveInteger
▸ isPositiveInteger(value): boolean
Checks if value is positive integer (> 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isNegativeNumber
▸ isNegativeNumber(value): boolean
Checks if value is negative number (< 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isNegativeInteger
▸ isNegativeInteger(value): boolean
Checks if value is negative integer (< 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isNonNegativeNumber
▸ isNonNegativeNumber(value): boolean
Checks if value is non-negative number (>= 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isNonNegativeInteger
▸ isNonNegativeInteger(value): boolean
Checks if value is non-negative integer (>= 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isNonPositiveNumber
▸ isNonPositiveNumber(value): boolean
Checks if value is non-positive number (<= 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isNonPositiveInteger
▸ isNonPositiveInteger(value): boolean
Checks if value is non-positive integer (<= 0).
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isNumberInRange
▸ isNumberInRange(value, min, max): boolean
Checks if value is number in range [min, max].
Parameters
| Name | Type |
|---|---|
value | any |
min | number |
max | number |
Returns
boolean
isIntegerInRange
▸ isIntegerInRange(value, min, max): boolean
Checks if value is integer in range [min, max].
Parameters
| Name | Type |
|---|---|
value | any |
min | number |
max | number |
Returns
boolean
isString
▸ isString(value): boolean
Checks if value is string.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isTypedArray
▸ isTypedArray(value): boolean
Checks if value is TypedArray.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isArray
▸ isArray(value): boolean
Checks if value is Array or TypedArray.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isObject
▸ isObject(value): boolean
Checks if value is Javascript object.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean
isBoolean
▸ isBoolean(value): boolean
Checks if value is boolean.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
boolean