https://github.com/thiagodnf/check-arguments

A little javascript library for checking argument values
https://github.com/thiagodnf/check-arguments

arguments checking parameters type-check validate

Last synced: about 1 month ago
JSON representation

A little javascript library for checking argument values

• Host: GitHub
• URL: https://github.com/thiagodnf/check-arguments
• Owner: thiagodnf
• License: mit
• Created: 2022-06-13T00:53:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-08T20:07:48.000Z (over 2 years ago)
• Last Synced: 2024-04-09T21:14:29.449Z (9 months ago)
• Topics: arguments, checking, parameters, type-check, validate
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/check-arguments
• Size: 176 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



A little javascript library for checking argument values

[![Build](https://github.com/thiagodnf/check-arguments/actions/workflows/build.yml/badge.svg)](https://github.com/thiagodnf/check-arguments/actions/workflows/build.yml)

[![GitHub Release](https://img.shields.io/github/release/thiagodnf/check-arguments.svg)](https://github.com/thiagodnf/check-arguments/releases/latest)

[![GitHub contributors](https://img.shields.io/github/contributors/thiagodnf/check-arguments.svg)](https://github.com/thiagodnf/check-arguments/graphs/contributors)

[![GitHub stars](https://img.shields.io/github/stars/thiagodnf/check-arguments.svg)](https://github.com/thiagodnf/check-arguments)

[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

## Why

It takes time to add explicit conditions to your functions to check arguments and throw errors. The purpose of this library is to assist developers on writing efficiently and reliably those conditions.

## How Do I Install It?

Via NPM:

```sh

npm i check-arguments --save

```

## How to I Use It?

Loading the library:

```js

const { check } = require("check-arguments");

```

Now you can use it on your functions:

```js

function foo(val){

    check(val).isString().isNotBlank();

    // The remaining source code

}

```

or

```js

function foo(a, b){

    check(a).isInt().isBetween(12, 20);

    check(b).isString();

    // The remaining source code

}

```

### Predicates

These are the list of predicates you may use

For `isNumber()`:

 - `isLessThan(max)`

 - `isLessThanOrEqualsTo(max)`

 - `isGreaterThan(min)`

 - `isGreaterThanOrEqualsTo(min)`

 - `isBetween(min, max)`

 - `inRange(min, max)`

 - `isPositive()`

 - `isNegative()`

For `isInt()`:

 - `isEven()`

 - `isOdd()`

For `isString()`:

 - `isNotBlank()`

For `isObject()`:

 - `hasKey()`

 - `isEmpty()`

## For Developers

Install the dependencies

```bash

npm install

```

Run the development enviroment

```bash

npm run dev

```

## Questions or Suggestions

Feel free to access the discussions tab as you need

## Contribute

Contributions to the this project are very welcome! We can't do this alone! Feel free to fork this project, work on it and then make a pull request.

## License

Licensed under the [MIT license](LICENSE).

## Donate

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, reach out to me if you want to do it.

Thanks!

❤️