BUG: join return type is Promise<DailyParticipantsObject | void>

[kwshi]

Expected behavior

The Daily.co API docs state that callObj.join resolves with a participants (type DailyParticipantsObject). This appears to be consistent with the daily.js source code. That means that the return type of join should be

Promise<DailyParticipantsObject>

Describe the bug (unexpected behavior)

The actual type specified in index.d.ts is Promise<DailyParticipantsObject | void>, which doesn't make sense:

• First, the module.js source doesn't ever call resolve on any object other than participants, so DailyParticipantsObject should be the only response type; void is extraneous. So I believe this type is actually inconsistent with the actual behavior of the code.
• The documentation clearly states that join should return a participants object that is meant to be used for initializing some UI upon meeting join. void indicates the absence of a return value, i.e. nothing is supposed to be done with the return value. To return Promise<DailyParticipantsObject | void> means "when this function succeeds, it will either respond with a DailyParticipantsObject... or not, who knows?". That's not really consistent with either the behavior or the stated API design.
  • Aside: the failure case (promise rejection) should not be part of the Promise type parameter. If the join function fails, it does not _resolve with a void value, it _rejects_, i.e. throws an exception that needs to be caught. The Promise` type should only indicate the type returned by the success branch.