Function mapEnumToObject

Maps all values of an enum as keys in an object where each value is the callback's output for that key.

Example

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

enum MyEnum {
    A = 'a',
    B = 'b',
}

mapEnumToObject(MyEnum, (enumValue) => {
    return `value-${enumValue}`;
});
// output is `{[MyEnum.A]: 'value-a', [MyEnum.B]: 'value-b'}`

Package

@augment-vir/common

mapEnumToObject<const Enum extends EnumBaseType, const Value>(
enumInput: Enum,
callback: (enumValue: Values<Enum>) => Promise<Value>,
): Promise<EnumMap<Enum, Value>>
Type Parameters
- const Enum extends EnumBaseType
- const Value
Parameters
- enumInput: Enum
- callback: (enumValue: Values<Enum>) => Promise<Value>
Returns Promise<EnumMap<Enum, Value>>
- Defined in packages/common/src/augments/object/map-enum.ts:14
mapEnumToObject<const Enum extends EnumBaseType, const Value>(
    enumInput: Enum,
    callback: (enumValue: Values<Enum>, wholeEnum: Enum) => Value,
): Value extends Promise<any>
    ? Promise<any> extends Value<Value>
        ? Promise<EnumMap<Enum, Awaited<Value<Value>>>>
        : MaybePromise<EnumMap<Enum, Awaited<Value<Value>>>>
    : EnumMap<Enum, Value>
Type Parameters
- const Enum extends EnumBaseType
- const Value
Parameters
- enumInput: Enum
- callback: (enumValue: Values<Enum>, wholeEnum: Enum) => Value
Returns Value extends Promise<any>
    ? Promise<any> extends Value<Value>
        ? Promise<EnumMap<Enum, Awaited<Value<Value>>>>
        : MaybePromise<EnumMap<Enum, Awaited<Value<Value>>>>
    : EnumMap<Enum, Value>
- Defined in packages/common/src/augments/object/map-enum.ts:18

Function mapEnumToObject

Example

Package

Type Parameters

Parameters

Returns Promise<EnumMap<Enum, Value>>

Type Parameters

Parameters

Returns Value extends Promise<any> ? Promise<any> extends Value<Value> ? Promise<EnumMap<Enum, Awaited<Value<Value>>>> : MaybePromise<EnumMap<Enum, Awaited<Value<Value>>>> : EnumMap<Enum, Value>

Settings

Returns Value extends Promise<any>
? Promise<any> extends Value<Value>
? Promise<EnumMap<Enum, Awaited<Value<Value>>>>
: MaybePromise<EnumMap<Enum, Awaited<Value<Value>>>>
: EnumMap<Enum, Value>