ably-js icon indicating copy to clipboard operation
ably-js copied to clipboard

TypeScript types have `Channel#publish(…options?: PublishOptions)` options on Realtime instead of REST

Open lawrence-forooghian opened this issue 1 year ago • 0 comments

As described by RSL1l:

The publish(Message) and publish(Message[]) forms of the method should take an extra Dict<String, Stringifiable> argument. These parameters should be encoded using normal querystring-encoding and sent as part of the query string of the REST publish. (Stringifiable is defined in RTC1f)

  • i.e. the REST publish methods should accept an additional dictionary parameter. But in ably.d.ts it is the realtime ones that accept the parameter.

This is inconsistent with the IDL and is in fact inconsistent with the actual implementation of the publish methods:

We need to switch this around in the signatures (might need to coincide with a major release of the SDK as it's technically a breaking change, albeit to a broken behaviour).

┆Issue is synchronized with this Jira Bug by Unito

lawrence-forooghian avatar Jul 26 '22 20:07 lawrence-forooghian