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.

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

Jump to bottom

Document skip parameter in React Hooks #1673

Closed
VeskeR opened this issue Mar 8, 2024 · 1 comment
Closed

Document skip parameter in React Hooks #1673

VeskeR opened this issue Mar 8, 2024 · 1 comment
Assignees
@VeskeR
Labels
documentation Improvements or additions to public interface documentation (API reference or readme).

Comments

@VeskeR
Copy link
Contributor

VeskeR commented Mar 8, 2024 •
edited by sync-by-unito bot
Loading

skip

  • this parameter has no docs currently, nothing in commit messages (even in https://github.com/ably-labs/react-hooks).
    Currently it disables all onMount logic for presence (prevents entering presence and subscribing to events).
    Should research why it's needed, in what situations it is beneficial to use it and document in React README.

Start from this discussions:
ably-labs/react-hooks#76
ably-labs/react-hooks#4 (comment)

┆Issue is synchronized with this Jira Task by Unito
@VeskeR VeskeR added the documentation Improvements or additions to public interface documentation (API reference or readme). label Mar 8, 2024
@VeskeR VeskeR self-assigned this Mar 8, 2024
VeskeR added a commit that referenced this issue Mar 8, 2024
@VeskeR
Add documentation for skip parameter to React docs
6e9a9ed 
Resolves #1673
VeskeR added a commit that referenced this issue Mar 8, 2024
@VeskeR
Add documentation for skip parameter to React docs
2b1b0d1 
Resolves #1673
@VeskeR VeskeR mentioned this issue Mar 8, 2024
Merged
VeskeR added a commit that referenced this issue Mar 13, 2024
@VeskeR
Add documentation for skip parameter to React docs
dda3aab 
Resolves #1673
VeskeR added a commit that referenced this issue Mar 13, 2024
@VeskeR
Add documentation for skip parameter to React docs
735f27b 
Resolves #1673
@VeskeR
Copy link
Contributor Author

VeskeR commented Mar 13, 2024

Done in #1675

@VeskeR VeskeR closed this as completed Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@VeskeR VeskeR

Labels
documentation Improvements or additions to public interface documentation (API reference or readme).
Milestone
No milestone
Development

No branches or pull requests
1 participant
@VeskeR