fix: add types to fire.js (#2603)

sweetalert2 · Feb 28, 2023 · 86a4753 · 86a4753
1 parent e99984e
commit 86a4753
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/src/instanceMethods/close.js b/src/instanceMethods/close.js
@@ -136,7 +136,7 @@ export const handleAwaitingPromise = (instance) => {
 
 /**
  * @param {any} resolveValue
- * @returns {import('sweetalert2').SweetAlertResult}
+ * @returns {SweetAlertResult}
  */
 const prepareResolveValue = (resolveValue) => {
   // When user calls Swal.close()

diff --git a/src/staticMethods/fire.js b/src/staticMethods/fire.js
@@ -1,3 +1,9 @@
+/**
+ * Main method to create a new SweetAlert2 popup
+ *
+ * @param  {...SweetAlertOptions} args
+ * @returns {Promise<SweetAlertResult>}
+ */
 export function fire(...args) {
   const Swal = this // eslint-disable-line @typescript-eslint/no-this-alias
   return new Swal(...args)

diff --git a/src/types.js b/src/types.js
@@ -3,6 +3,7 @@
  * @typedef { import('sweetalert2').SweetAlertOptions } SweetAlertOptions
  * @typedef { import('sweetalert2').SweetAlertIcon } SweetAlertIcon
  * @typedef { import('sweetalert2').SweetAlertInput } SweetAlertInput
+ * @typedef { import('sweetalert2').SweetAlertResult } SweetAlertResult
  */
 
 /**