Function mapObject

Maps an object. The callback must return a key and value.

Example

import {mapObject} from '@augment-vir/common';

mapObject({a: 1, b: 2}, (key, value) => {
    return {
        key: `key-${key}`,
        value: `value-${value}`,
    };
});
// output is `{'key-a': 'value-1', 'key-b': 'value-2'}`

Package

@augment-vir/common

See

mapObjectValues: the variant that only maps values.

mapObject<const OriginalObject, const NewKey, const NewValue>(inputObject, mapCallback): Promise<Record<NewKey, NewValue>>
Type Parameters
- const OriginalObject
- const NewKey extends PropertyKey
- const NewValue
Parameters
- inputObject: OriginalObject
- mapCallback: ((originalKey: keyof OriginalObject, originalValue: Values<OriginalObject>, originalObject: OriginalObject) => Promise<undefined | {
  key: NewKey;
  value: NewValue;
  }>)
  - - (originalKey, originalValue, originalObject): Promise<undefined | {
      key: NewKey;
      value: NewValue;
      }>
    - Parameters
      originalKey: keyof OriginalObject
      originalValue: Values<OriginalObject>
      originalObject: OriginalObject
      Returns Promise<undefined | {
      key: NewKey;
      value: NewValue;
      }>
Returns Promise<Record<NewKey, NewValue>>
- Defined in packages/common/src/augments/object/map-entries.ts:9
mapObject<const OriginalObject, const NewKey, const NewValue>(inputObject, mapCallback): Record<NewKey, NewValue>
Type Parameters
- const OriginalObject
- const NewKey extends PropertyKey
- const NewValue
Parameters
- inputObject: OriginalObject
- mapCallback: ((originalKey: keyof OriginalObject, originalValue: Values<OriginalObject>, originalObject: OriginalObject) => undefined | {
  key: NewKey;
  value: NewValue;
  })
  - - (originalKey, originalValue, originalObject): undefined | {
      key: NewKey;
      value: NewValue;
      }
    - Parameters
      originalKey: keyof OriginalObject
      originalValue: Values<OriginalObject>
      originalObject: OriginalObject
      Returns undefined | {
      key: NewKey;
      value: NewValue;
      }
Returns Record<NewKey, NewValue>
- Defined in packages/common/src/augments/object/map-entries.ts:17
mapObject<const OriginalObject, const NewKey, const NewValue>(inputObject, mapCallback): MaybePromise<Record<NewKey, NewValue>>
Type Parameters
- const OriginalObject
- const NewKey extends PropertyKey
- const NewValue
Parameters
- inputObject: OriginalObject
- mapCallback: ((originalKey: keyof OriginalObject, originalValue: Values<OriginalObject>, originalObject: OriginalObject) => MaybePromise<undefined | {
  key: NewKey;
  value: NewValue;
  }>)
  - - (originalKey, originalValue, originalObject): MaybePromise<undefined | {
      key: NewKey;
      value: NewValue;
      }>
    - Parameters
      originalKey: keyof OriginalObject
      originalValue: Values<OriginalObject>
      originalObject: OriginalObject
      Returns MaybePromise<undefined | {
      key: NewKey;
      value: NewValue;
      }>
Returns MaybePromise<Record<NewKey, NewValue>>
- Defined in packages/common/src/augments/object/map-entries.ts:25

Function mapObject

Example

Package

See

Type Parameters

Parameters

Parameters

Returns Promise<undefined | { key: NewKey; value: NewValue; }>

Returns Promise<Record<NewKey, NewValue>>

Type Parameters

Parameters

Parameters

Returns undefined | { key: NewKey; value: NewValue; }

Returns Record<NewKey, NewValue>

Type Parameters

Parameters

Parameters

Returns MaybePromise<undefined | { key: NewKey; value: NewValue; }>

Returns MaybePromise<Record<NewKey, NewValue>>

Settings

Returns Promise<undefined | {
key: NewKey;
value: NewValue;
}>

Returns undefined | {
key: NewKey;
value: NewValue;
}

Returns MaybePromise<undefined | {
key: NewKey;
value: NewValue;
}>