Skip to main content

consistent-generic-constructors

Enforce specifying generic type arguments on type annotation or constructor name of a constructor call.

🎨

Extending "plugin:@typescript-eslint/stylistic" in an ESLint configuration enables this rule.

🔧

Some problems reported by this rule are automatically fixable by the --fix ESLint command line option.

When constructing a generic class, you can specify the type arguments on either the left-hand side (as a type annotation) or the right-hand side (as part of the constructor call):

// Left-hand side
const map: Map<string, number> = new Map();

// Right-hand side
const map = new Map<string, number>();

This rule ensures that type arguments appear consistently on one side of the declaration. Keeping to one side consistently improve code readability.

The rule never reports when there are type parameters on both sides, or neither sides of the declaration. It also doesn't report if the names of the type annotation and the constructor don't match.

.eslintrc.cjs
module.exports = {
  "rules": {
    "@typescript-eslint/consistent-generic-constructors": "error"
  }
};
Try this rule in the playground ↗

Options​

This rule accepts the following options

type Options = ['constructor' | 'type-annotation'];

const defaultOptions: Options = ['constructor'];
  • constructor (default): type arguments that only appear on the type annotation are disallowed.
  • type-annotation: type arguments that only appear on the constructor are disallowed.

constructor​

const map: Map<string, number> = new Map();
const set: Set<string> = new Set();
Open in Playground

type-annotation​

const map = new Map<string, number>();
const set = new Set<string>();
Open in Playground

When Not To Use It​

You can turn this rule off if you don't want to enforce one kind of generic constructor style over the other.

Resources​