andros/micro-fp-tools-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andros Fenollosa 2022-02-10 09:53:37 +01:00 committed by GitHub
parent c35eaa5c5b
commit 70c66869a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -2,30 +2,6 @@
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
@ -44,6 +20,34 @@ range(4);
<script type="module" src="https://cdn.jsdelivr.net/gh/tanrax/fn-js/dist/fnTools.min.js"></script>
```
## Documentation
### 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.
- **getUniqFiles**: Returns an Array from the union of 2 Arrays of Files avoiding repetitions.
## Compile
Install Typescript