Overview#

Type errors are divided into two types: fixed error code errors and scenario-related errors.

Fixed error code errors#

This type of error can be clearly captured in the code, and a fixed error code is assigned to each error. The error code consists of the error type and ID, such as TYPE-001. You can find the specified page based on the error code to understand the cause of the error and the solution.

Error code list#

• TYPE-001

Scenario-related errors#

This type of error is generated based on the user's specific scenario and has no fixed error code. The error message and handling method will vary depending on the scenario.

Generated type contains aliases#

Phenomenon description

The type generated by the producer contains aliases and cannot be processed normally in the consumer.

How ​​to solve

1. Install typescript-transform-paths and ts-patch

2. Apply typescript-transform-paths in tsconfig.json

{
"compilerOptions": {
+ "plugins": [
+ { "transform": "typescript-transform-paths" },
+ {
+ "transform": "typescript-transform-paths",
+ "afterDeclarations": true
+ }
+ ],
},
}

3. Set dts.generateTypes.compilerInstance to tspc(ts-patch cli)
4. Regenerate types