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

Mixed documentation for .subscribe() #85

Open
heavy-matill opened this issue Sep 2, 2022 · 1 comment
Open

Mixed documentation for .subscribe() #85

heavy-matill opened this issue Sep 2, 2022 · 1 comment

Comments

@heavy-matill
Copy link

To subscribe for events the documentation in README.md differs from implementation
README.md suggests:
// Register callback MusicControls.subscribe(events);

index.d.ts documents @usage as:
this.musicControls.subscribe().subscribe(action => {...});

The latter does work, so it should be fixed in README.md. However I would rather like the implementation to switch from .subscribe().subscribe(...) to .subscribe(...).

@ghenry22
Copy link
Owner

Thanks I'll review the docs, it's been a while since I looked at them properly.

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

2 participants