@augment-vir/common 29.3.0 → 30.0.1

package/LICENSE-CC0

@@ -0,0 +1,121 @@
+CC0 1.0 Universal
+
+Creative Commons Legal Code
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 electrovir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,7 +1,11 @@
 # @augment-vir/common
 
-`augment-vir` is a collection of small helper functions that I constantly use across all my JavaScript and TypeScript repos. I call these functions `augments`. These are functions, constants, and types typically placed within a "util", or "helpers", etc. directory.
+A collection of augments, helpers types, functions, and classes for any JavaScript environment.
 
-This `common` package is for environment-agnostic augments. Everything in here will work in Node.js or the browser with identical results.
+-   Examples: [`filterObject`](https://electrovir.github.io/augment-vir/functions/filterObject.html), [`wait`](https://electrovir.github.io/augment-vir/functions/wait.html), [`getEnumValues`](https://electrovir.github.io/augment-vir/functions/getEnumValues.html)
+-   Includes a colored logger implementation: [`log`](https://electrovir.github.io/augment-vir/variables/log.html)
+-   Includes a SQL-select-like runtime implementation of TypeScript's `Pick`: [`selectFrom`](https://electrovir.github.io/augment-vir/functions/selectFrom-1.html)
+-   Includes Prisma type helpers.
+-   and much more...
 
-Note that the `random*` functions exported by this package will not work in Node.js < v19.0.0.
+See all `@augment-vir` docs here: https://electrovir.github.io/augment-vir

package/dist/augments/array/array-map.d.ts

@@ -0,0 +1,34 @@
+import type { ArrayElement } from '@augment-vir/core';
+import { Writable } from '../type/writable.js';
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but transfers the input tuple's size to the output type.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {typedMap} from '@augment-vir/common';
+ *
+ * const result = await typedMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     (value) => {
+ *         return value + 1;
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function typedMap<const ArrayGeneric extends ReadonlyArray<any>, const OutputType>(arrayToMap: ArrayGeneric, mapCallback: (value: ArrayElement<NoInfer<ArrayGeneric>>, index: number, array: NoInfer<ArrayGeneric>) => OutputType): Writable<{
+    [Index in keyof ArrayGeneric]: OutputType;
+}>;

package/dist/augments/array/array-map.js

@@ -0,0 +1,32 @@
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but transfers the input tuple's size to the output type.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {typedMap} from '@augment-vir/common';
+ *
+ * const result = await typedMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     (value) => {
+ *         return value + 1;
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function typedMap(arrayToMap, mapCallback) {
+    return arrayToMap.map(mapCallback);
+}

package/dist/augments/array/array-to-object.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Polyfill for `Object.groupBy`:
+ * https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
+ *
+ * @category Array
+ * @category Object
+ * @example
+ *
+ * ```ts
+ * import {arrayToObject} from '@augment-vir/common';
+ *
+ * const result = arrayToObject(
+ *     [
+ *         'a',
+ *         'b',
+ *     ],
+ *     (value) => `key-${value}`,
+ * );
+ * // result is `{key-a: ['a'], key-b: ['b']}`
+ * ```
+ */
+export declare function groupArrayBy<ElementType, NewKey extends PropertyKey>(inputArray: ReadonlyArray<ElementType>, callback: (value: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => NewKey): Partial<Record<NewKey, ElementType[]>>;
+/**
+ * Similar to {@link groupArrayBy} but maps array entries to a single key and requires `key` _and_
+ * `value` outputs from the callback. The resulting object does not have an array of elements
+ * (unless the original array itself contains arrays).
+ *
+ * @category Array
+ * @category Object
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {arrayToObject} from '@augment-vir/common';
+ *
+ * const result = arrayToObject(
+ *     [
+ *         'a',
+ *         'b',
+ *     ],
+ *     (value) => {
+ *         return {key: `key-${value}`, value};
+ *     },
+ * );
+ * // result is `{key-a: 'a', key-b: 'b'}`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function arrayToObject<ElementType, NewKey extends PropertyKey, NewValue>(inputArray: ReadonlyArray<ElementType>, callback: (value: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => {
+    key: NewKey;
+    value: NewValue;
+}): Partial<Record<NewKey, NewValue>>;

package/dist/augments/array/array-to-object.js

@@ -0,0 +1,67 @@
+import { getOrSet } from '../object/get-or-set.js';
+import { typedObjectFromEntries } from '../object/object-entries.js';
+/**
+ * Polyfill for `Object.groupBy`:
+ * https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
+ *
+ * @category Array
+ * @category Object
+ * @example
+ *
+ * ```ts
+ * import {arrayToObject} from '@augment-vir/common';
+ *
+ * const result = arrayToObject(
+ *     [
+ *         'a',
+ *         'b',
+ *     ],
+ *     (value) => `key-${value}`,
+ * );
+ * // result is `{key-a: ['a'], key-b: ['b']}`
+ * ```
+ */
+export function groupArrayBy(inputArray, callback) {
+    return inputArray.reduce((accum, entry, index, originalArray) => {
+        const key = callback(entry, index, originalArray);
+        const entryArray = getOrSet(accum, key, () => []);
+        entryArray.push(entry);
+        return accum;
+    }, {});
+}
+/**
+ * Similar to {@link groupArrayBy} but maps array entries to a single key and requires `key` _and_
+ * `value` outputs from the callback. The resulting object does not have an array of elements
+ * (unless the original array itself contains arrays).
+ *
+ * @category Array
+ * @category Object
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {arrayToObject} from '@augment-vir/common';
+ *
+ * const result = arrayToObject(
+ *     [
+ *         'a',
+ *         'b',
+ *     ],
+ *     (value) => {
+ *         return {key: `key-${value}`, value};
+ *     },
+ * );
+ * // result is `{key-a: 'a', key-b: 'b'}`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function arrayToObject(inputArray, callback) {
+    return typedObjectFromEntries(inputArray.map((entry, index, originalArray) => {
+        const { key, value } = callback(entry, index, originalArray);
+        return [
+            key,
+            value,
+        ];
+    }));
+}

package/dist/augments/array/awaited/awaited-filter.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Performs
+ * [`[].filter()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/filter)
+ * on an array but supports an async callback.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedFilter} from '@augment-vir/common';
+ *
+ * const result = await awaitedFilter(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value > 2);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function awaitedFilter<OriginalGeneric>(arrayInput: ReadonlyArray<OriginalGeneric>, filterCallback: (arrayElement: OriginalGeneric, index: number, wholeArray: ReadonlyArray<OriginalGeneric>) => Promise<unknown>, options?: {
+    /**
+     * Each call to the filter callback is blocking, meaning the next one won't start until the
+     * current one finishes. By default this is false.
+     */
+    blocking?: boolean | undefined;
+}): Promise<OriginalGeneric[]>;

package/dist/augments/array/awaited/awaited-filter.js

@@ -0,0 +1,36 @@
+import { awaitedBlockingMap } from './awaited-map.js';
+/**
+ * Performs
+ * [`[].filter()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/filter)
+ * on an array but supports an async callback.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedFilter} from '@augment-vir/common';
+ *
+ * const result = await awaitedFilter(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value > 2);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export async function awaitedFilter(arrayInput, filterCallback, options) {
+    const callbackResults = options?.blocking
+        ? await awaitedBlockingMap(arrayInput, filterCallback)
+        : await Promise.all(arrayInput.map(filterCallback));
+    return arrayInput.filter((originalValue, index) => !!callbackResults[index]);
+}

package/dist/augments/array/awaited/awaited-for-each.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Performs
+ * [`[].forEach()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedForEach} from '@augment-vir/common';
+ *
+ * await awaitedForEach(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function awaitedForEach<OriginalGeneric>(input: ReadonlyArray<OriginalGeneric>, callback: (arrayElement: OriginalGeneric, index: number, wholeArray: ReadonlyArray<OriginalGeneric>) => void | PromiseLike<void>): Promise<void>;

package/dist/augments/array/awaited/awaited-for-each.js

@@ -0,0 +1,34 @@
+import { awaitedBlockingMap } from './awaited-map.js';
+/**
+ * Performs
+ * [`[].forEach()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedForEach} from '@augment-vir/common';
+ *
+ * await awaitedForEach(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export async function awaitedForEach(input, callback) {
+    await awaitedBlockingMap(input, callback);
+}

package/dist/augments/array/awaited/awaited-map.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2. Compare to `await Promise.all([].map(async () => {}))` which is _not_ blocking (all
+ * callbacks are called in parallel).
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedBlockingMap} from '@augment-vir/common';
+ *
+ * const result = await awaitedBlockingMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function awaitedBlockingMap<OriginalGeneric, MappedGeneric>(input: ReadonlyArray<OriginalGeneric>, callback: (arrayElement: OriginalGeneric, index: number, wholeArray: ReadonlyArray<OriginalGeneric>) => MappedGeneric | PromiseLike<MappedGeneric>): Promise<Awaited<MappedGeneric>[]>;

package/dist/augments/array/awaited/awaited-map.js

@@ -0,0 +1,40 @@
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2. Compare to `await Promise.all([].map(async () => {}))` which is _not_ blocking (all
+ * callbacks are called in parallel).
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedBlockingMap} from '@augment-vir/common';
+ *
+ * const result = await awaitedBlockingMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export async function awaitedBlockingMap(input, callback) {
+    return await input.reduce(async (accumPromise, currentElement, index, wholeArray) => {
+        const accum = await accumPromise;
+        const mappedValue = await callback(currentElement, index, wholeArray);
+        accum.push(mappedValue);
+        return accum;
+    }, Promise.resolve([]));
+}

package/dist/augments/array/filter.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Removes all given indexes from the given array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {filterOutIndexes} from '@augment-vir/common';
+ *
+ * const result = filterOutIndexes(
+ *     [
+ *         'a',
+ *         'b',
+ *         '',
+ *     ],
+ *     [
+ *         0,
+ *         2,
+ *     ],
+ * );
+ * // result is `['b']`
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function filterOutIndexes<T>(array: ReadonlyArray<T>, indexes: ReadonlyArray<number>): T[];
+/** Performs `filterMap` with a type guard filter. */
+export declare function filterMap<ElementType, MappedEntry, TypeGuarded extends MappedEntry>(inputArray: ReadonlyArray<ElementType>, mapCallback: (entry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => MappedEntry, filterCallback: (mappedOutput: MappedEntry, originalEntry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => mappedOutput is TypeGuarded): TypeGuarded[];
+/** Performs a regular `filterMap`. */
+export declare function filterMap<ElementType, MappedEntry>(inputArray: ReadonlyArray<ElementType>, mapCallback: (entry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => MappedEntry, filterCallback: (mappedOutput: MappedEntry, originalEntry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => boolean): MappedEntry[];

package/dist/augments/array/filter.js

@@ -0,0 +1,74 @@
+/**
+ * Removes all given indexes from the given array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {filterOutIndexes} from '@augment-vir/common';
+ *
+ * const result = filterOutIndexes(
+ *     [
+ *         'a',
+ *         'b',
+ *         '',
+ *     ],
+ *     [
+ *         0,
+ *         2,
+ *     ],
+ * );
+ * // result is `['b']`
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function filterOutIndexes(array, indexes) {
+    return array.filter((_, index) => !indexes.includes(index));
+}
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * and
+ * [`[].filter()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/filter)
+ * (in that order) on an array with a single iteration.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {filterMap} from '@augment-vir/common';
+ *
+ * const result = filterMap(
+ *     [
+ *         'a',
+ *         'b',
+ *         '',
+ *     ],
+ *     // map callback
+ *     (value) => {
+ *         return `value-${value}`;
+ *     },
+ *     // filter callback
+ *     (mappedValue, originalValue) => {
+ *         return !!originalValue;
+ *     },
+ * );
+ * // result is `['value-a', 'value-b']`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function filterMap(inputArray, mapCallback, filterCallback) {
+    return inputArray.reduce((accum, entry, index, originalArray) => {
+        const mapOutput = mapCallback(entry, index, originalArray);
+        const filterOutput = filterCallback(mapOutput, entry, index, originalArray);
+        if (filterOutput) {
+            accum.push(mapOutput);
+        }
+        return accum;
+    }, []);
+}