modulo-n
v1.0.10
Published
Get unique number results based on unique inputs using modulo-n classes.
Downloads
8
Maintainers
Readme
modulo-n
Get unique number results based on unique inputs using modulo-n classes.
For a specific integer and range, you will always get the same number result. It could happen to find different inputs for which the result will be the same. That's expected.
:cloud: Installation
# Using npm
npm install --save modulo-n
# Using yarn
yarn add modulo-n
:clipboard: Example
const moduloN = require("modulo-n");
console.log(moduloN(42, 4, 8));
// => 6
console.log(moduloN(42, 2, 8));
// => 2
console.log(moduloN(43, 2, 8));
// => 3
:question: Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
moduloN(n, min, max)
Returns a number that will be unique for a specific n
and range.
Params
- Number
n
: The input number. - Number
min
: The minimum number in the range. - Number
max
: The maximum number in the range.
Return
- Number A number that will greater or equal to
min
but lower thanmax
and will be always the same for the same range and samen
.
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
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, there are few ways you can do it:
Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
numberly