https://github.com/lcluber/ch.js
Type checking library to test if a variable is what it is supposed to be
https://github.com/lcluber/ch.js
checker checker-library javascript typescript
Last synced: 5 months ago
JSON representation
Type checking library to test if a variable is what it is supposed to be
- Host: GitHub
- URL: https://github.com/lcluber/ch.js
- Owner: LCluber
- License: mit
- Created: 2018-12-23T14:55:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T06:12:29.000Z (8 months ago)
- Last Synced: 2024-11-09T07:48:12.315Z (7 months ago)
- Topics: checker, checker-library, javascript, typescript
- Language: JavaScript
- Homepage:
- Size: 877 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
### This project has been transferred to [DWTechs](https://github.com/DWTechs/CheckHard.js) and is now called [CheckHard.js](https://github.com/DWTechs/CheckHard.js).
### Please update your project dependencies to [CheckHard.js](https://github.com/DWTechs/CheckHard.js) as Ch.js will not be updated anymore.
-------------------------------
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/@lcluber/chjs)
[](https://www.npmjs.com/package/@lcluber/chjs)
- [Synopsis](#synopsis)
- [Motivation](#motivation)
- [Installation](#installation)
- [npm](#npm)
- [Yarn](#yarn)
- [Usage](#usage)
- [ES6](#es6)
- [CommonJS](#commonjs)
- [IIFE](#iife)
- [API Reference](#api-reference)
- [Contributors](#contributors)
- [License](#license)
- [Stack](#stack)
## Synopsis
**[Ch.js](https://github.com/LCluber/Ch.js)** is an open source type checking library for Javascript.
## Motivation
The goal of this library is to provide an easy way to check if a variable is what it is supposed to be. Function, object, ascii, boolean, integer, string, json, email...
## Installation
### npm
```bash
$ npm i @lcluber/chjs
```
### Yarn
```bash
$ yarn add @lcluber/chjs
```
## Usage
### ES6
```javascript
import { isFunction, isArray } from "@lcluber/chjs";
if (isFunction(variable)) {
//variable is a function
}
if (!isArray(variable)) {
//variable is not an array
}
```
### CommonJS
```javascript
const ch = require("@lcluber/chjs/dist/ch.cjs");
if (ch.isFunction(variable)) {
//variable is a function
}
if (!ch.isArray(variable)) {
//variable is not an array
}
```
### IIFE
```html
```
```javascript
if (Ch.isFunction(variable)) {
//variable is a function
}
if (!Ch.isArray(variable)) {
//variable is not an array
}
```
## API Reference
```javascript
isBoolean(bool: any): boolean {}
isJson(string: any): boolean {}
isFunction(func: any): boolean {}
isObject(object: any): boolean {}
isArray(array: any): boolean {}
isAscii(code: any, extended: boolean = false): boolean {}
isInteger(number: any, typeCheck: boolean = true): boolean {}
isFloat(number: any, typeCheck: boolean = true): boolean {}
// Find out if a variable is a numeric value, including exponential notation, hexadecimal value, etc
isNumber(number: any, typeCheck: boolean = true): boolean {}
isString(string: any): boolean {}
isHtmlElement(htmlElement: any): boolean {}
isHtmlEventAttribute(htmlEventAttribute: any): boolean {}
isNode(node: any): boolean {}
isEven(number: any, typeCheck: boolean = true): boolean {}
isOdd(number: any, typeCheck: boolean = true): boolean {}
isOrigin(number: any, typeCheck: boolean = true): boolean {}
isPositive(number: any, typeCheck: boolean = true): boolean {}
isNegative(number: any, typeCheck: boolean = true): boolean {}
isPowerOfTwo(number: any, typeCheck: boolean = true): boolean {}
isRegex(regex: any, typeCheck: boolean = true): boolean {}
isEmail(email: any): boolean {}
isIpAddress(ipAddress: any): boolean {}
```
## Contributors
Ch.js is still in development and I would be glad to get all the help you can provide for this project.
To contribute please read **[NOTICE.md](https://github.com/LCluber/Ch.js/blob/master/NOTICE.md)** for detailed installation guide.
## License
**[MIT](https://github.com/LCluber/Ch.js/blob/master/LICENSE.md)**
## Stack
| Purpose | Choice | Motivation |
| :-------------- | :------------------------------------------: | -------------------------------------------------------------: |
| repository | [Github](https://github.com/) | hosting for software development version control using Git |
| package manager | [npm](https://www.npmjs.com/get-npm) | default node.js package manager |
| type checking | [TypeScript](https://www.typescriptlang.org) | static type checking along with the latest ECMAScript features |
| module bundler | [Rollup.js](https://rollupjs.org) | advanced module bundler for ES6 modules |
| unit testing | [Jest](https://jestjs.io/) | delightful testing with a focus on simplicity |