https://github.com/emreavcilar/easy-js-utils
easy-js-utils is a package of helper functions.
https://github.com/emreavcilar/easy-js-utils
array array-utils date helper helper-functions helper-lib helpers snippet snippets snippets-collection snippets-library string string-utilities string-utility utilities utility utility-library
Last synced: 2 months ago
JSON representation
easy-js-utils is a package of helper functions.
- Host: GitHub
- URL: https://github.com/emreavcilar/easy-js-utils
- Owner: emreavcilar
- License: mit
- Created: 2019-10-19T22:04:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T08:50:36.000Z (about 2 years ago)
- Last Synced: 2024-01-25T23:12:55.489Z (over 1 year ago)
- Topics: array, array-utils, date, helper, helper-functions, helper-lib, helpers, snippet, snippets, snippets-collection, snippets-library, string, string-utilities, string-utility, utilities, utility, utility-library
- Language: JavaScript
- Homepage:
- Size: 84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# easy-js-utils
Table of Contents
=================
* [easy-js-utils](#easy-js-utils)
* [Installation](#installation)
* [Usage](#usage)
* [API](#api)
* [Array utilities](#array-utilities)
* [differenceBetweenTwoArrays](#differenceBetweenTwoArrays)
* [countofElements](#countofElements)
* [getMaxElementInArray](#getMaxElementInArray)
* [getMinElementInArray](#getMinElementInArray)
* [sumOfElementsInArray](#sumOfElementsInArray)
* [selectRandomFromArray](#selectRandomFromArray)
* [String utilities](#string-utilities)
* [revertString](#revertString)
* [excerpt](#excerpt)
* [highlightText](#highlightText)
* [unHighlightText](#unHighlightText)
* [camelize](#camelize)
* [Date utilities](#date-utilities)
* [isDate](#isDate)
* [Number utilities](#number-utilities)
* [addComas](#addComas)
* [License](#license)
easy-js-utils
=============
**easy-js-utils** is a package of helper functions.
Installation
------------
It's recommended to install via [npm](https://github.com/isaacs/npm/):
npm install easy-js-utils --save
Usage
=====
**easy-js-utils** has no external dependencies
```javascript
//ES5
var arrayUtils = require('easy-js-utils/lib/arrayUtils')
arrayUtils.countofElements(['Lemon', 'Orange', 'Strawberry', 'Strawberry', 'Orange', 'Banana', 'Strawberry']);
//ES6
import {countOfElements} from 'easy-js-utils/lib/arrayUtils'
countofElements(['Lemon', 'Orange', 'Strawberry', 'Strawberry', 'Orange', 'Banana', 'Strawberry'])
```
API
===
Array Utilities
------------------------
**differenceBetweenTwoArrays**
Returns the different elements between two arrays
```javascript
import {differenceBetweenTwoArrays} from 'easy-js-utils/lib/arrayUtils'
differenceBetweenTwoArrays(['1','2','3'],['2','3'])
//returns ['1']
```
**countofElements**
Returns the object of the count of elements in an array by key value pairings.
```javascript
import {countOfElements} from 'easy-js-utils/lib/arrayUtils'
countofElements(['Lemon', 'Orange', 'Strawberry', 'Strawberry', 'Orange', 'Banana', 'Strawberry','Banana'])
//returns { Lemon: 1, Orange: 2, Strawberry: 3, Banana: 2 }
```
**getMaxElementInArray**
Returns the maximum number in an Array. If array includes different types only numbers are compared
```javascript
import {getMaxElementInArray} from 'easy-js-utils/lib/arrayUtils'
getMaxElementInArray([2, 3, 4.1, 4.2 , 7, 123.456, 'test1', 'test2', false])
//returns 123.456
```
**getMinElementInArray**
Returns the minimum number in an Array. If array includes different types only numbers are compared
```javascript
import {getMinElementInArray} from 'easy-js-utils/lib/arrayUtils'
getMinElementInArray([2, 3, 4.1, 4.2 , 7, 123, 'test1', 'test2', false])
//returns 2
```
**sumOfElementsInArray**
Returns the sum of elements in an array.
```javascript
import {sumOfElementsInArray} from 'easy-js-utils/lib/arrayUtils'
sumOfElementsInArray([1,2,3])
//returns 6
```
**selectRandomFromArray**
Returns a random element from given array
```javascript
import {selectRandomFromArray} from 'easy-js-utils/lib/arrayUtils'
selectRandomFromArray(['test',2,true,[123]])
//returns an element from array
```
String Utilities
----------------
**revertString**
Returns the reverted string
```javascript
import {revertString} from 'easy-js-utils/lib/stringUtils'
revertString('abcd')
//returns dcba
```
**excerpt**
Reduces the text by word count limit. Works same in wordpress excerpt
```javascript
import {excerpt} from 'easy-js-utils/lib/stringUtils'
excerpt('lorem ipsum dolor sit amet', 3)
//returns lorem ipsum dolor…
```
**highlightText**
Highlight the text according to given parameters
```javascript
import {highlightText} from 'easy-js-utils/lib/stringUtils'
highlightText('lorem ipsum dolor sit amet')
//returns lorem
ipsum
dolor sit
amet
```
**unHighlightText**
Unhighlight the text according to given parameters
```javascript
import {unHighlightText} from 'easy-js-utils/lib/stringUtils'
unHighlightText('lorem
ipsum dolor sit amet', 'p')
//returns lorem ipsum dolor sit amet
```
**camelize**
Convert any string to camelcase
```javascript
import {camelize} from 'easy-js-utils/lib/stringUtils'
unHighlightText('Lorem ipsum dolor sit amet')
//returns loremIpsumDolorSitAmet
```
Date Utilities
-------------------------
**isValidDate**
Returns false if the given date is not valid with the given format
```javascript
import {isValidDate} from 'easy-js-utils/lib/dateUtils'
isValidDate('05-11-2015','dd-mm-yy') //returns true
isValidDate('31-11-2015','dd-mm-yy') //returns false
```
Number Utilities
-------------------------
**addComas**
Returns string format of given number with separated given character
```javascript
import {addComas} from 'easy-js-utils/lib/numberUtils'
addComas(123456789,'.') //returns 123.456.789
```
License
=======
See [LICENSE](https://github.com/emreavcilar/easy-js-utils/blob/master/LICENSE) file.