docs(middleware.md): translated & proofread 'middleware.md' #783
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
added 6 commits
March 27, 2017 11:46
'middleware.md' is translated by @lslxdx and proofread by @闷油瓶小张
Codecov Report
@@ Coverage Diff @@
## master #783 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 25 25
Lines 641 641
=====================================
Hits 641 641Continue to review full report at Codecov.
|
atian25
requested changes
Apr 20, 2017
docs/source/en/basics/middleware.md
Outdated
| function* gzip(next) { | ||
| yield next; | ||
|
|
||
| // convert the reaponse body to gzip after the completion of the execution of subsequent middleware |
docs/source/en/basics/middleware.md
Outdated
| if (!body) return; | ||
| if (isJSON(body)) body = JSON.stringify(body); | ||
|
|
||
| // set gzip body, correct the reponse header |
docs/source/en/basics/middleware.md
Outdated
|
|
||
| Usually the middleware has its own configuration. In the framework, a complete middleware is including the configuration process. We agree that a middleware is a separate file placed in `app/middleware` directory, which needs a exports function that take two paramters: | ||
|
|
||
| - options: the configuration field of the middleware, `app.config[${middlewareName}]` will be passed in by the frame |
There was a problem hiding this comment.
👍 You're right, it's my fault.
Next time I will paste the doc to LibreOffice (any recommendation?) to find typos before commit it.
docs/source/en/basics/middleware.md
Outdated
| return function* gzip(next) { | ||
| yield next; | ||
|
|
||
| // convert the reaponse body to gzip after the completion of the execution of subsequent middleware |
docs/source/en/basics/middleware.md
Outdated
|
|
||
| if (isJSON(body)) body = JSON.stringify(body); | ||
|
|
||
| // set gzip body, correct the reponse header |
docs/source/en/basics/middleware.md
Outdated
|
|
||
| ## Default Framework Middleware | ||
|
|
||
| In addition to the application layer middleware is imported, the framework itself and other plug-ins will also import many middleware. All the config fields of these built-in middlewares can be modified by modifying the ones with the same name in the config file, for example [Framework Built-in Plugin](https://github.com/eggjs/egg/tree/master/app/middleware) uses a bodyParser middleware(the framework loader will change the file name separated by delimiters into the camel style), and we can add configs below in `config/confg.default.js` to modify the bodyParser: |
There was a problem hiding this comment.
typo: config/confg.default.js -> config/config.default.js
fix typos like: 'reaponse -> response', 'config/confg.default.js -> config/config.default.js' and so on. Thanks to @atian25
|
Fixed and the revision is 1bdef05. |
|
What should I do next to make this PR be merged? |
|
@lslxdx just wait for other guys review |
|
Please use github email as commit author email |
|
@fengmk2 Oops, I forgot it! Should I re-commit the doc and create a new PR? |
1 task
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.
Checklist
Affected core subsystem(s)
Description of change
'middleware.md' is translated by @lslxdx and proofread by @闷油瓶小张
mv to #784