Skip to content

Commit

Permalink
fix(types): declare ReadableStream type without requiring dom (#3889)
Browse files Browse the repository at this point in the history
  • Loading branch information
AllanZhengYP authored Aug 30, 2022
1 parent 574507f commit 061b5f5
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions packages/types/src/serde.ts
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

0 comments on commit 061b5f5

Please sign in to comment.