[英]Typescript's declaration merging not working as expected using ts-node
For a project using the express-session
package, I'm trying to mutate the session
object by simply adding a user key.对于使用
express-session
package 的项目,我试图通过简单地添加用户密钥来改变session
object。
req.session.user = 123;
Coming from this question's accepted answer, I understand I could use declaration merging to extend the SessionData
interface, using my own interface.来自这个问题的接受答案,我知道我可以使用声明合并来扩展
SessionData
接口,使用我自己的接口。
Looking at various open-source projects, such as the HospitalRun components repository I notice them having the types
directory in their tsconfig.json
file under the include
section like this.查看各种开源项目,例如HospitalRun 组件存储库,我注意到它们在
include
部分下的tsconfig.json
文件中有types
目录,如下所示。
"include": [
"src",
"types"
]
My whole tsconfig.json
looks like this, which lives in the root of the project.我的整个
tsconfig.json
看起来像这样,它位于项目的根目录中。
{
"include": [
"types",
"src",
],
"exclude": [
"node_modules"
],
"compilerOptions": {
"lib": [
"esnext",
"esnext.asynciterable"
],
"baseUrl": ".",
"skipLibCheck": true,
"module": "commonjs",
"esModuleInterop": true,
"target": "es6",
"moduleResolution": "node",
"outDir": "build",
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"strictPropertyInitialization": false,
},
}
I tried doing the same, together a file called express-session.d.ts
in the root of this folder ( ~/types/
), having the following contents:我尝试做同样的事情,在这个文件夹的根目录(
~/types/
)中有一个名为express-session.d.ts
的文件,具有以下内容:
import session from 'express-session';
declare module 'express-session' {
interface SessionData {
user: any;
}
}
However, the error I keep receiving is this.但是,我一直收到的错误是这个。
Property 'user' does not exist on type 'Session & Partial<SessionData>'
When I do however add this piece of code above the code I use for mutating my session object, I no longer have the problem.但是,当我在用于变异 session object 的代码上方添加这段代码时,我不再遇到问题。 This doesn't seem like the right approach though.
不过,这似乎不是正确的方法。
Also, when I use tsc src/index.ts --build
instead of ts-node src/index.ts
it also works.此外,当我使用
tsc src/index.ts --build
而不是ts-node src/index.ts
它也可以工作。
What am I doing wrong here?我在这里做错了什么? How can this be fixed?
如何解决这个问题? I also tried using the
typeRoots
, using the same folder.我也尝试使用
typeRoots
,使用相同的文件夹。
LATEST UPDATE (08-MAY-2021)最新更新(2021 年 5 月 8 日)
When running the typescript program by using ts-node
, even typeRoots
are specified in tsconfig.json, it cannot recognise the custom.d.ts and prompt Property 'x
does not exist on type y` error.使用
ts-node
运行 typescript 程序时,即使在typeRoots
中指定了 typeRoots,它也无法识别 custom.d.ts 并提示Property 'x
does not exist on type y' 错误。
According to https://github.com/TypeStrong/ts-node/issues/1132#issuecomment-716642560根据https://github.com/TypeStrong/ts-node/issues/1132#issuecomment-716642560
One of the contributors of ts-node
suggested multiple ways to solve it. ts-node
的贡献者之一提出了多种解决方法。
Here is one of it: Specifying file: true
flag in tsconfig.json
to inform ts-node
to load files
, include
and exclude
options from tsconfig.json
on startup这是其中之一:在
tsconfig.json
中指定file: true
标志以通知ts-node
加载files
,在启动时从tsconfig.json
中include
和exclude
选项
{
"ts-node": {
"files": true
},
"exclude": [...],
"compilerOptions": {
...
}
OLD: (07-MAY-2021)旧:(2021 年 5 月 7 日)
There is no need to use include
in tsconfig.json
and the paths are not correct. tsconfig.json
中不需要使用include
,路径不正确。 The compiler can search the ts file in the directory and sub-directories编译器可以搜索目录和子目录下的ts文件
Try to remove it.尝试删除它。 and restart TS server.
并重新启动 TS 服务器。
If you are using VSCode, try Cmd + Shift + P or Ctrl + Shift + P and search Restart TS server
and see if the user type error still exist如果你用的是VSCode,试试Cmd + Shift + P或者Ctrl + Shift + P搜索
Restart TS server
看看用户类型错误是否依然存在
{
"exclude": [
"node_modules"
],
"compilerOptions": {
"lib": [
"esnext",
"esnext.asynciterable"
],
"baseUrl": ".",
"skipLibCheck": true,
"module": "commonjs",
"esModuleInterop": true,
"target": "es6",
"moduleResolution": "node",
"outDir": "build",
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"strictPropertyInitialization": false,
},
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.