feat: add public close methods #482
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add method to close transport and writer.
Before there was no public way to close the transport/reader/writer created by attach
for a socket, and the connection would hold the node process open.
For example, this script would not exit (without an explicit process.exit(0))
```
attach({ socket: pathToNvimSocket })
```
This change adds .close to transport and NeovimClient which ends the writer.
The other side of the connection should then close the reader which triggers detach and the
cleanup code.
I added asyncDispose methods for folks using modern javascript runtimes that support explicit
resource management:
```
await using client = attach({ socket: pathToNvimSocket })
```
Other wise you can call close
```
try {
const client = attach({ socket: pathToNvimSocket })
} finally {
await client.close()
}
```
justinmk
reviewed
Sep 1, 2025
Comment on lines
-91
to
93
| this.reader.on('end', () => { | ||
| this.reader.once('end', () => { | ||
| this.emit('detach'); |
There was a problem hiding this comment.
nice change, I wonder if this will fix some test flakiness that happens sometimes
justinmk
reviewed
Sep 1, 2025
| @@ -249,4 +250,15 @@ export class NeovimClient extends Neovim { | |||
|
|
|||
| return false; | |||
| } | |||
|
|
|||
| async close(): Promise<void> { | |||
There was a problem hiding this comment.
should this be called dispose() ? I guess you thought of that, since you referenced
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncDispose
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/dispose
|
This is a nice change, thanks! Included in the 5.4.0 release: https://www.npmjs.com/package/neovim |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add method to close transport and writer.
Before there was no public way to close the transport/reader/writer created by attach for a socket, and the connection would hold the node process open.
For example, this script would not exit (without an explicit process.exit(0))
This change adds .close to transport and NeovimClient which ends the writer. The other side of the connection should then close the reader which triggers detach and the cleanup code.
I added asyncDispose methods for folks using modern javascript runtimes that support explicit resource management:
Other wise you can call close
fix #481