NOTE: The functions can be used in JavaScript but I do not recommend it.
import {
arrayIfy,
limitArray,
limitArrayify,
filterMap,
removeAll,
takeUntil,
waitUntil,
} from 'tyvn';
// arrayIfy:
const data: Set<string> = new Set();
data.add('hello');
data.add('world');
console.log(arrayIfy<Set<string>, string>(data)); // ['hello', 'world'];
// limitArray (known as chunk)
console.log(limitArray<string>(arrayIfy<Set<string>, string>(data), 1)); // [ [ 'hello' ], [ 'world' ] ]
// limitArrayify (convenience functions combining limitArray and arrayIfy)
console.log(limitArrayify<Set<string>, string>(data, 1)); // [ ['hello'], ['world'] ]
// filterMap
console.log(
filterMap<string, string>(
['a', 'th', 'is', 'wi', 'll', 'display'],
(accept, deny, value) => {
if (value.length == 2) {
return accept(value);
} else return deny();
}
)
); // ['th', 'is', 'wi', 'll'];
// removeAll
console.log(removeAll<string>(['hello', 'world', 'hello'], 'hello')); // ['world'];
// takeUntil
console.log(
takeUntil<string>(
['hello', 'world', 'this', 'will', 'not', 'be', 'displayed'],
(value: string, index: number) => index < 2
)
); // ['hello', 'world']
// waitUntil
console.log(
waitUntil<string>(
['hello', 'world', 'this', 'will', 'not', 'be', 'displayed'],
(value: string, index: number) => index > 2
)
); // ['hello', 'world', 'this']More info:
Arguments / Types
-
-
- : Typed argument, ie T/R
-
-
- : Param
-
arrayIfy: Turn Objects / Class' / other stuff into an Array.
-
-
- T: Type that will be expected for the input argument
-
-
-
- R: Type that the array should expect to return.
-
-
- input: T: Something inputted. Must have same type as T.
-
limitArray: "Chunk" an array into smaller arrays with a maximum length.
-
-
- R: Expected type for the Array. Do not wrap inside Array<> unless the input is an Array inside an Array.
-
-
- arr: Array<R>: Input. Must be an array of the type you specified.
-
- length: number: What the max length of each sub array is.
-
limitArrayify: Convenience function. Joins limitArray and arrayIfy togethor.
-
-
- T: Type that will be expected for the input argument
-
-
-
- R: Type that the array should expect to return.
-
-
- input: T: Something inputted. Must have same type as T.
-
- length: number: What the max length of each sub array is.
-
filterMap: Filter & map merged into one function.
-
-
- T: Type of the array that'll be inputted.
-
-
-
- R: The type you want the return array to be.
-
-
- arr: Array<T> The input array. Must be the same type as T
-
- filter: FilterFn<T,R>: The filter function. Looks like so:
(accept, deny, value, index, array)
- filter: FilterFn<T,R>: The filter function. Looks like so:
-
removeAll: Remove all elements from an Array that are equal to the specified param.
-
-
- T: The type of the array that will be inputted. Also applies for the value to filter out.
-
-
- arr: Array<T>: The input array. Must be an array of T
-
- value: T: The value to filter out. Must be the same as T.
-
takeUntil: Map through an Array until the specified function returns false.
-
-
- T: The type of the array that will be inputted.
-
-
- arr: Array<T>: The inputted array. Must be a type of T.
-
- until: UntilFn<T>: The function to decide whether or not to stop adding values to the final array. Looks like so:
(value, index, array)
- until: UntilFn<T>: The function to decide whether or not to stop adding values to the final array. Looks like so:
-
waitUntil: Map through an Array until the specified function returns true.
-
-
- T: The type of the array that will be inputted.
-
-
- arr: Array<T>: The inputted array. Must be a type of T.
-
- until: UntilFn<T>: The function to decide whether or not to stop adding values to the final array. Looks like so:
(value, index, array)
- until: UntilFn<T>: The function to decide whether or not to stop adding values to the final array. Looks like so:
import { addProp } from 'tyvn';
addProp<{ one: number; two: number }>(['one', 'two'], 5, { one: 1, two: 2 }); // 3
addProp<{ one: number; two: number }>('one', 5, { one: 1, two: 2 }); // 1
addProp<{ one: number; two: number }>(['one', 'two'], 5, {
one: 1,
two: 'Hello world!',
}); // 6 (you'll also be screamed as two should be a number!)
addProp<{ one: number; two: number }>(
['one', 'two'],
5,
0,
{ one: 6, two: 3 },
{ one: 9, two: 12 }
); // 30More info:
Arguments / Types
-
-
- : Typed argument, ie T/R
-
-
- : Param
-
addProp: Add properties togethor on objects inputted that will calculate a final sum. Supports default values.
-
-
- T: Type of the inputs that will be inputted.
-
-
- prop: keyof<T> | Array<keyof<T>>: Properties to be accounted for when adding up the numbers
-
- defaultValue: number: The default value that'll be added to the result if either the value on one of the inputs is not a number / doesn't exist.
-
- startValue: number: The base value.
-
- ...inputs: Array<T|Readonly<T>> The inputs. It's a sweeper so as many as you'd like can be added. Note that it has to be relatable to T. Either Readonly or an instance of the interface provided.