typescript/ban-types Pedantic

🚧 An auto-fix is still under development.

What it does

This rule bans specific types and can suggest alternatives. Note that it does not ban the corresponding runtime objects from being used.

Why is this bad?

Some built-in types have aliases, while some types are considered dangerous or harmful. It's often a good idea to ban certain types to help with consistency and safety.

Examples

Examples of incorrect code for this rule:

let foo: String = "foo";

let bar: Boolean = true;

Examples of correct code for this rule:

let foo: string = "foo";

let bar: boolean = true;

How to use

To enable this rule in the CLI or using the config file, you can use:

CLI

oxlint --deny typescript/ban-types

Config (.oxlintrc.json)

{
  "rules": {
    "typescript/ban-types": "error"
  }
}

References

• Rule Source