Skip to content

Commit

Permalink
docs(eslint-plugin): update site description of ban-types docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Dec 13, 2022
1 parent 3ce2549 commit 3d833ff
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions packages/eslint-plugin/docs/rules/ban-types.md
Expand Up @@ -72,12 +72,6 @@ The default options provide a set of "best practices", intended to provide safet
- This is a point of confusion for many developers, who think it means "any object type".
- See [this comment for more information](https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-675156492).

:::important

The default options suggest using `Record<string, unknown>`; this was a stylistic decision, as the built-in `Record` type is considered to look cleaner.

:::

<details>
<summary>Default Options</summary>

Expand Down Expand Up @@ -115,15 +109,16 @@ const defaultTypes = {
Object: {
message: [
'The `Object` type actually means "any non-nullish value", so it is marginally better than `unknown`.',
'- If you want a type meaning "any object", you probably want `Record<string, unknown>` instead.',
'- If you want a type meaning "any object", you probably want `object` instead.',
'- If you want a type meaning "any value", you probably want `unknown` instead.',
].join('\n'),
},
'{}': {
message: [
'`{}` actually means "any non-nullish value".',
'- If you want a type meaning "any object", you probably want `Record<string, unknown>` instead.',
'- If you want a type meaning "any object", you probably want `object` instead.',
'- If you want a type meaning "any value", you probably want `unknown` instead.',
'- If you want a type meaning "empty object", you probably want `Record<string, never>` instead.',
].join('\n'),
},
};
Expand Down

0 comments on commit 3d833ff

Please sign in to comment.