no-duplicate-type-constituents
Disallow duplicate constituents of union or intersection types.
Extending "plugin:@typescript-eslint/recommended-type-checked"
in an ESLint configuration enables this rule.
Some problems reported by this rule are automatically fixable by the --fix
ESLint command line option.
This rule requires type information to run.
TypeScript supports types ("constituents") within union and intersection types being duplicates of each other. However, developers typically expect each constituent to be unique within its intersection or union. Duplicate values make the code overly verbose and generally reduce readability.
This rule disallows duplicate union or intersection constituents.
We consider types to be duplicate if they evaluate to the same result in the type system.
For example, given type A = string
and type T = string | A
, this rule would flag that A
is the same type as string
.
- ❌ Incorrect
- ✅ Correct
type T1 = 'A' | 'A';
type T2 = A | A | B;
type T3 = { a: string } & { a: string };
type T4 = [1, 2, 3] | [1, 2, 3];
type StringA = string;
type StringB = string;
type T5 = StringA | StringB;
Open in Playgroundtype T1 = 'A' | 'B';
type T2 = A | B | C;
type T3 = { a: string } & { b: string };
type T4 = [1, 2, 3] | [1, 2, 3, 4];
type StringA = string;
type NumberB = number;
type T5 = StringA | NumberB;
Open in Playgroundmodule.exports = {
"rules": {
"@typescript-eslint/no-duplicate-type-constituents": "error"
}
};
Options
This rule accepts the following options
type Options = [
{
ignoreIntersections?: boolean;
ignoreUnions?: boolean;
},
];
const defaultOptions: Options = [
{ ignoreIntersections: false, ignoreUnions: false },
];
ignoreIntersections
When set to true, duplicate checks on intersection type constituents are ignored.
ignoreUnions
When set to true, duplicate checks on union type constituents are ignored.