https://github.com/reydvires/general-function
A package for some general function and array operations
https://github.com/reydvires/general-function
Last synced: 8 months ago
JSON representation
A package for some general function and array operations
- Host: GitHub
- URL: https://github.com/reydvires/general-function
- Owner: ReydVires
- Created: 2021-01-05T17:01:25.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2021-01-06T00:37:49.000Z (almost 5 years ago)
- Last Synced: 2024-12-27T08:44:22.618Z (9 months ago)
- Language: JavaScript
- Size: 120 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# general-function
A package for some general function and array operations.
The functions included shuffle, sorting, and array checking.
## usage (ES6)
```javascript
import { shuffle, sortArrayOfNumber, sortArrayOfObject, sortArrayOfString } from "general-function";
const arrOfNum = [1, 2, 3, 4, 100, 0];
sortArrayOfNumber(arrOfNum); // Result: [0, 1, 2, 3, 4, 100]
sortArrayOfNumber(arrOfNum, true); // Result: [100, 4, 3, 2, 1, 0]
shuffle(arrOfNum);
const arrOfStr = ["A", "C", "B", "E", "Z", "Y"];
sortArrayOfString(arrOfStr); // Result: ["A", "B", "C", "E", "Y", "Z"];
sortArrayOfString(arrOfStr, true); // Result: ["Z", "Y", "E", "C", "B", "A"]
const arrOfObj = [
{
id: "011",
name: "Alex",
score: 87
},
{
id: "001",
name: "Brittle",
score: 90
},
{
id: "005",
name: "Caspian",
score: 91
}
];
sortArrayOfObject(arrOfObj, "name");
sortArrayOfObject(arrOfObj, "id", true);
```
## method
`shuffle(array)`
- array: unknown[]
`sortArrayOfNumber (array [, descending])`
- array: number[]
- descending?: boolean
`sortArrayOfString (array [, descending])`
- array: string[]
- descending?: boolean
`sortArrayOfObject (array, property [, descending])`
- array: object[]
- property: string
- descending?: boolean
`isArrayOfNumber (array)`
- array: unknown[]
- RETURN `boolean`
`isArrayOfString (array)`
- array: unknown[]
- RETURN `boolean`
`isArrayOfObject (array)`
- array: unknown[]
- RETURN `boolean`
NPM Package: [Link](https://npmjs.com/package/general-function)