micro-fp-tools-js/README.md
2022-02-10 09:39:22 +01:00

62 lines
1.3 KiB
Markdown

# fnTools
Simple functional functions common to any development in Typescript or JavaScript.
## Number
- **inc**: Increase the value of a `number`.
- **dec**: Decrease the value of a `number`.
- **getRandom**: Returns a random number from a range, with an optional number of decimal places.
## Array
- **range**: Returns an array with a sequence.
- **uniqValuesArray**: Creates a duplicate-free version of an array.
- **deleteArrayElementByIndex**: Returns a copy of the array by removing one position by index.
- **arraySwapIndex**: Returns a copy of the Array by swapping 2 indices.
## JSON
- **cloneJSON**: Clone JSON.
- **updateJSON**: Returns a JSON with an updated value.
## File
- **getIndexOfFileList**: Returns the index of an Array of Files from its name. If there are multiple files with the same name, the last one will be returned.
- **arrayFilesToFileList**: Returns a FileLists from an array containing Files.
- **encodeFileToText**: Returns a File in text.
## Example
```javascript
import {getRandom, range} from 'fnTools.js';
getRandom(0, 6);
// 2
range(4);
// [0, 1, 2, 3, 4]
```
## CDN
```html
<script type="module" src="https://cdn.jsdelivr.net/gh/tanrax/fn-js/dist/fnTools.min.js"></script>
```
## Compile
Install Typescript
```shell
npm install -g typescript
```
And build.
```shell
make build
````
Check 'dist' folder.