Skip to content

@pmun/utils / appendUniversalOption

Function: appendUniversalOption()

ts
function appendUniversalOption<T, V>(options, config): T[];

在选项数组前添加一个"全部"选项

Type Parameters

T

T extends Record<string, any>

V

V = any

Parameters

options

T[]

原始选项数组

config

配置选项

name?

string = 'label'

选项标签的字段名 (默认为 'label')

value?

V = ...

"全部"选项的值 (默认为 '')

valueKey?

string = 'value'

选项值的字段名 (默认为 'value')

Returns

T[]

添加了"全部"选项的新数组

Example

ts
// 基本用法
const options = [
{ label: '选项1', value: 1 },
{ label: '选项2', value: 2 }
]
const result = appendUniversalOption(options)
// 结果: [
//    { label: '全部', value: '' },
//    { label: '选项1', value: 1 },
//    { label: '选项2', value: 2 }
// ]

// 自定义字段名和值
const customOptions = [
{ text: '选项1', id: 1 },
{ text: '选项2', id: 2 }
]
const customResult = appendUniversalOption(customOptions, {
name: 'text',
valueKey: 'id',
value: 0
})
// 结果: [
//    { text: '全部', id: 0 },
//    { text: '选项1', id: 1 },
//    { text: '选项2', id: 2 }
// ]