Merge pull request #5652 from Polymer/setAttribute-closure-types

Update Closure types for overridden setAttribute in LegacyElementMixin.
Polymer · Apr 28, 2020 · 39d5a95 · 39d5a95
2 parents 05878b6 + 604856b
commit 39d5a95
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/gen-tsd.json b/gen-tsd.json
@@ -8,7 +8,8 @@
     "index.html"
   ],
   "excludeIdentifiers": [
-    "templatizedBase"
+    "templatizedBase",
+    "setAttribute"
   ],
   "removeReferences": [
     "../shadycss/apply-shim.d.ts",

diff --git a/lib/legacy/legacy-element-mixin.js b/lib/legacy/legacy-element-mixin.js
@@ -145,9 +145,15 @@ export const LegacyElementMixin = dedupingMixin((base) => {
 
     /**
      * Sets the value of an attribute.
+     *
+     * NOTE: This function is explicitly excluded when running
+     * gen-typescript-declarations because the function it overrides has
+     * different signatures in Closure and TypeScript's built-in types. This
+     * function's signature should match the signature from Closure:
+     * https://github.com/google/closure-compiler/blob/8972fd4e9b0689e7ebdeea53580521c819f6aecc/externs/browser/w3c_dom1.js#L686-L694
      * @override
      * @param {string} name The name of the attribute to change.
-     * @param {string} value The new attribute value.
+     * @param {string|number|boolean|!TrustedHTML|!TrustedScriptURL|!TrustedURL} value The new attribute value.
      */
     setAttribute(name, value) {
       if (legacyNoObservedAttributes && !this._legacyForceObservedAttributes) {