/that-is

A JavaScript library that checks whether the value is of a specific type

Primary LanguageJavaScriptMIT LicenseMIT

That is


That-is is a utility javascript library for type checking, the purpose of the project is to help with flexibility and code optimization

> Installation

The project is designed to support both Node and Web environments, follow the instructions below to install:

  • Web Version

    • Download the latest version for the web distribution

    • Place the .js or .min.js file from the .zip inside your project

    • After you have placed the file, place the following code in your .html file:

      <script src="path/to/That-is.js"></script>

    • Note: all tools will be present in window.is.

  • Node Version

    • Use the platform npm to install the library:

      npm install @kivixeletric/that-is

    • After installation, you can use the library with require as in the example below:

      var is = require('@kivixeletric/that-is')

      but if you write in TypeScript and like to use the ESM system, then you can use this method:

      import is from '@kivixeletric/that-is'

> How to use

To use the library in your project is very simple, see the example below:

// Number Type
is.number('0') // will return a False
is.number(0)   // will return a True

// String Type
is.string('boo') // will return a True
is.string(true)  // will return a False

But if you want to do multiple checks of the same type, see the example below:

is.number(1, '2')    // False
is.number(1, 2)      // True
is.number(1, '2', 3) // False
is.number(1, 2, 3)   // True

But some functions will not have multiple values, for example is.divisible and is.equal

> Type List

~ Logical Types

  • type or a - (type, ...values) -> Checks if value is a selected type

  • defined or def - (...values) -> Checks if value is defined (is also applied to Object types)

  • typeEquals - (value1, value2) -> Checks if typeof value is equals a other typeof value

  • equals - (value1, value2) -> Checks if value is equals a other value

~ Numeric Types

  • decimal - (...values) -> Checks if value is decimal type

  • bigint - (...values) -> Checks if value is bigint type

  • divisible - (value, number) -> Checks if value is divisible with another number

  • infinite - (...values) -> Checks if value is a infinite type

~ Object Types

  • element or elem or node - (...values) -> Checks if value is node element type

  • object or obj - (...values) -> Checks if value is object type

  • array or arr - (...values) -> Checks if value is array type

~ Natural Types

  • number, num or int - (...values) -> Checks if value is number type

  • string or str - (...values) -> Checks if value is string type

  • boolean or bool - (...values) -> Checks if value is boolean type

  • function or fn - (...values) -> Checks if value is function type

  • symbol - (...values) -> Checks if value is symbol type

~ Special Types

  • regexp - (...values) -> Checks if value is RegExp type

> License