A read only List or Dictionary
A read only dictionary. Keys are strings and values are of the same type T
The dictionary item type
A key and value pair - a dictionary entry
The entry item type
A function with one argument
A function with two arguments
A function with three arguments
Optional value
A function returning a boolean value
Assigns the entries of one object to another
the first object type
the second object type
An object
Another object
A new object containing all entries in a overridden with entries of b
If an entry with the same key exists in both a and b the entries from b will be in the result
Removes null or undefined values from the dictionary
The Dictionary to remove from
A collection without null or undefined values
Check if every item in this collection satisfies a predicate
The Collection item type
A Collection to check
true if every item in this collection satisfies the predicate and false otherwise
Check if every item in this collection satisfies a predicate
The Collection item type
A function accepting a collection and returning true if every item in this collection satisfies predicate and false otherwise
Returns a dictionary containing entries who's values satisfies the predicate
The Dictionary
The Predicate
A filtered Dictionary
The curried version of the filteredDictionary
A function accepting a dictionary and returning a filtered dictionary
Find if an item exists in a collection
The type of the collection item
The first item that satisfies the predicate or undefined if no item satisfies the predicate In case that the collection is a Dictionary, the entries are not ordered so if more than one item satisfies the predicate an arbitrary one will be returned
The curried version of find
The type of the collection item
A function accepting a collection and optionally returning an item
Composes and executes several functions
The input to the composed function
See below
See below
See below
See below
See below
the last function's output
The f1..f5 functions are executed in order, the first one is fed with values
and each output is fed to the next function's input.
See the docs for the first overload
See the docs for the first overload
See the docs for the first overload
See the docs for the first overload
Get a value by key
The type of an object
The type of the keys of T
An object
A key
The value in obj for key
Group a list into a dictionary of lists
The list and dictionary item type
A list
A function producing a string key to group by
A dictionary with keys returned from by and lists of corresponding items from list
The order in each group is the order of the items in list
Checks if a key exists
The type of an object
An object
A key
true if key exists in obj and false otherwise
Returns the first item in a list or throws an error if the list is empty
A list
The first item in the list
The identity function - returns the accepted value
An input
The input
Returns a new dictionary with the keys and values of dict inverted.
If dict contains duplicate values, one of them will be chosen arbitrarily.
A dictionary
An inverted dictionary
Returns a new dictionary with keys from calling by.
The item for a key is the last item in list return from by for that key.
A list
A function that returns a key for a given item
Returns the keys of the dictionary
A dictionary
a list of keys
Dictionary map
The element type of the input dictionary.
The element type of the transformed dictionary.
The dictionary to transform.
A transform function.
A transformed dictionary
Curried Dictionary map
The element type of the input dictionary.
The element type of the transformed dictionary.
A transform function.
A function that accepts a dictionary and returns a transformed dictionary
Omits keys from an object
The type of an object
The type of the keys of T
An object
A list of keys in obj
An object with all entries with key in keys removed
Picks keys from an object
The type of an object
The type of the keys of T
An object
A list of keys in obj
An object with entries where the entry key is in keys
Sets a value for a key in an object
The type of an object
The type of the keys of T
An object
A key
A value
A new object with the value set for key
Check if some items in this collection satisfies a predicate
The Collection item type
A Collection to check
true if some items in this collection satisfies the predicate and false otherwise
Check if every item in this collection satisfies a predicate
The Collection item type
A function accepting a collection and returning true if some item in this collection satisfies the predicate and false otherwise
Sort a list
The list item type
A list
A function returning a sort value for a given item
The list is sorted by the value return from by. In case by returns an array of values,
the list is primarily sorted by the 1st value, secondarily sorted by the 2nd value and so on
Update a value for a key on an object
The type of an object
The type of the keys of T
An object
A key
An updater function accepting the existing value and returning a new value
A new object with the new value returned from calling f set for key
Returns the values of a dictionary
The type of the dictionary item
A dictionary
A list of the dictionary values
Zip two lists
the left list item type
the right list item type
A list of tuples where each tuple has values from the corresponding * items in left and right
If the lists are of different sizes, the returned list will have tuples where either left or right
will be undefined. This way, the list is guarantied to include tuples with left and right values.
See zipShort for comparison.
Zip two lists
the left list item type
the right list item type
A list of tuples where each tuple has values from the corresponding items in left and right
If the lists are of different sizes, the returned list will have a size of a the shorter list.
This way, the list is guarantied to include tuples with left and right values. See zipShort for comparison.
Generated using TypeDoc
A type representing general objects