Skip to content

fix(types): improve responses.create overload resolution with optional parameters #2039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
anishesg wants to merge 1 commit into from
+4 −1
Closed

fix(types): improve responses.create overload resolution with optional parameters #2039

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/resources/responses/responses.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,14 @@ export class Responses extends APIResource {
* const response = await client.responses.create();
* ```
*/
create(body: ResponseCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Response>;
create(
body: ResponseCreateParamsStreaming,
options?: RequestOptions,
): APIPromise<Stream<ResponseStreamEvent>>;
Comment on lines 98 to 101

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep default non-streaming overload before streaming

When the request body is any (for example, from JSON.parse() or an untyped helper), TypeScript resolves the call to the first compatible overload. Putting the streaming overload first makes client.responses.create(body) type as APIPromise<Stream<ResponseStreamEvent>> even when the runtime request omits stream and defaults to a normal Response, which can mislead callers into iterating a non-streaming response or cause new compile errors for code that previously saw the default non-streaming type.

Useful? React with 👍 / 👎.

@anishesg anishesg Jul 30, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah got it, makes sense - swapped the order so the non-streaming one comes first

create(
body: ResponseCreateParamsNonStreaming,
options?: RequestOptions,
): APIPromise<Response>;
create(
body: ResponseCreateParamsBase,
options?: RequestOptions,
Expand Down