Skip to content

fs: Add file descriptor support to *File() funcs

Rodrigo Muino Tomonari requested to merge github/fork/jwueller/fs-optional-file-descriptor-args into master

This is a re-targeted submission of the archived PR #8522, implementing the archived issue #8471.

The original description follows.

These changes affect the following functions and their synchronous counterparts:

  • fs.readFile()
  • fs.writeFile()
  • fs.appendFile()

If the first parameter is a uint32, it is treated as a file descriptor. In all other cases, the original implementation is used to ensure backwards compatibility. File descriptor ownership is never taken from the user.

The documentation was adjusted to reflect these API changes. A note was added to make the user aware of file descriptor ownership and the conditions under which a file descriptor can be used by each of these functions.

Tests were extended to test for file descriptor parameters under the conditions noted in the relevant documentation.

Merge request reports