chore: add module doc for Promise.withResolvers polyfill

redabacha · Apr 3, 2024 · 5a583b2 · 5a583b2
1 parent dfc6b0f
commit 5a583b2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/promise-with-resolvers-polyfill.ts b/promise-with-resolvers-polyfill.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * A polyfill for Promise.withResolvers. To use, import at the entrypoint of your application.
+ */
+
 if (!Promise["withResolvers"]) {
   Promise["withResolvers"] = function withResolvers<T>() {
     let promiseResolve: PromiseWithResolvers<T>["resolve"];