57 lines
2.1 KiB
Markdown
57 lines
2.1 KiB
Markdown
|
# famulus [](https://twitter.com/intent/tweet?hashtags=javascript%20%23helpers%20%23utilities&original_referer=https%3A%2F%2Fpublish.twitter.com%2F&ref_src=twsrc%5Etfw&text=JavaScript%20library%20that%20provides%20a%20useful%20functional%20programming%20helpers.%20Do%20not%20wait%2C%20add%20your%20own%20%F0%9F%94%A7%F0%9F%92%AA&tw_p=tweetbutton&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Ffamulus&via=shystrukk) #
|
||
|
|
[](https://opensource.org/licenses/mit-license.php) [](https://codecov.io/gh/shystruk/famulus) [](https://travis-ci.org/shystruk/famulus)
|
||
|
|
[](https://snyk.io/test/github/shystruk/famulus?targetFile=package.json)
|
||
|
|
[](https://badge.fury.io/js/famulus)
|
||
|
|
|
||
|
|
JavaScript library that provides a useful functional programming helpers. Do not wait, fork and add your own 🔧💪
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
#### npm
|
||
|
|
`npm install --save famulus`
|
||
|
|
|
||
|
|
#### yarn
|
||
|
|
`yarn add famulus --save`
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
#### ES6 module
|
||
|
|
```javascript
|
||
|
|
import famulus from 'famulus'
|
||
|
|
```
|
||
|
|
```javascript
|
||
|
|
import helper from 'famulus/helper'
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Node.js
|
||
|
|
```javascript
|
||
|
|
const famulus = require('famulus')
|
||
|
|
```
|
||
|
|
```javascript
|
||
|
|
const helper = require('famulus/helper')
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
### String
|
||
|
|
- [substr](docs/substr.md)
|
||
|
|
|
||
|
|
|
||
|
|
### Object
|
||
|
|
- [objectInterface](docs/objectInterface.md)
|
||
|
|
|
||
|
|
|
||
|
|
### Array
|
||
|
|
- [sortAndAddFirstElement](docs/sortAndAddFirstElement.md)
|
||
|
|
- [isValuesUnique](docs/isValuesUnique.md)
|
||
|
|
|
||
|
|
|
||
|
|
### Date
|
||
|
|
- [dateDifferenceFromNow](docs/dateDifferenceFromNow.md)
|
||
|
|
- [dateDifference](docs/dateDifference.md)
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Please read the [Contributions Guidelines](CONTRIBUTING.md) before adding your own helper or improvement to code snippets, explanations, etc.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [Vasyl Stokolosa](https://about.me/shystruk)
|