docs: document AbortSignal for real-time connect()#508
Open
Hadi-Almusawi wants to merge 1 commit into
Open
Conversation
6486637 to
7da7992
Compare
7da7992 to
88dbbf9
Compare
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
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.
Proposed changes
Documents the
abortSignaloption onlisten.v1.connect()(andagent.v1/speak.v1). It's the supported way to cancel a connection and close it cleanly, even one that's still opening. The option already works, it just wasn't documented.37-abortsignal-cancellation.ts: connect with AbortSignal → stream audio → callabort()to close the connection. Wired into the Makefile andmake examples.Example output (make example-37)
Note on scope
Covers the AbortSignal documentation portion of #507. Exposing
removeAllListeners()on the Fern-generated socket classes is intentionally out of scope, as those classes are generated from the API spec.