examples/angular-cli/src/stories/legacy/component-in-story.stories.ts
Type assertion on object literals is forbidden, use a type annotation instead. Open
Open
export default {
title: 'Legacy / Component in Story',
} as Meta;
- Read upRead up
- Exclude checks
Rule: no-object-literal-type-assertion
Forbids an object literal to appear in a type assertion expression.
Casting to any
or to unknown
is still allowed.
Rationale
Always prefer const x: T = { ... };
to const x = { ... } as T;
.
The type assertion in the latter case is either unnecessary or hides an error.
The compiler will warn for excess properties with this syntax, but not missing required fields.
For example: const x: { foo: number } = {}
will fail to compile, but
const x = {} as { foo: number }
will succeed.
Additionally, the const assertion const x = { foo: 1 } as const
,
introduced in TypeScript 3.4, is considered beneficial and is ignored by this rule.
Notes
- TypeScript Only
Config
One option may be configured:
-
allow-arguments
allows type assertions to be used on object literals inside call expressions.
Examples
"no-object-literal-type-assertion": true
"no-object-literal-type-assertion": true,[object Object]
Schema
{
"type": "object",
"properties": {
"allow-arguments": {
"type": "boolean"
}
},
"additionalProperties": false
}
For more information see this page.