@langurama/checker
Version:
Retardedly basic checking for Node.js and the browser.
127 lines (76 loc) • 2.85 kB
Markdown
# @langurama/checker
[](https://github.com/langurama/checker/actions?query=workflow%3A%22Langurama+Checker%22)
[](https://codecov.io/gh/langurama/checker/branch/master)
[](https://www.npmjs.com/package/@langurama/checker)
[](https://github.com/langurama/checker/blob/master/LICENSE)
Due to the retardedness of JavaScript not including proper checking mechanisms this library was born out of fire and glory. This package is made for Node.js and the browser.
## Contents
- [ Install ](#install)
- [ Usage ](#usage)
- [ How it works ](#how-it-works)
- [ Development ](#development)
<a name="install"></a>
## Install
```
npm install --save-prod --save-exact @langurama/checker
```
<a name="usage"></a>
## Usage
### \<LanguramaChecker\>
#### isArray(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isAsyncFunction(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isBigint(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isBoolean(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isDate(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isError(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isFunction(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isGeneratorFunction(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isNan(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isNull(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isNumber(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isObject(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isPromise(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isString(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isSymbol(object)
- object **\<any\>**
- Returns: **\<boolean\>**
#### isUndefined(object)
- object **\<any\>**
- Returns: **\<boolean\>**
<a name="example"></a>
## Example
You may check the `example/` directory for runnable example files.
<a name="how-it-works"></a>
## How it works
This package transpiles code to `CommonJS` via `Babel` targeted at the current `Node.js` LTS version. To use this in the browser you will need to transpile it from `CommonJS` to your targeted browser(s).
## Development
When developing this library, it assumes that NPM is using the bash shell.
Remember to set the correct Git email when developing.