Cannot find name 'ReadableStream'.

Describe the bug

Cannot find name 'ReadableStream'.

Your environment

SDK version number

@aws-sdk/client-s3@3.42.0

Is the issue in the browser/Node.js/ReactNative?

Node.js

Details of the browser/Node.js/ReactNative version

node -v
v16.13.0

Steps to reproduce

import {S3} from "@aws-sdk/client-s3";

(async () => {
	const s3Client = new S3({});
	const data = (await s3Client.getObject({
		"Bucket": "mybucket",
		"Key": "data.txt"
	}));

	console.log(data.Body);
})();

Observed behavior

node_modules/@aws-sdk/client-s3/dist-types/models/models_0.d.ts:6050:23 - error TS2304: Cannot find name 'ReadableStream'.

6050     Body?: Readable | ReadableStream | Blob;
                           ~~~~~~~~~~~~~~

node_modules/@aws-sdk/client-s3/dist-types/models/models_0.d.ts:6697:23 - error TS2304: Cannot find name 'ReadableStream'.

6697     Body?: Readable | ReadableStream | Blob;
                           ~~~~~~~~~~~~~~

node_modules/@aws-sdk/client-s3/dist-types/models/models_0.d.ts:9081:23 - error TS2304: Cannot find name 'ReadableStream'.

9081     Body?: Readable | ReadableStream | Blob;
                           ~~~~~~~~~~~~~~

node_modules/@aws-sdk/client-s3/dist-types/models/models_1.d.ts:837:23 - error TS2304: Cannot find name 'ReadableStream'.

837     Body?: Readable | ReadableStream | Blob;
                          ~~~~~~~~~~~~~~

node_modules/@aws-sdk/client-s3/dist-types/models/models_1.d.ts:1116:23 - error TS2304: Cannot find name 'ReadableStream'.

1116     Body?: Readable | ReadableStream | Blob;
                           ~~~~~~~~~~~~~~

Expected behavior

No TypeScript errors

Screenshots

Additional context

Also, when running this code, it doesn’t print the contents, but instead a large object that looks like a response object. It should print the contents of the file.

[hteek]

Adding "dom" to the libs section of your tsconfig.json is not a solution. If you are writing constructs with aws jsii the tsconfig.jsonis generated and not editable. This dependency makes it unusable in non-browser environments in my opinion.

[barryhagan]

The other option is to use declaration merging to stub out the missing interface that aws-sdk assumes is available. Add this where you are exporting code that uses the SDK:

declare global {
     interface ReadableStream {}
 }

That should allow you to compile without hauling in the entire DOM lib.