js-enum-lib
v1.3.0
Published
javascript enum
Downloads
7
Maintainers
Readme
js-enum-lib
Install
npm install js-enum-lib
Usage
import { Enumify } from 'js-enum-lib';
const colorEnum = new Enumify({
PINEAPPLE: { key: 'PINEAPPLE', label: '菠萝🍍', value: 3 },
});
colorEnum.add('RED', 'Red Color', '#FF0000');
colorEnum.add('GREEN', 'Green Color', '#00FF00');
console.log(colorEnum.getAll()); // 获取所有枚举项
console.log(colorEnum.get('RED')); // 获取指定的枚举项
console.log(colorEnum.getLabel('GREEN')); // 获取标签
console.log(colorEnum.getValue('RED')); // 获取值
colorEnum.remove('RED'); // 删除枚举项
colorEnum.removeAll(); // 清空枚举项
console.log(colorEnum.getAll()); // 查看删除后的结果
Enumify
Enumify
是一个用于管理自定义枚举的类。你可以用它来添加、删除和获取枚举项及其属性。
使用方法
创建实例
const enumify = new Enumify();
添加枚举项
enumify.add('KEY', 'Label', 'Value');
参数:
key
: 枚举项的唯一键label
: 枚举项的标签value
: 枚举项的值(可以是数字或字符串)
删除枚举项
enumify.remove('KEY');
参数:
key
: 要删除的枚举项的键
清空枚举项
enumify.removeAll();
获取枚举项
const item = enumify.get('KEY');
返回值:
EnumItem
对象或undefined
(如果不存在)
获取所有枚举项
const allItems = enumify.getAll();
返回值:
EnumItem
对象的数组
根据键获取标签
const label = enumify.getLabel('KEY');
返回值:
- 枚举项的标签或
undefined
(如果不存在)
根据键获取值
const value = enumify.getValue('KEY');
返回值:
- 枚举项的值(数字或字符串)或
undefined
(如果不存在)