🤖 Merge PR DefinitelyTyped#57641 [superagent] remove dom typings by @…

…alecgibson * [superagent] remove `dom` typings At the moment, the `@types/superagent` library silently includes `dom` typings, even in Node-only projects. This is *very* surprising. This change sets the problematic `Response.xhr` property to `any`. The `xhr` property is for [browser-only use][1], so it doesn't really make sense for this browser-only property to exist on `Response`, which currently [extends a `NodeJS.ReadableStream`][2], where you would never expect access to DOM types. [1]: https://github.com/visionmedia/superagent/blob/048cf185d954028b1dccde0717d2488b2284c297/src/client.js#L88 [2]: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/59b04cbc8e5570ca2b8717e1cb054cfbbea01e01/types/superagent/index.d.ts#L103 * Apply suggestions from code review Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com> Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
martin-badin · Feb 23, 2022 · 72763e5 · 72763e5
1 parent a2ee9a6
commit 72763e5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 7 deletions.
diff --git a/types/superagent/index.d.ts b/types/superagent/index.d.ts
@@ -15,7 +15,6 @@
 // TypeScript Version: 3.0
 
 /// <reference types="node" />
-/// <reference lib="dom" />
 
 import * as fs from "fs";
 import * as http from "http";
@@ -127,7 +126,7 @@ declare namespace request {
         text: string;
         type: string;
         unauthorized: boolean;
-        xhr: XMLHttpRequest;
+        xhr: any;
         redirects: string[];
     }
 

diff --git a/types/superagent/superagent-tests.ts b/types/superagent/superagent-tests.ts
@@ -219,7 +219,7 @@ request.get("http://example.com/search").retry(2, callback).end(callback);
 })();
 
 // Attaching files
-const blob: Blob = new File([], "thor.png");
+declare const blob: Blob;
 request
     .post("/upload")
     .attach("avatar", "path/to/tobi.png", "user.png")
@@ -282,8 +282,8 @@ request
     .get("/blob")
     .responseType("blob")
     .end((err, res) => {
-        assert(res.xhr instanceof XMLHttpRequest);
-        assert(res.xhr.response instanceof Blob);
+        res.xhr; // $ExpectType any
+        res.xhr.response; // $ExpectType any
     });
 
 // HTTPS request, from: https://github.com/visionmedia/superagent/commit/6158efbf42cb93d77c1a70887284be783dd7dabe

diff --git a/types/superagent/tsconfig.json b/types/superagent/tsconfig.json
@@ -2,8 +2,7 @@
     "compilerOptions": {
         "module": "commonjs",
         "lib": [
-            "es6",
-            "dom"
+            "es6"
         ],
         "noImplicitAny": true,
         "noImplicitThis": true,