Skip to content

docs(eslint-plugin): [ban-types] add reference on how to type an empty object #2758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 17, 2020
Merged

docs(eslint-plugin): [ban-types] add reference on how to type an empty object #2758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
015a3bf
feat(eslint-plugin): add reference on how to type an empty object in …
martinfrancois Nov 12, 2020
2e4da9a
Update packages/eslint-plugin/docs/rules/ban-types.md
martinfrancois Nov 16, 2020
02f02f6
Update packages/eslint-plugin/src/rules/ban-types.ts
martinfrancois Nov 16, 2020
ce398c1
Merge branch 'master' into ban-types-empty-object
martinfrancois Nov 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/eslint-plugin/docs/rules/ban-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ The default options provide a set of "best practices", intended to provide safet
- It accepts class declarations, which will fail when called, as they are called without the `new` keyword.
- Avoid the `Object` and `{}` types, as they mean "any non-nullish value".
- 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).
- Avoid the `object` type, as it is currently hard to use due to not being able to assert that keys exist.
- See [microsoft/TypeScript#21732](https://github.com/microsoft/TypeScript/issues/21732).

Expand Down
1 change: 1 addition & 0 deletions packages/eslint-plugin/src/rules/ban-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ const defaultTypes: Types = {
'`{}` 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 value", you probably want `unknown` instead.',
'- If you want a type meaning "empty object", you probably want `Record<string, never>` instead.',
].join('\n'),
},
object: {
Expand Down