doc: add warning to readline's close() method - #22679
Conversation
Sorry, something went wrong.
|
@cjihrig build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/785/pipeline |
Sorry, something went wrong.
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
Sorry, something went wrong.
There was a problem hiding this comment.
Micro-nit: Is immediately meaningful here? Would it be better without it?
Sorry, something went wrong.
There was a problem hiding this comment.
Instead of immediately, might necessarily be better?
Sorry, something went wrong.
There was a problem hiding this comment.
I copied the text from the pause() docs for consistency. That said, I'm open to using any wording here if you feel strongly enough.
Sorry, something went wrong.
There was a problem hiding this comment.
It’s a nit. I don’t feel strongly.
Sorry, something went wrong.
When close() is called on a readline instance, it is possible that data is already buffered, and will trigger 'line' events. This commit adds a warning to the corresponding docs. Note that a similar warning already exists for the pause() method. PR-URL: nodejs#22679 Fixes: nodejs#22615 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sorry, something went wrong.
When close() is called on a readline instance, it is possible that data is already buffered, and will trigger 'line' events. This commit adds a warning to the corresponding docs. Note that a similar warning already exists for the pause() method. PR-URL: #22679 Fixes: #22615 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
When close() is called on a readline instance, it is possible that data is already buffered, and will trigger 'line' events. This commit adds a warning to the corresponding docs. Note that
a similar warning already exists for the pause() method.
Fixes: #22615
Checklist