From 81b91f8cf42bdaede7b4f819da8bdc0a42fdc7c0 Mon Sep 17 00:00:00 2001 From: tikkhun Date: Sat, 19 Nov 2022 13:49:28 +0800 Subject: [PATCH 1/6] docs(reference/reply): When using async-await, please return the reply object to signal fastify wait for your further response. --- docs/Reference/Reply.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/Reference/Reply.md b/docs/Reference/Reply.md index b5d690ae83..2114f98d0d 100644 --- a/docs/Reference/Reply.md +++ b/docs/Reference/Reply.md @@ -674,6 +674,15 @@ fastify.get('/streams', function (request, reply) { reply.send(stream) }) ``` +When using async-await, please return the reply object to signal fastify wait for your further response. +```js +fastify.get('/streams', async function (request, reply) { + const fs = require('fs') + const stream = fs.createReadStream('some-file', 'utf8') + reply.header('Content-Type', 'application/octet-stream') + return reply.send(stream) +}) +``` #### Buffers @@ -689,6 +698,16 @@ fastify.get('/streams', function (request, reply) { }) ``` +When using async-await, please return the reply object to signal fastify wait for your further response. +```js +const fs = require('fs') +fastify.get('/streams', function (request, reply) { + fs.readFile('some-file', (err, fileBuffer) => { + reply.send(err || fileBuffer) + }) + return reply +}) +``` #### Errors From a2f11952cabdfb27c752b572a6206823914e5055 Mon Sep 17 00:00:00 2001 From: tikkhun Date: Sat, 19 Nov 2022 13:49:28 +0800 Subject: [PATCH 2/6] docs(reference/reply): When using async-await, please return the reply object to signal fastify wait for your further response. --- docs/Reference/Reply.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/Reference/Reply.md b/docs/Reference/Reply.md index b5d690ae83..b18a45100b 100644 --- a/docs/Reference/Reply.md +++ b/docs/Reference/Reply.md @@ -674,6 +674,16 @@ fastify.get('/streams', function (request, reply) { reply.send(stream) }) ``` +When using async-await, please return the reply object to signal fastify wait +for your further response. +```js +fastify.get('/streams', async function (request, reply) { + const fs = require('fs') + const stream = fs.createReadStream('some-file', 'utf8') + reply.header('Content-Type', 'application/octet-stream') + return reply.send(stream) +}) +``` #### Buffers @@ -689,6 +699,17 @@ fastify.get('/streams', function (request, reply) { }) ``` +When using async-await, please return the reply object to signal fastify wait +for your further response. +```js +const fs = require('fs') +fastify.get('/streams', function (request, reply) { + fs.readFile('some-file', (err, fileBuffer) => { + reply.send(err || fileBuffer) + }) + return reply +}) +``` #### Errors From a8e5f095ecb7e951321905d0a263822090afe4ba Mon Sep 17 00:00:00 2001 From: Tikkhun Date: Sun, 20 Nov 2022 09:41:53 +0800 Subject: [PATCH 3/6] Update docs/Reference/Reply.md Co-authored-by: Frazer Smith --- docs/Reference/Reply.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Reference/Reply.md b/docs/Reference/Reply.md index b18a45100b..c26a74db23 100644 --- a/docs/Reference/Reply.md +++ b/docs/Reference/Reply.md @@ -703,7 +703,7 @@ When using async-await, please return the reply object to signal fastify wait for your further response. ```js const fs = require('fs') -fastify.get('/streams', function (request, reply) { +fastify.get('/streams', async function (request, reply) { fs.readFile('some-file', (err, fileBuffer) => { reply.send(err || fileBuffer) }) From 17a0e493e4aefa246cdb146434c9dfd25463a894 Mon Sep 17 00:00:00 2001 From: Tikkhun Date: Fri, 25 Nov 2022 08:59:31 +0800 Subject: [PATCH 4/6] Update docs/Reference/Reply.md Co-authored-by: Frazer Smith --- docs/Reference/Reply.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/Reference/Reply.md b/docs/Reference/Reply.md index c26a74db23..855cce20f4 100644 --- a/docs/Reference/Reply.md +++ b/docs/Reference/Reply.md @@ -674,8 +674,7 @@ fastify.get('/streams', function (request, reply) { reply.send(stream) }) ``` -When using async-await, please return the reply object to signal fastify wait -for your further response. +When using async-await you will need to return the reply object: ```js fastify.get('/streams', async function (request, reply) { const fs = require('fs') From f49a377d0397dc13153f5c0ce67fb573f3906a2a Mon Sep 17 00:00:00 2001 From: Tikkhun Date: Sat, 26 Nov 2022 09:10:57 +0800 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: Andrey Chalkin --- docs/Reference/Reply.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Reference/Reply.md b/docs/Reference/Reply.md index 855cce20f4..9d546d9209 100644 --- a/docs/Reference/Reply.md +++ b/docs/Reference/Reply.md @@ -674,7 +674,7 @@ fastify.get('/streams', function (request, reply) { reply.send(stream) }) ``` -When using async-await you will need to return the reply object: +When using async-await you will need to return or await the reply object: ```js fastify.get('/streams', async function (request, reply) { const fs = require('fs') From de2d6bba4b325a333d3f399f6c4f3d7189051ff4 Mon Sep 17 00:00:00 2001 From: tikkhun Date: Sat, 26 Nov 2022 09:16:12 +0800 Subject: [PATCH 6/6] docs: return or await reply when async-await --- docs/Reference/Reply.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/Reference/Reply.md b/docs/Reference/Reply.md index 9d546d9209..0f8e99db79 100644 --- a/docs/Reference/Reply.md +++ b/docs/Reference/Reply.md @@ -698,8 +698,7 @@ fastify.get('/streams', function (request, reply) { }) ``` -When using async-await, please return the reply object to signal fastify wait -for your further response. +When using async-await you will need to return or await the reply object: ```js const fs = require('fs') fastify.get('/streams', async function (request, reply) {