Function arrayToObject

Similar to 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). Automatically handles the case where the callback returns a promise.

Example

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

arrayToObject<ElementType, NewKey extends PropertyKey, NewValue>(
    inputArray: readonly ElementType[],
    callback: (
        value: ElementType,
        index: number,
        originalArray: readonly ElementType[],
    ) => Promise<undefined | { key: NewKey; value: NewValue }>,
): Promise<Partial<Record<NewKey, NewValue>>>
Type Parameters
- ElementType
- NewKey extends PropertyKey
- NewValue
Parameters
- inputArray: readonly ElementType[]
- callback: (
      value: ElementType,
      index: number,
      originalArray: readonly ElementType[],
  ) => Promise<undefined | { key: NewKey; value: NewValue }>
Returns Promise<Partial<Record<NewKey, NewValue>>>
- Defined in packages/common/src/augments/array/array-to-object.ts:49
arrayToObject<ElementType, NewKey extends PropertyKey, NewValue>(
    inputArray: readonly ElementType[],
    callback: (
        value: ElementType,
        index: number,
        originalArray: readonly ElementType[],
    ) => undefined | { key: NewKey; value: NewValue },
): Partial<Record<NewKey, NewValue>>
Type Parameters
- ElementType
- NewKey extends PropertyKey
- NewValue
Parameters
- inputArray: readonly ElementType[]
- callback: (
      value: ElementType,
      index: number,
      originalArray: readonly ElementType[],
  ) => undefined | { key: NewKey; value: NewValue }
Returns Partial<Record<NewKey, NewValue>>
- Defined in packages/common/src/augments/array/array-to-object.ts:63
arrayToObject<ElementType, NewKey extends PropertyKey, NewValue>(
    inputArray: readonly ElementType[],
    callback: (
        value: ElementType,
        index: number,
        originalArray: readonly ElementType[],
    ) => MaybePromise<undefined | { key: NewKey; value: NewValue }>,
): MaybePromise<Partial<Record<NewKey, NewValue>>>
Type Parameters
- ElementType
- NewKey extends PropertyKey
- NewValue
Parameters
- inputArray: readonly ElementType[]
- callback: (
      value: ElementType,
      index: number,
      originalArray: readonly ElementType[],
  ) => MaybePromise<undefined | { key: NewKey; value: NewValue }>
Returns MaybePromise<Partial<Record<NewKey, NewValue>>>
- Defined in packages/common/src/augments/array/array-to-object.ts:76

Function arrayToObject

Example

Package

Type Parameters

Parameters

Returns Promise<Partial<Record<NewKey, NewValue>>>

Type Parameters

Parameters

Returns Partial<Record<NewKey, NewValue>>

Type Parameters

Parameters

Returns MaybePromise<Partial<Record<NewKey, NewValue>>>

Settings