Function toSortedDictionary

toSortedDictionary<TElement, TKey, TValue>(
    source: Iterable<TElement>,
    keySelector: Selector<TElement, TKey>,
    valueSelector: Selector<TElement, TValue>,
    keyComparator?: OrderComparator<TKey, TKey>,
    valueComparator?: EqualityComparator<TValue, TValue>,
): SortedDictionary<TKey, TValue>
Materialises source into a sorted dictionary keyed by the provided selector.
Type Parameters
- TElement
  Type of elements within source.
- TKey
  Type of key returned by keySelector.
- TValue
  Type of value returned by valueSelector.
Parameters
- source: Iterable<TElement>
  The source iterable.
- keySelector: Selector<TElement, TKey>
  Selector used to derive the key for each element.
- valueSelector: Selector<TElement, TValue>
  Selector used to derive the value for each element.
- OptionalkeyComparator: OrderComparator<TKey, TKey>
  Optional order comparator used to sort keys in the resulting dictionary.
- OptionalvalueComparator: EqualityComparator<TValue, TValue>
  Optional equality comparator used to compare values in the resulting dictionary.
Returns SortedDictionary<TKey, TValue>
A sorted dictionary populated with the projected key/value pairs.
Throws
Thrown when keySelector produces duplicate keys.

Remarks
The entire sequence is enumerated immediately.
Example
```
const people = [
  { id: 2, name: 'Bob' },
  { id: 1, name: 'Alice' },
];
const sortedDictionary = toSortedDictionary(people, p => p.id, p => p.name);
console.log(sortedDictionary.keys().toArray()); // [1, 2]
console.log(sortedDictionary.get(1)); // 'Alice'
```
- Defined in src/enumerator/functions/toSortedDictionary.ts:31

Function toSortedDictionary

Type Parameters

Parameters

Returns SortedDictionary<TKey, TValue>

Throws

Remarks

Example

Settings