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

Allow subscriptions to be removed #455

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

rzane
Copy link

@rzane rzane commented Mar 23, 2024

This is admittedly not the most elegant API, but my goal is to start a discussion about how this should look.

Here's how you'd subscribe and unsubscribe:

subscription = page.on("Some.event") do |params, _index, _total|
  # etc
end

page.off("Some.event", subscription)

Here are some important considerations:

  • The #on method previously returned true. Now, it returns the index of the block within @on[event]. This could be considered a breaking change. Rather than using #on and #off, we could introduce a new method called #subscribe.
  • Rather than returning a value that identifies the specific event handler, we could return an object that has an #unsubscribe method.

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

Successfully merging this pull request may close these issues.

1 participant