🤖 Merge PR DefinitelyTyped#47212 [ember-data] Adapter headers should …

…be overwriteable with a getter by @wagenet Instead of being declared as a property we now declare it in an interface. This works around the issue noted here with TypeScript 4: microsoft/TypeScript#40220
danielrearden · Sep 22, 2020 · 5e149f0 · 5e149f0
1 parent 874eedc
commit 5e149f0
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 8 deletions.
diff --git a/types/ember-data/index.d.ts b/types/ember-data/index.d.ts
@@ -1258,14 +1258,6 @@ export namespace DS {
          * An adapter can target other hosts by setting the `host` property.
          */
         host: string;
-        /**
-         * Some APIs require HTTP headers, e.g. to provide an API
-         * key. Arbitrary headers can be set as key/value pairs on the
-         * `RESTAdapter`'s `headers` object and Ember Data will send them
-         * along with each ajax request. For dynamic headers see [headers
-         * customization](/api/data/classes/DS.RESTAdapter.html#toc_headers-customization).
-         */
-        headers: {};
         /**
          * Called by the store in order to fetch the JSON for a given
          * type and ID.
@@ -1496,6 +1488,20 @@ export namespace DS {
          */
         pathForType<K extends keyof ModelRegistry>(modelName: K): string;
     }
+
+    // Instead of declaring `headers as a property we now declare it in an
+    // interface. This works around the issue noted here with TypeScript 4:
+    // https://github.com/microsoft/TypeScript/issues/40220
+    interface RESTAdapter {
+        /**
+         * Some APIs require HTTP headers, e.g. to provide an API
+         * key. Arbitrary headers can be set as key/value pairs on the
+         * `RESTAdapter`'s `headers` object and Ember Data will send them
+         * along with each ajax request. For dynamic headers see [headers
+         * customization](/api/data/classes/DS.RESTAdapter.html#toc_headers-customization).
+         */
+        headers: {};
+    }
     /**
      * ## Using Embedded Records
      */

diff --git a/types/ember-data/test/adapter.ts b/types/ember-data/test/adapter.ts
@@ -29,6 +29,15 @@ const AuthTokenHeader = DS.JSONAPIAdapter.extend({
     })
 });
 
+// Ensure that we are allowed to overwrite headers with a getter
+class GetterHeader extends DS.JSONAPIAdapter {
+    get headers() {
+        return {
+            'CUSTOM_HEADER': 'Some header value'
+        };
+    }
+}
+
 const UseAjax = DS.JSONAPIAdapter.extend({
     query(store: DS.Store, type: string, query: object) {
         const url = 'https://api.example.com/my-api';

diff --git a/types/ember-data/tsconfig.json b/types/ember-data/tsconfig.json
@@ -5,6 +5,7 @@
             "es6",
             "dom"
         ],
+        "target": "es5",
         "noImplicitAny": true,
         "noImplicitThis": true,
         "strictNullChecks": true,