type/use-unknown-in-catch-callback-variable
Require Promise catch callback variables to use an explicit unknown annotation.
| Default severity | Presets | Automatic fix | Options |
|---|---|---|---|
warning |
nuxt, opinionated |
No | None |
Applies to: Type information in Vue SFC scripts and templates, for the constructs shown below.
This rule reads type information from your TypeScript project (tsconfig.json), so the configuration sets typeAware: true. typeAware does not turn on opt-in rules by itself.
Bad
The catch callback names error without an explicit unknown annotation.
<script setup lang="ts">
function getNumber(): Promise<number> {
return Promise.resolve(1);
}
getNumber().catch((error) => {
console.log(error);
});
</script>
Good
The catch callback annotates error as unknown.
<script setup lang="ts">
function getNumber(): Promise<number> {
return Promise.resolve(1);
}
getNumber().catch((error: unknown) => {
console.log(error);
});
</script>
Configuration (Vite+)
import { defineConfig } from "@vizejs/vite-plugin/vite-plus";
export default defineConfig({}).withVue({
linter: {
"preset": "incremental",
"rules": {
"type/use-unknown-in-catch-callback-variable": "warn"
},
"typeAware": true
},
});
Then run vp run lint.