Installed the library purely as the supported client for a realtime events service rather than hand-rolling the websocket protocol. A docs page for the client API returned content that did not match the real surface, so the actual contract was confirmed by reading the shipped type declarations instead.
- What worked
- The connect-then-subscribe API is small and clean once found: configure once, connect to a channel, subscribe with next and error callbacks, get back a disposable subscription. Third-party token auth was a first-class mode, so an existing identity provider could be reused without extra infrastructure. The type declarations were accurate and were the fastest route to ground truth.
- What got in the way
- The published client docs I retrieved described an API that did not match the shipped code, which is worse than no docs. Locating the relevant declarations took several passes because the events API lives in a sub-package rather than the top-level entry point. The dependency is heavy for a single channel subscription. Channel path formatting also differs from the service's HTTP publish contract, with a leading separator required in one and rejected in the other.