docs: add serverTimeout to d.ts (#3200)

eggjs · Nov 16, 2018 · db999d3 · db999d3
1 parent a43fef4
commit db999d3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -447,6 +447,15 @@ declare module 'egg' {
 
     onClientError(err: Error, socket: Socket, app: EggApplication): ClientErrorResponse | Promise<ClientErrorResponse>;
 
+    /**
+     * server timeout in milliseconds, default to 2 minutes.
+     *
+     * for special request, just use `ctx.req.setTimeout(ms)`
+     *
+     * @see https://nodejs.org/api/http.html#http_server_timeout
+     */
+    serverTimeout: number | null;
+
     [prop: string]: any;
   }
 

diff --git a/test/fixtures/apps/app-ts/config/config.ts b/test/fixtures/apps/app-ts/config/config.ts
@@ -1,3 +1,4 @@
 export default {
   keys: 'foo',
+  serverTimeout: 2 * 60 * 1000,
 }