Skip to content

Commit 6491654

Browse files
silverwinddarinspivey
authored andcommitted
docs: Fix docs on return value of quit
1 parent 0ebab58 commit 6491654

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ that data will not flow through the stream [until it's consumed][reading modes].
321321

322322
### `tail.quit()`
323323

324-
* Returns: `undefined`
324+
* Returns: [`<Promise>`][] - Resolves after `flush` is called and streams are closed.
325325
* Emits: [`close`](#event-any-readable-event) when the parent `Readstream` is ended.
326326

327327
This function calls `flush`, then closes all streams and exits cleanly. The parent `TailFile` stream will be

0 commit comments

Comments
 (0)