Docs for RealtimeChannelOptions inconsistent with implementation
mkcode opened this issue · comments
Bug report
The documentation on this repo is inconsistent the Types and implementation for RealtimeChannelOptions.
The docs indicate that no config
keyword is needed for the channel
method:
Line 117 in 63242ff
The type defs and implementation disagree:
realtime-js/src/RealtimeChannel.ts
Lines 13 to 14 in 63242ff
and
realtime-js/src/RealtimeChannel.ts
Lines 132 to 138 in 63242ff
Not sure if the docs should be updated or the code. Let me know and I can submit a PR!
@mkcode thanks for pointing this out! it was indeed an issue with the readme so i updated it.