Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(typings): change export interface to class definition #2293

Merged
merged 19 commits into from
Apr 3, 2018
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ declare module 'egg' {
url(name: string, params: any): any;
}

interface EggApplication extends KoaApplication { // tslint:disable-line
class EggApplication extends KoaApplication { // tslint:disable-line
/**
* The current directory of application
*/
Expand Down Expand Up @@ -498,7 +498,7 @@ declare module 'egg' {

type RouterPath = string | RegExp;

export interface Application extends EggApplication {
class Application extends EggApplication {
/**
* global locals for view
* @see Context#locals
Expand Down Expand Up @@ -849,4 +849,25 @@ declare module 'egg' {
*/
urlFor(name: string, params?: { [key: string]: any }): string;
}

/**
* Singleton instance in Agent Worker, extend {@link EggApplication}
*/
class Agent extends EggApplication {
}

export interface ClusterOptions {
framework?: string; // specify framework that can be absolute path or npm package
baseDir?: string; // directory of application, default to `process.cwd()`
plugins?: object | null; // customized plugins, for unittest
workers?: number; // numbers of app workers, default to `os.cpus().length`
port?: number; // listening port, default to 7001(http) or 8443(https)
https?: boolean; // https or not
key?: string; //ssl key
cert?: string; // ssl cert
// typescript?: boolean;
[prop: string]: any;
}

export function startCluster(options: ClusterOptions, callback: (...args: any[]) => any): void;
}