Skip to content

missing close event documentation for fs streams #6484

@mscdex

Description

@mscdex
  • Version: all
  • Platform: n/a
  • Subsystem: doc

Currently there is only a mention of a close event in the streams' Readable section of the docs. However in the fs docs, it is not mentioned that either fs.ReadStream or fs.WriteStream are some of the special streams that do emit close, but in fact both of them do emit close.

So I recommend two things:

  1. Explicitly document close in the events sections for fs.ReadStream and fs.WriteStream.
  2. Either move the description/documentation about the close event from the streams.Readable section to earlier in the document and explain it can be emitted by any kind of stream or copy the event description to at least the streams.Writable section.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions