From 70c66869a014b657c6ffc89c7cd45d463b4f4f70 Mon Sep 17 00:00:00 2001 From: Andros Fenollosa Date: Thu, 10 Feb 2022 09:53:37 +0100 Subject: [PATCH] Update README.md --- README.md | 52 ++++++++++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 16ed8fc..6126598 100644 --- a/README.md +++ b/README.md @@ -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); ``` +## 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