diff options
| author | Lance Ball <lball@redhat.com> | 2017-07-13 14:17:33 -0400 |
|---|---|---|
| committer | Lance Ball <lball@redhat.com> | 2017-08-02 14:39:06 -0400 |
| commit | 766506a2e947b297926e046051841eae78705b92 (patch) | |
| tree | aa63eb3c2131ea10d6e26aa99b5828b0c6fdd9c7 /doc | |
| parent | e506bcd899b3530ec69bdc00d5bac469b5753081 (diff) | |
| download | android-node-v8-766506a2e947b297926e046051841eae78705b92.tar.gz android-node-v8-766506a2e947b297926e046051841eae78705b92.tar.bz2 android-node-v8-766506a2e947b297926e046051841eae78705b92.zip | |
repl: deprecate REPLServer.parseREPLKeyword
This method does not need to be visible to user code. It has been
undocumented since it was introduced which was perhaps v0.8.9.
The motivation for this change is that the method is simply an
implementation detail of the REPLServer behavior, and does
not need to be exposed to user code.
This change adds documentation of the method with a deprecation
warning, and a test that the method is actually documented.
PR-RUL: https://github.com/nodejs/node/pull/14223
Refs: https://github.com/nodejs/node/issues/7619
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/deprecations.md | 8 | ||||
| -rw-r--r-- | doc/api/repl.md | 14 |
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index f6c51217e0..c34f4e04d9 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -653,6 +653,14 @@ Type: Runtime The `REPLServer.bufferedCommand` property was deprecated in favor of [`REPLServer.clearBufferedCommand()`][]. +<a id="DEP0075"></a> +### DEP0075: REPLServer.parseREPLKeyword() + +Type: Runtime + +`REPLServer.parseREPLKeyword()` was removed from userland visibility. + + [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size [`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array [`Buffer.from(buffer)`]: buffer.html#buffer_class_method_buffer_from_buffer diff --git a/doc/api/repl.md b/doc/api/repl.md index 7a9c1f81e5..4ed95f6111 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -385,6 +385,20 @@ buffered but not yet executed. This method is primarily intended to be called from within the action function for commands registered using the `replServer.defineCommand()` method. +### replServer.parseREPLKeyword(keyword, [rest]) +<!-- YAML +added: v0.8.9 +deprecated: REPLACEME +--> + +* `keyword` {string} the potential keyword to parse and execute +* `rest` {any} any parameters to the keyword command + +> Stability: 0 - Deprecated. + +An internal method used to parse and execute `REPLServer` keywords. +Returns `true` if `keyword` is a valid keyword, otherwise `false`. + ## repl.start([options]) <!-- YAML added: v0.1.91 |