chore(typings): change export interface to class definition #2293
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
atian25
requested review from
whxaxes and
shepherdwind
and removed request for
whxaxes
Codecov Report
@@ Coverage Diff @@
## master #2293 +/- ##
=======================================
Coverage 99.59% 99.59%
=======================================
Files 29 29
Lines 749 749
=======================================
Hits 746 746
Misses 3 3Continue to review full report at Codecov.
|
relevant issue: eggjs#2292
|
for this usage: // lib/agent.ts
import * as path from 'path'
import {Agent as EggAgent} from 'egg'
export const EGG_PATH = Symbol.for('egg#eggPath');
export default class Agent extends EggAgent {
get [EGG_PATH]() {
return path.dirname(__dirname);
}
} |
|
使用 样例代码库 中 |
whxaxes
requested changes
Mar 30, 2018
index.d.ts
Outdated
| * Singleton instance in Agent Worker, extend {@link EggApplication} | ||
| */ | ||
| class Agent extends EggApplication { | ||
| _wrapMessenger(): void |
There was a problem hiding this comment.
这个 _wrapMessenger 是非暴露的方法把，我觉得不需要加进来
index.d.ts
Outdated
| https: boolean // https or not | ||
| key: string //ssl key | ||
| cert: string // ssl cert | ||
| typescript: boolean |
There was a problem hiding this comment.
typescript 这个入参，我记得我们当初定的时候，不是给用户用的吧？@atian25 ，应该不需要加进来？
index.d.ts
Outdated
| typescript: boolean | ||
| } | ||
|
|
||
| export function startCluster(options: ClusterOptions, callback: () => any): void |
atian25
reviewed
Mar 30, 2018
index.d.ts
Outdated
| key: string //ssl key | ||
| cert: string // ssl cert | ||
| typescript: boolean | ||
| framework: string; // specify framework that can be absolute path or npm package |
There was a problem hiding this comment.
这样的注释，在 vscode 那边能看到提示么？
是不是要用 jsdoc 的方式来做注释？
There was a problem hiding this comment.
如果是 vsc ，鼠标 ctrl+hover时 可以显示注释内容的
|
|
|
如果改成这种格式，悬浮提示时参数显示数量更少
|
plugins, port, https, key, cert, typescript
whxaxes
reviewed
Mar 30, 2018
index.d.ts
Outdated
| // typescript?: boolean; | ||
| } | ||
|
|
||
| export function startCluster(options: ClusterOptions, callback: () => any): void |
whxaxes
approved these changes
Mar 30, 2018
atian25
reviewed
Apr 2, 2018
index.d.ts
Outdated
| } | ||
|
|
||
| export interface ClusterOptions { | ||
| framework: string; // specify framework that can be absolute path or npm package |
There was a problem hiding this comment.
framework / baseDir / workers 都是可选的
popomore
pushed a commit
that referenced
this pull request
Apr 3, 2018
chore(typings): change export interface to class definition (#2293)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
issue: #2292
Checklist
npm testpassesAffected core subsystem(s)
Description of change
issue link