Skip to content

arrayToMap

Functions

arrayToMap()

arrayToMap(array, options)

arrayToMap<T, PrimaryKey, UseMap>(array, options): ArrayToMapResult<T[PrimaryKey], T, UseMap>

对象数组转映射对象

Type parameters
ParameterValue
T extends Object-
PrimaryKey extends string | number | symbolkeyof T
UseMap extends booleanfalse
Parameters
ParameterTypeDescription
arrayT[]对象数组
optionsArrayToMapOptions<UseMap, PrimaryKey extends string ? PrimaryKey : never>配置项
Returns

ArrayToMapResult<T[PrimaryKey], T, UseMap>

Example
ts
const array = [{ id: 1, text: 'a' }, { id: 2, text: 'b' }]

arrayToMap(array, { primaryKey: 'id' })
// => Object { '1': { id: 1, text: 'a' }, '2': { id: 2, text: 'b' } }

arrayToMap(array, { primaryKey: 'id', useMap: true })
// => Map [[1, { id: 1, text: 'a' }], [2, { id: 2, text: 'b' }]]

arrayToMap(array, options)

arrayToMap<T, UseMap>(array, options?): ArrayToMapResult<T, T, UseMap>

原始值数组转映射对象

Type parameters
ParameterValue
T extends Primitive-
UseMap extends booleanfalse
Parameters
ParameterTypeDescription
arrayT[]原始值数组
options?Omit<ArrayToMapOptions<UseMap, string>, "primaryKey">配置项
Returns

ArrayToMapResult<T, T, UseMap>

Example
ts
const array = ['a', 'b', 'c']

arrayToMap(array)
// => Object { 'a': 'a', 'b': 'b', 'c': 'c' }

arrayToMap(array, { useMap: true })
// => Map [['a', 'a'], ['b', 'b'], ['c', 'c']]

Interfaces

ArrayToMapOptions<UseMap, PrimaryKey>

Type parameters

ParameterValue
UseMap extends booleanfalse
PrimaryKey extends stringstring

Properties

PropertyTypeDescription
primaryKeyPrimaryKey对象数组转映射的主键
useMap?UseMap使用 Map 类型进行映射,设为 false 时使用 Object 类型映射

Default
false