Add addTeardown(). Closes #3. Closes #19.
#61
Merged
Conversation
This file contains 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
The intent with that analogy was to describe how *part* of `addTeardown()` is syntactic sugar over immediately checking `subscriber.signal.aborted`, and *otherwise* setting the given cleanup function to the signal's abort handler, and also invoking it during `complete()` and `error()`, but that latter part was not clear at all and was contradictory as @annevk pointed out. So this commit removes the example, in favor of the earlier descriptive text.
benlesh
approved these changes
Sep 13, 2023
domfarolino
commented
Sep 13, 2023
| @@ -470,6 +470,7 @@ If the subscriber has already been aborted (i.e., `subscriber.signal.aborted` is | |||
| - From `complete()`, after the subscriber's complete handler (if any) is | |||
| invoked | |||
| - From `error()`, after the subscriber's error handler (if any) is invoked | |||
| - The signal passed to the subscription is aborted by the user. | |||
There was a problem hiding this comment.
Technically I don't think this was needed because of https://github.com/domfarolino/observable/pull/61/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R466-R467 (i.e., we're already in the "Otherwise" branch here) but I guess it can't hurt?
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.
This PR clarifies the
addTeardown()API, which is just syntactic sugar over responding accordingly toSubscriber#signal. I'm honestly not 100% sure if we need it, but it does seem like a nice first-class convenience API to get around the pesky is-this-signal-already-aborted check that would have to be made by ever subscriber with a clean-up function, at least untilAbortSignalgets an API likewhenAborted().My only concern here is that it might be confusing if we expose both
Subscriber#signalandSubscriber#addTeardown(), when you really only need one or the other. If we're going to have this first-class API, I kind of lean towards not exposingSubscriber#signalanymore, and pushing people to useaddTeardown()exclusively, but what do you think @benlesh?