Skip to content

docs(saa-js): document turnReady event payload field types (#22)#43

Open
MunawarJohar wants to merge 1 commit into
attenlabs:mainfrom
MunawarJohar:patch-1
Open

docs(saa-js): document turnReady event payload field types (#22)#43
MunawarJohar wants to merge 1 commit into
attenlabs:mainfrom
MunawarJohar:patch-1

Conversation

@MunawarJohar

Copy link
Copy Markdown

Closes #22

Problem

The README listed the turnReady payload shape ({ audioBase64, audioPcm16, durationSec, frames, context }) with no types or
descriptions, and was missing the serverTurnReadyTsMs field entirely.
Consumers had to read the SDK source to know field types.

Fix

  • Added serverTurnReadyTsMs to the Events table payload summary.
  • Added a turnReady fields table directly below the Events table,
    documenting type and description for every field, verified against
    the emit("turnReady", ...) call site in client.ts's
    handleServerMessage().

Documentation only — no code changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[saa-js] turnReady event payload fields are not typed in the README

1 participant