From cda027b94aed0667062b07419c6e2acb52234d35 Mon Sep 17 00:00:00 2001 From: Julien Fontanet Date: Mon, 13 Jun 2022 11:22:42 +0200 Subject: [PATCH] docs(read-chunk): behavior when stream has ended --- @vates/read-chunk/.USAGE.md | 3 ++- @vates/read-chunk/README.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/@vates/read-chunk/.USAGE.md b/@vates/read-chunk/.USAGE.md index ecb5661d1..a90fd15fa 100644 --- a/@vates/read-chunk/.USAGE.md +++ b/@vates/read-chunk/.USAGE.md @@ -1,6 +1,7 @@ - returns the next available chunk of data - like `stream.read()`, a number of bytes can be specified -- returns `null` if the stream has ended +- returns with less data than expected if stream has ended +- returns `null` if the stream has ended and no data has been read ```js import { readChunk } from '@vates/read-chunk' diff --git a/@vates/read-chunk/README.md b/@vates/read-chunk/README.md index 19aec18d4..bfcae8028 100644 --- a/@vates/read-chunk/README.md +++ b/@vates/read-chunk/README.md @@ -18,7 +18,8 @@ Installation of the [npm package](https://npmjs.org/package/@vates/read-chunk): - returns the next available chunk of data - like `stream.read()`, a number of bytes can be specified -- returns `null` if the stream has ended +- returns with less data than expected if stream has ended +- returns `null` if the stream has ended and no data has been read ```js import { readChunk } from '@vates/read-chunk'