diff options
author | Robert Nagy <ronagy@icloud.com> | 2019-08-09 09:01:43 +0200 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-10-12 13:13:34 -0700 |
commit | 773769df60ac4f2448fa88b2ece035de2512928f (patch) | |
tree | c27db6e5829bb3ad8c0c0b398104aedbfc597d3a /doc | |
parent | 039eb5624950ca5eba46fad8ab78924441d7acfc (diff) | |
download | android-node-v8-773769df60ac4f2448fa88b2ece035de2512928f.tar.gz android-node-v8-773769df60ac4f2448fa88b2ece035de2512928f.tar.bz2 android-node-v8-773769df60ac4f2448fa88b2ece035de2512928f.zip |
fs: add runtime deprecate for file stream open()
WriteStream.open() and ReadStream.open() are undocumented internal
APIs that do not make sense to use in userland. File streams should
always be opened through their corresponding factory methods
(fs.createWriteStream() and fs.createReadStream()) or by passing a file
descriptor in options.
PR-URL: https://github.com/nodejs/node/pull/29061
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/deprecations.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index aaec4a3c99..8b36e0c3aa 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2532,6 +2532,22 @@ Type: Documentation-only (supports [`--pending-deprecation`][]) The `process._tickCallback` property was never documented as an officially supported API. +<a id="DEP0XXX"></a> +### DEP0XXX: `WriteStream.open()` and `ReadStream.open()` are internal +<!-- YAML +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/29061 + description: Runtime deprecation. +--> + +Type: Runtime + +[`WriteStream.open()`][] and [`ReadStream.open()`][] are undocumented internal +APIs that do not make sense to use in userland. File streams should always be +opened through their corresponding factory methods [`fs.createWriteStream()`][] +and [`fs.createReadStream()`][]) or by passing a file descriptor in options. + [`--pending-deprecation`]: cli.html#cli_pending_deprecation [`--throw-deprecation`]: cli.html#cli_throw_deprecation [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size @@ -2542,10 +2558,12 @@ an officially supported API. [`Decipher`]: crypto.html#crypto_class_decipher [`EventEmitter.listenerCount(emitter, eventName)`]: events.html#events_eventemitter_listenercount_emitter_eventname [`REPLServer.clearBufferedCommand()`]: repl.html#repl_replserver_clearbufferedcommand +[`ReadStream.open()`]: fs.html#fs_class_fs_readstream [`Server.connections`]: net.html#net_server_connections [`Server.getConnections()`]: net.html#net_server_getconnections_callback [`Server.listen({fd: <number>})`]: net.html#net_server_listen_handle_backlog_callback [`SlowBuffer`]: buffer.html#buffer_class_slowbuffer +[`WriteStream.open()`]: fs.html#fs_class_fs_writestream [`assert`]: assert.html [`asyncResource.runInAsyncScope()`]: async_hooks.html#async_hooks_asyncresource_runinasyncscope_fn_thisarg_args [`child_process`]: child_process.html @@ -2568,6 +2586,8 @@ an officially supported API. [`ecdh.setPublicKey()`]: crypto.html#crypto_ecdh_setpublickey_publickey_encoding [`emitter.listenerCount(eventName)`]: events.html#events_emitter_listenercount_eventname [`fs.access()`]: fs.html#fs_fs_access_path_mode_callback +[`fs.createReadStream()`]: fs.html#fs_fs_createreadstream_path_options +[`fs.createWriteStream()`]: fs.html#fs_fs_createwritestream_path_options [`fs.exists(path, callback)`]: fs.html#fs_fs_exists_path_callback [`fs.lchmod(path, mode, callback)`]: fs.html#fs_fs_lchmod_path_mode_callback [`fs.lchmodSync(path, mode)`]: fs.html#fs_fs_lchmodsync_path_mode |