Skip to content

docs(net): say who owns the broadcast behind Announce.Broadcast.active #2640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kixelated merged 2 commits into from
Aug 4, 2026
Merged

docs(net): say who owns the broadcast behind Announce.Broadcast.active #2640

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
575ab7b
docs(net): say who owns the broadcast behind Announce.Broadcast.active
kixelated Aug 4, 2026
7bd6a4a
docs(net): qualify what closing the borrowed consumer costs
kixelated Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion js/net/src/announced.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,15 @@ export class Broadcast {
/** The broadcast path this handle watches. */
readonly path: Path.Valid;

/** The live broadcast, or `undefined` while it is offline. */
/**
* The live broadcast, or `undefined` while it is offline.
*
* Borrowed, not yours to close: this handle owns the consumer and swaps it when the path is
* republished. `active` keeps pointing at whatever you closed, so once you drop the last
* reference the shared broadcast is gone and reads fail until the next announcement replaces
* it. Take a {@link broadcast.Consumer.clone} for a lifetime of your own, or close this whole
* handle to release everything.
*/
readonly active: Getter<broadcast.Consumer | undefined>;

#active = new Signal<broadcast.Consumer | undefined>(undefined);
Expand Down
Loading