no-duplicate-enum-values
Disallow duplicate enum member values.
Extending "plugin:@typescript-eslint/recommended"
in an ESLint configuration enables this rule.
Although TypeScript supports duplicate enum member values, people usually expect members to have unique values within the same enum. Duplicate values can lead to bugs that are hard to track down.
module.exports = {
"rules": {
"@typescript-eslint/no-duplicate-enum-values": "error"
}
};
Try this rule in the playground ↗
Examples
This rule disallows defining an enum with multiple members initialized to the same value.
This rule only enforces on enum members initialized with string or number literals. Members without an initializer or initialized with an expression are not checked by this rule.
- ❌ Incorrect
- ✅ Correct
enum E {
A = 0,
B = 0,
}
Open in Playgroundenum E {
A = 'A',
B = 'A',
}
Open in Playgroundenum E {
A = 0,
B = 1,
}
Open in Playgroundenum E {
A = 'A',
B = 'B',
}
Open in PlaygroundOptions
This rule is not configurable.
When Not To Use It
It can sometimes be useful to include duplicate enum members for very specific use cases. For example, when renaming an enum member, it can sometimes be useful to keep the old name until a scheduled major breaking change. You might consider using ESLint disable comments for those specific situations instead of completely disabling this rule.
In general, if your project intentionally duplicates enum member values, you can avoid this rule.