docs: add TypeScript Guide #2324
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2324 +/- ##
=======================================
Coverage 99.61% 99.61%
=======================================
Files 29 29
Lines 773 773
=======================================
Hits 770 770
Misses 3 3Continue to review full report at Codecov.
|
| } | ||
|
|
||
| // 将 Egg 整个 export 出去 | ||
| export = Egg; |
There was a problem hiding this comment.
要的，否则框架继承会有问题， @whxaxes 来解释下吧
There was a problem hiding this comment.
使用 export = ，就相当于完全将 egg 导出去，import 上层框架的时候也能引入 egg 的类型，如果在插件中通过 declare module 'egg' 拓展也能够 merge 进上层框架。但是如果是 export * from 'egg' ，测试过发现会没法 merge 进去
There was a problem hiding this comment.
这样写也会有问题的，这里要实现继承，比如自定义了 startCluster，并增加了一个参数，那这里其实就不是 Egg 的了。
There was a problem hiding this comment.
如果要自定义，就直接在上层框架中，比如我的上层框架叫 larva，就直接在 larva 的 d.ts 中
...
export = Egg;
declare module 'larva' {
export function startCluster(xxx): void;
}我在我们团队的上层框架就是这么实现的，暂时还没遇到什么问题。
There was a problem hiding this comment.
如果这样定义，这句就不需要了吧 export = Egg;，都是通过 import * as Larva from 'larva'
There was a problem hiding this comment.
需要啊，如果没有这句
import { EggAppConfig } from 'larva'这样写就出错了
There was a problem hiding this comment.
import * as Larva from 'larva'
const EggAppConfig = Larva.EggAppConfig;
module 的意思就是 commonjs 的方式，而上面的写法其实是 es module。所以上面的 export 是很奇怪的。
There was a problem hiding this comment.
是的，官方文档也是这么说，不过经过各种尝试，再看到 power-assert 他们的 typings 也是这么写的，将 export = node 的 assert ，自己试了一下发现确实这样可以实现多层框架拓展的问题，所以就这么写了
|
英文的可以先 google translate 一下 |
|
英文的我让 方正 来翻译 |
|
@atian25 没问题合了吧 |
docs: add TypeScript Guide (#2324)
Checklist
npm testpassesAffected core subsystem(s)
Description of change