docs: add async await #349

dead-horse · 2017-02-10T07:13:53Z

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

mention-bot · 2017-02-10T07:13:54Z

@dead-horse, thanks for your PR! By analyzing the history of the files in this pull request, we identified @popomore and @atian25 to be potential reviewers.

dead-horse · 2017-02-10T07:18:14Z

eggjs/examples#12

atian25 · 2017-02-10T07:18:32Z

docs/source/zh-cn/basics/controller.md

  class PostController extends app.Controller {
    * create() {
-      const ctx = this.ctx;
+      const { ctx, service } = this;


对喔, 都忘记有这个了, 那回头可以改改 quickstart 和 hackernews

atian25 · 2017-02-10T07:19:46Z

docs/source/zh-cn/tutorials/async-function.md

+
+## 中间件
+
+egg 中所有的中间件，包括[标准定义方式](../basics/middleware.md)以及在[路由中定义的中间件](../basics/router.md#中间件的使用)都可以通过 async function 来编写。但是和 generator function 格式的中间件稍有不同的是，中间件的参数列表变化了，和 koa v2.x 一样：


egg -> 框架

fengmk2 · 2017-02-10T08:05:54Z

docs/source/zh-cn/tutorials/async-function.md

+
+**注意：在基于 async function 编写 egg 应用代码时，请确保你的代码运行在 node 7.6+ 的版本上。**
+
+## controller & controller


controller & service?

dead-horse · 2017-02-10T08:54:21Z

fixed

popomore · 2017-02-10T10:44:41Z

docs/source/zh-cn/tutorials/async-function.md

+
+- generator function
+
+```js


这个要缩进吧

哪里缩进？

就是按 list 缩进

- generator function ``js // code `` - async function ``js // code ``

这样？

恩，部分 markdown 需要4格，github 好像支持两格

好像4个空格也会被视为 code 语法

fengmk2 · 2017-02-10T10:56:17Z

docs/source/zh-cn/tutorials/async-function.md

+
+    // 设置 gzip body，修正响应头
+    ctx.body = zlib.createGzip().end(body);
+    ctx.set('Content-Encoding', encoding);


encoding 没地方定义？

codecov · 2017-02-11T05:45:16Z

Codecov Report

Merging #349 into master will not change coverage.

@@          Coverage Diff          @@
##           master   #349   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          28     28           
  Lines         636    636           
=====================================
  Hits          636    636

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae78092...2ef53cb. Read the comment docs.

atian25 · 2017-02-12T00:38:49Z

docs/source/zh-cn/tutorials/async-function.md

+title: 使用 async function 开发应用
+---
+
+[前面的章节](../intro/egg-and-koa.md#async function)中介绍了 [async function] 是 js 语言层面提供的异步解决方案，而 node 从 7.6.0 开始将会升级 v8 到 5.5，届时 async function 将不再需要开启 flag 即可使用。框架也默认支持了 async function，在所有支持 generator function 的地方都可以使用 async function 替代。


编译出的文档，前面的章节 link 有问题

docs: add async await

b2fe5c4

dead-horse added the type: document label Feb 10, 2017

dead-horse requested review from fengmk2 and popomore February 10, 2017 07:13

f

ba11c4b

dead-horse mentioned this pull request Feb 10, 2017

全面支持 aa #323

Closed

9 tasks

atian25 approved these changes Feb 10, 2017

View reviewed changes

fengmk2 reviewed Feb 10, 2017

View reviewed changes

f

2577001

popomore reviewed Feb 10, 2017

View reviewed changes

popomore approved these changes Feb 10, 2017

View reviewed changes

fengmk2 reviewed Feb 10, 2017

View reviewed changes

f

2ef53cb

fengmk2 approved these changes Feb 11, 2017

View reviewed changes

fengmk2 merged commit cd02057 into master Feb 11, 2017

fengmk2 deleted the doc-async-await branch February 11, 2017 18:13

atian25 reviewed Feb 12, 2017

View reviewed changes


		## 中间件

		egg 中所有的中间件，包括[标准定义方式](../basics/middleware.md)以及在[路由中定义的中间件](../basics/router.md#中间件的使用)都可以通过 async function 来编写。但是和 generator function 格式的中间件稍有不同的是，中间件的参数列表变化了，和 koa v2.x 一样：


		注意：在基于 async function 编写 egg 应用代码时，请确保你的代码运行在 node 7.6+ 的版本上。

		## controller & controller

Uh oh!

docs: add async await #349

docs: add async await #349

Uh oh!

Conversation

dead-horse commented Feb 10, 2017

Checklist

Affected core subsystem(s)

Description of change

Uh oh!

mention-bot commented Feb 10, 2017

Uh oh!

dead-horse commented Feb 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dead-horse commented Feb 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dead-horse Feb 11, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 11, 2017

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dead-horse Feb 11, 2017 •

edited

Loading