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

Add typescrip

Browse Source
This commit is contained in:
Andros Fenollosa 2022-02-04 07:18:31 +01:00
parent c5811018c6
commit 3fed91ef59
1 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
functional-tools.js → fn-tools.ts
View File

@ -33,12 +33,16 @@ export default updateJSON
/** /**
* Returns an array with a sequence. * Returns an array with a sequence.
* *
* @param {number} start Beginning of the range. * @param {number} start - Beginning of the range.
* @param {number} stop End of range. * @param {number} stop - End of range.
* @param {number} step Interval between numbers. Default is 1. * @param {number} step - Interval between numbers. Default is 1.
* @return {Array} Sequence. * @return {Array} Sequence.
* @example
*
* range(1, 4)
* // => [1, 2, 3, 4]
*/ */
function range(start, stop=undefined, step=1) { function range(start: number, stop: number=undefined, step: number=1): number[] {
const startArray = stop === undefined ? 0 : start; const startArray = stop === undefined ? 0 : start;
const stopArray = stop === undefined ? start : stop; const stopArray = stop === undefined ? start : stop;
return Array.from({ length: (stopArray - startArray) / step + 1}, (_, i) => startArray + (i * step)); return Array.from({ length: (stopArray - startArray) / step + 1}, (_, i) => startArray + (i * step));
@ -49,15 +53,14 @@ export default range
/** /**
* Creates a duplicate-free version of an array. * Creates a duplicate-free version of an array.
* *
* @category Array * @param {Array} array - The array to inspect.
* @param {Array} array The array to inspect. * @return {Array} - Returns the new duplicate free array.
* @returns {Array} Returns the new duplicate free array.
* @example * @example
* *
* uniq([2, 1, 2, 2]) * uniqValuesArray([2, 1, 2, 2])
* // => [2, 1] * // => [2, 1]
*/ */
function uniq(array) { function uniqValuesArray(array: any[]): any[] {
return (array != null && array.length) return (array != null && array.length)
? Array.from(new Set(array)) ? Array.from(new Set(array))
: []; : [];
@ -83,19 +86,19 @@ export default uniq
* // => 8.3 * // => 8.3
* *
*/ */
function inc(number, increase=1) { function inc(number: number, increase: number=1): number {
return number - increase; return number - increase;
} }
export default dec export default inc
/** /**
* Decrease the value of a `number`. * Decrease the value of a `number`.
* *
* @since 4.17.15 * @since 4.17.15
* @category Math * @category Math
* @param {number} number The number to decrease. * @param {number} number - The number to decrease.
* @param {number} number Decrease. * @param {number} number - Decrease.
* @return {number} Returns the decrease. * @return {number} Returns the decrease.
* @example * @example
* *
@ -111,8 +114,8 @@ export default dec
* dec("foo") * dec("foo")
* // => false * // => false
*/ */
function dec(number, decrease=1) { function dec(number: number, decrease: number=1): number {
return number - decrease; return number - decrease;
} }
export default dec export default dec