@rws-air/utils/dist/Stack/ToStack.js

Utilities for rws-air libraries and applications

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.toStack = void 0;
const Stack_1 = require("./Stack");
/**
 * Create a `Stack` using the `keyExtractor` and `valueExtractor` the to obtain the key and value for each element.
 * @remark If multiple elements have the same key only the last element with that key will remain.
 * @param input The array of data to transform into a Stack
 * @param keyExtractor A function that describes where to find the key to use for the Stack
 * @param valueExtractor A function that describes where to find the value to use for the Stack
 * @example
 * ```ts
 *   type HumanGenders = 'male' | 'female' | 'unknown';
 *
 *   interface Human {
 *     id: number;
 *     name: string;
 *     age: number;
 *     gender: HumanGenders;
 *   }
 *
 *   const humans: Human[] = [
 *     { id: 1, name: 'John Connor', age: 9001, gender: 'male' },
 *     { id: 2, name: 'Sarah Connor', age: 300, gender: 'female' },
 *     { id: 3, name: 'Luke Skywalker', age: 30, gender: 'male' }
 *   ];
 *
 *   const humansInAStack = toStack<Human, HumanGenders, Human>(
 *     humans,
 *     (h) => h.gender,
 *     (h) => h
 *   ); // Stack<HumanGenders, Human>
 *
 * // Stack(2) [Map] {
 * //   'male' => { id: 3, name: 'Luke Skywalker', age: 30, gender: 'male' },
 * //   'female' => { id: 2, name: 'Sarah Connor', age: 300, gender: 'female' }
 * // }
 * ```
 * @returns A `Stack<Key, Value>` of the values, mapped by the given key
 */
function toStack(input, keyExtractor, valueExtractor) {
    return input.reduce((accumulator, element) => {
        accumulator.set(keyExtractor(element), valueExtractor(element));
        return accumulator;
    }, new Stack_1.Stack());
}
exports.toStack = toStack;
//# sourceMappingURL=ToStack.js.map