README
Variadic.js
A ES6 library of useful variadic functions.
Prerequisites
- Windows, Linux or Mac OS X
- NodeJS
Installing
npm install variadic.js --save
Using:
const variadic = require('variadic.js');
variadic.isOdd(1, 3, 5, 9); // true
variadic.isOdd(1, 3, 5, 9, 8); // false
or
const variadic = require('variadic.js/isEmpty');
variadic.isEmpty([], {}, 0); // true
variadic.isEmpty([0, 2, 3], {}, 0); // false
variadic.isEven(2, 4, 6); // error
Documenation
See DOCUMENTATION.md
Running the tests
npm test
And coding style tests
We use eslint that extends the airbnb-standard. You can read more here: airbnb/js
npm run lint
Deployment
Add additional notes about how to deploy this on a live system
Implemented Functions
List of possible functions and their implementation status, compiled by @D1esel-Dev:
General Types:
- Natural numbers
- Integers
- Rational numbers
- Irrational numbers
- Real numbers
- Imaginary numbers
- Complex numbers
- Hyper-Complex numbers
Number Representation:
- Decimal
- Binary
- Fractions
- Scientific notation
Signed Numbers:
- Positive real numbers
- Negative numbers
- Non-negative numbers
- Non-positive numbers
Types of integers:
- Even and odd numbers
- Prime number
- Composite number
Computability:
- Sum
- Factoral
- Minimum
- Maximum
- Range
- Average
- Mode
- Median
- Deviation
- Ascending
- Descending
- Absolute/magnitude (non-negative value of a number)
Built With
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
Grow with Google Scholars c/o 2018
See also the list of contributors who participated in this project.
Logo by @PepperAddict
License
This project is licensed under the MIT License - see the LICENSE file for details
Acknowledgments
- Hat tip to anyone who's code was used
- Inspiration
- etc