mirror of
https://github.com/Sevichecc/Urara-Blog.git
synced 2025-05-05 02:39:30 +08:00
96 lines
2.4 KiB
Text
96 lines
2.4 KiB
Text
---
|
|
description: 'Disallow assigning a value with type `any` to variables and properties.'
|
|
---
|
|
|
|
> 🛑 This file is source code, not the primary documentation location! 🛑
|
|
>
|
|
> See **https://typescript-eslint.io/rules/no-unsafe-assignment** for documentation.
|
|
|
|
Despite your best intentions, the `any` type can sometimes leak into your codebase.
|
|
Assigning an `any` typed value to a variable can be hard to pick up on, particularly if it leaks in from an external library. Operations on the variable will not be checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase.
|
|
|
|
## Rule Details
|
|
|
|
This rule disallows assigning `any` to a variable, and assigning `any[]` to an array destructuring.
|
|
This rule also compares the assigned type to the variable's type to ensure you don't assign an unsafe `any` in a generic position to a receiver that's expecting a specific type. For example, it will error if you assign `Set<any>` to a variable declared as `Set<string>`.
|
|
|
|
Examples of code for this rule:
|
|
|
|
<!--tabs-->
|
|
|
|
### ❌ Incorrect
|
|
|
|
```ts
|
|
const x = 1 as any,
|
|
y = 1 as any;
|
|
const [x] = 1 as any;
|
|
const [x] = [] as any[];
|
|
const [x] = [1 as any];
|
|
[x] = [1] as [any];
|
|
|
|
function foo(a = 1 as any) {}
|
|
class Foo {
|
|
constructor(private a = 1 as any) {}
|
|
}
|
|
class Foo {
|
|
private a = 1 as any;
|
|
}
|
|
|
|
// generic position examples
|
|
const x: Set<string> = new Set<any>();
|
|
const x: Map<string, string> = new Map<string, any>();
|
|
const x: Set<string[]> = new Set<any[]>();
|
|
const x: Set<Set<Set<string>>> = new Set<Set<Set<any>>>();
|
|
```
|
|
|
|
### ✅ Correct
|
|
|
|
```ts
|
|
const x = 1,
|
|
y = 1;
|
|
const [x] = [1];
|
|
[x] = [1] as [number];
|
|
|
|
function foo(a = 1) {}
|
|
class Foo {
|
|
constructor(private a = 1) {}
|
|
}
|
|
class Foo {
|
|
private a = 1;
|
|
}
|
|
|
|
// generic position examples
|
|
const x: Set<string> = new Set<string>();
|
|
const x: Map<string, string> = new Map<string, string>();
|
|
const x: Set<string[]> = new Set<string[]>();
|
|
const x: Set<Set<Set<string>>> = new Set<Set<Set<string>>>();
|
|
```
|
|
|
|
<!--/tabs-->
|
|
|
|
There are cases where the rule allows assignment of `any` to `unknown`.
|
|
|
|
Example of `any` to `unknown` assignment that are allowed.
|
|
|
|
```ts
|
|
const x: unknown = y as any;
|
|
const x: unknown[] = y as any[];
|
|
const x: Set<unknown> = y as Set<any>;
|
|
```
|
|
|
|
## Options
|
|
|
|
```jsonc
|
|
// .eslintrc.json
|
|
{
|
|
"rules": {
|
|
"@typescript-eslint/no-unsafe-assignment": "error"
|
|
}
|
|
}
|
|
```
|
|
|
|
This rule is not configurable.
|
|
|
|
## Related To
|
|
|
|
- [`no-explicit-any`](./no-explicit-any.md)
|