Skip to content

docs: clarify ResponseStreamEvent JSDoc comment#1786

Open
FelmonFekadu wants to merge 1 commit intoopenai:masterfrom
FelmonFekadu:fix-response-stream-event-doc-comment
Open

docs: clarify ResponseStreamEvent JSDoc comment#1786
FelmonFekadu wants to merge 1 commit intoopenai:masterfrom
FelmonFekadu:fix-response-stream-event-doc-comment

Conversation

@FelmonFekadu
Copy link

Summary

  • replace the incorrect audio-specific JSDoc on ResponseStreamEvent
  • describe ResponseStreamEvent as the union of events emitted by the Responses streaming interface

Fixes #1699

Validation

  • yarn build
  • ./node_modules/.bin/eslint src/resources/responses/responses.ts
  • ./node_modules/.bin/prettier --check src/resources/responses/responses.ts

Notes

  • yarn lint currently fails in this checkout for unrelated existing issues: one warning in generated dist/ and missing optional example dependencies such as express, next, and @azure/identity.

@FelmonFekadu FelmonFekadu requested a review from a team as a code owner March 22, 2026 18:51
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.

Incorrect documentation ("Emitted when there is a partial audio response") for ResponseStreamEvent

1 participant