Skip to content
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.

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

Add comment documentation everywhere #11

Open
stylianosnicoletti opened this issue Apr 24, 2021 · 0 comments
Open

Add comment documentation everywhere #11

stylianosnicoletti opened this issue Apr 24, 2021 · 0 comments

Comments

@stylianosnicoletti
Copy link
Owner

stylianosnicoletti commented Apr 24, 2021

Follow this approach:

 /**
 * Adds a tear down to be called during the unsubscribe() of this
 * Subscription. Can also be used to add a child subscription.
 *
 * If the tear down being added is a subscription that is already
 * unsubscribed, is the same reference `add` is being called on, or is
 * `Subscription.EMPTY`, it will not be added.
 *
 * If this subscription is already in an `closed` state, the passed
 * tear down logic will be executed immediately.
 *
 * When a parent subscription is unsubscribed, any child subscriptions that were added to it are also unsubscribed.
 *
 * @param {TeardownLogic} teardown The additional logic to execute on
 * teardown.
 * @return {Subscription} Returns the Subscription used or created to be
 * added to the inner subscriptions list. This Subscription can be used with
 * `remove()` to remove the passed teardown logic from the inner subscriptions
 * list.
 */
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant