/** * @file 枚举相关 utils */ /** * 为枚举值映射到一套新值 (最常见的是映射到文本标签) 的场景提供一个 helper 创建器, * 创建并返回一个包含 4 个快捷方法的 helper: * * - get: 输入 enum 中的一个值, 返回映射后的值 * - listOptions: 将整个映射转化为 option 数组, 比如 [{ value, label }] * - listKeys: 将映射的所有 key 转化为数组 * - listValues: 将映射的所有 value 转化为数组 * * 要注意如果映射后的值是 $t(...), map 需要以函数返回值的形式传入, * 即 `createEnumHelper(() => { xx: $t('xx'), ... })`. * * @param map - 枚举值到目标值的映射 * @returns 包含快捷方法的 helper */ export declare const createEnumHelper: (map: TMap | (() => TMap)) => { get: (key: keyof TMap) => TMap[keyof TMap]; listOptions: (sourceKey: TSourceKey, mappedKey: TMappedKey) => { [key in TSourceKey | TMappedKey]: string; }[]; listKeys: () => (keyof TMap)[]; listValues: () => TMap[keyof TMap][]; }; /** * 为布尔枚举值映射到一套新值 (最常见的是映射到文本标签) 的场景提供一个 helper 创建器, * 创建并返回一个包含 2 个快捷方法的 helper: * * - get: 输入 enum 中的一个值, 返回映射后的值 * - listOptions: 将整个映射转化为 option 数组, 比如 [{ value, label }] * * @param boolArr - 布尔枚举值到目标值的映射 * @returns 包含快捷方法的 helper * @example * ```javascript * createBoolEnumHelper([trueColor, falseColor]) * createBoolEnumHelper(() => [$t('是'), $t('否')]) * ``` */ export declare const createBoolEnumHelper: (boolArr: [TBool, TBool] | (() => [TBool, TBool])) => { get: (key: boolean) => TBool; listOptions: (sourceKey: TSourceKey, mappedKey: TMappedKey) => ({ [key in TSourceKey]: boolean; } & { [key_1 in TMappedKey]: TBool; })[]; };