chore: add typings and jsdocs (#31)

eggjs · May 16, 2019 · c5c4308 · c5c4308
1 parent 5ce5d7f
commit c5c4308
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/config/config.default.js b/config/config.default.js
@@ -12,6 +12,7 @@ module.exports = appInfo => {
    * @property {String} mode - which mode to handle multipart request, default is `stream`, the hard way.
    *   If set mode to `file`, it's the easy way to handle multipart request and save it to local files.
    *   If you don't know the Node.js Stream work, maybe you should use the `file` mode to get started.
+   * @property {RegExp} fileModeMatch - special url to use file mode when global `mode` is `stream`.
    * @property {Boolean} autoFields - Auto set fields to parts, default is `false`. Only work on `stream` mode.
    *   If set true，all fields will be auto handle and can acces by `parts.fields`
    * @property {String} defaultCharset - Default charset encoding, don't change it before you real know about it

diff --git a/index.d.ts b/index.d.ts
@@ -98,6 +98,7 @@ declare module 'egg' {
   interface EggAppConfig {
     multipart: {
       mode?: string;
+      fileModeMatch?: RegExp;
       autoFields?: boolean;
       defaultCharset?: string;
       fieldNameSize?: number;