Skip to content

React hooks reference #571

Description

@codebestia

Write apps/web/docs/hooks.md for src/hooks/: useSocket, useInboundPipeline, useMessageHistory, useLocalSearch, useMessageSearchIndex, usePushSubscription.

Acceptance criteria:

  • Each hook documented with arguments, return shape, side effects and cleanup
  • Documents which hooks are safe to mount more than once and which assume a single owner
  • Explains the ordering dependency between useSocket and useInboundPipeline
  • Notes the SSR constraint: hooks touching window, IndexedDB or WebCrypto must not run during server render

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationfrontend

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions