# Naming convention

Here lies the default naming convention for TypeScript code. The guide may define additional rules for specific contexts. To see more, find the Naming convention sections of other categories.

# Enums

Enums should be in PascalCase and named in singular form. Enum members should be in ALL_CAPS.

Enum values have no specific convention.

enum Color {
  RED = "R",
  GREEN = "G",
  BLUE = "B",
}

enum Colors {
  Red = "R",
  Green = "G",
  Blue = "B",
}

This is bad because the enum name is not in singular form, and the enum members are not in ALL_CAPS.

The @typescript-eslint/naming-convention ESLint rule can be used to enforce this.

naming-convention

https://typescript-eslint.io/rules/naming-convention/

{
  "@typescript-eslint/naming-convention": [
    "error",
    {
      "selector": ["enum"],
      "format": ["PascalCase"]
    },
    {
      "selector": ["enumMember"],
      "format": ["UPPER_CASE"]
    }
  ]
}