Skip to content
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

fix(types): declare ReadableStream type without requiring dom #3889

Merged
merged 1 commit into from
Aug 30, 2022
Merged

fix(types): declare ReadableStream type without requiring dom #3889

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
13 changes: 13 additions & 0 deletions packages/types/src/serde.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,19 @@ export interface ResponseDeserializer<OutputType, ResponseType = any, Context =
(output: ResponseType, context: Context): Promise<OutputType>;
}

/**
* Declare ReadableStream in case dom.d.ts is not added to the tsconfig lib causing
* ReadableStream interface is not defined. For developers with dom.d.ts added,
* the ReadableStream interface will be merged correctly.
*
* This is also required for any clients with streaming interface where ReadableStream
* type is also referred. The type is only declared here once since this @aws-sdk/types
* is depended by all @aws-sdk packages.
*/
declare global {
export interface ReadableStream {}
}

/**
* The interface contains mix-in utility functions to transfer the runtime-specific
* stream implementation to specified format. Each stream can ONLY be transformed
Expand Down