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,
    const UseRequired extends boolean | undefined = undefined,
>(
    inputArray: readonly ElementType[],
    callback: (
        value: ElementType,
        index: number,
        originalArray: readonly ElementType[],
    ) => Promise<{ key: NewKey; value: NewValue } | undefined>,
    options?: Partial<{ useRequired: UseRequired }>,
): Promise<
    MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>,
>
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.
Type Parameters
- ElementType
- NewKey extends PropertyKey
- NewValue
- const UseRequired extends boolean | undefined = undefined
Parameters
- inputArray: readonly ElementType[]
- callback: (
      value: ElementType,
      index: number,
      originalArray: readonly ElementType[],
  ) => Promise<{ key: NewKey; value: NewValue } | undefined>
- Optionaloptions: Partial<{ useRequired: UseRequired }>
  Optional.
Returns Promise<MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>>
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
- Defined in packages/common/src/augments/array/array-to-object.ts:105
arrayToObject<
    ElementType,
    NewKey extends PropertyKey,
    NewValue,
    const UseRequired extends boolean | undefined = undefined,
>(
    inputArray: readonly ElementType[],
    callback: (
        value: ElementType,
        index: number,
        originalArray: readonly ElementType[],
    ) => { key: NewKey; value: NewValue } | undefined,
    options?: Partial<{ useRequired: UseRequired }>,
): MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>
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.
Type Parameters
- ElementType
- NewKey extends PropertyKey
- NewValue
- const UseRequired extends boolean | undefined = undefined
Parameters
- inputArray: readonly ElementType[]
- callback: (
      value: ElementType,
      index: number,
      originalArray: readonly ElementType[],
  ) => { key: NewKey; value: NewValue } | undefined
- Optionaloptions: Partial<{ useRequired: UseRequired }>
  Optional.
Returns MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>
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
- Defined in packages/common/src/augments/array/array-to-object.ts:154
arrayToObject<
    ElementType,
    NewKey extends PropertyKey,
    NewValue,
    const UseRequired extends boolean | undefined = undefined,
>(
    inputArray: readonly ElementType[],
    callback: (
        value: ElementType,
        index: number,
        originalArray: readonly ElementType[],
    ) => MaybePromise<{ key: NewKey; value: NewValue } | undefined>,
    options?: Partial<{ useRequired: UseRequired }>,
): MaybePromise<
    MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>,
>
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.
Type Parameters
- ElementType
- NewKey extends PropertyKey
- NewValue
- const UseRequired extends boolean | undefined = undefined
Parameters
- inputArray: readonly ElementType[]
- callback: (
      value: ElementType,
      index: number,
      originalArray: readonly ElementType[],
  ) => MaybePromise<{ key: NewKey; value: NewValue } | undefined>
- Optionaloptions: Partial<{ useRequired: UseRequired }>
  Optional.
Returns MaybePromise<MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>>
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
- Defined in packages/common/src/augments/array/array-to-object.ts:202

Function arrayToObject

Example

Package

Type Parameters

Parameters

Returns Promise<MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>>

Example

Package

Type Parameters

Parameters

Returns MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>

Example

Package

Type Parameters

Parameters

Returns MaybePromise<MakePartial<Record<NewKey, NewValue>, InverseBoolean<UseRequired>>>

Example

Package

Settings