typescript/consistent-indexed-object-style Style

🛠️ An auto-fix is available for this rule for some violations.

Choose between requiring either Record type or indexed signature types.

These two types are equivalent, this rule enforces consistency in picking one style over the other:

type Foo = Record<string, unknown>;

type Foo = {
  [key: string]: unknown;
};

Inconsistent style for indexed object types can harm readability in a project.

Examples of incorrect code for this rule with consistent-indexed-object-style: ["error", "record"] (default):

interface Foo {
  [key: string]: unknown;
}
type Foo = {
  [key: string]: unknown;
};

Examples of correct code for this rule with consistent-indexed-object-style: ["error", "record"] (default):

type Foo = Record<string, unknown>;

Examples of incorrect code for this rule with consistent-indexed-object-style: ["error", "index-signature"]:

type Foo = Record<string, unknown>;

Examples of correct code for this rule with consistent-indexed-object-style: ["error", "index-signature"]:

interface Foo {
  [key: string]: unknown;
}
type Foo = {
  [key: string]: unknown;
};

Configuration

This rule accepts one of the following string values:

When set to record, enforces the use of a Record for indexed object types, e.g. Record<string, unknown>.

When set to index-signature, enforces the use of indexed signature types, e.g. { [key: string]: unknown }.

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

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

{
  "rules": {
    "typescript/consistent-indexed-object-style": "error"
  }
}

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "typescript/consistent-indexed-object-style": "error",
  },
});

bash

oxlint --deny typescript/consistent-indexed-object-style

This rule was added in v0.4.2.