Skip to content

Commit 4ad14ae

Browse files
committed
Re-add JSDoc.
1 parent 2772a78 commit 4ad14ae

File tree

5 files changed

+480
-194
lines changed

5 files changed

+480
-194
lines changed

Alert.d.ts

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ declare module 'electron-alert' {
7878
* })
7979
* );
8080
*/
81-
function uncaughtException(hideTrace?: boolean, closure?: function, alwaysOnTop?: boolean): Promise<SweetAlertResult>
81+
function uncaughtException(hideTrace?: boolean, closure?: function, alwaysOnTop?: boolean): void
8282

8383
/**
8484
* An enum of possible reasons that can explain an alert dismissal.
@@ -162,7 +162,7 @@ declare module 'electron-alert' {
162162
function enableInput(): void;
163163

164164
/**
165-
* If `timer` parameter is set, returns number of milliseconds of timer remained.
165+
* If `timer` property is set/defined, returns number of milliseconds of timer remained.
166166
* Otherwise, returns undefined.
167167
*/
168168
function getTimerLeft(): Promise<number | undefined>;
@@ -328,24 +328,6 @@ declare module 'electron-alert' {
328328
*/
329329
footer?: string | HTMLElement | JQuery;
330330

331-
/**
332-
* The type of the modal.
333-
* SweetAlert2 comes with 5 built-in types which will show a corresponding icon animation: 'warning', 'error',
334-
* 'success', 'info' and 'question'.
335-
* It can either be put in the array under the key "type" or passed as the third parameter of the function.
336-
*
337-
* @default null
338-
*/
339-
type?: SweetAlertType;
340-
341-
/**
342-
* Whether or not SweetAlert2 should show a full screen click-to-dismiss backdrop.
343-
* Either a boolean value or a css background value (hex, rgb, rgba, url, etc.)
344-
*
345-
* @default true
346-
*/
347-
backdrop?: boolean | string;
348-
349331
/**
350332
* Whether or not an alert should be treated as a toast notification.
351333
* This option is normally coupled with the `position` parameter and a timer.
@@ -470,15 +452,6 @@ declare module 'electron-alert' {
470452
*/
471453
heightAuto?: boolean;
472454

473-
/**
474-
* If set to false, the user can't dismiss the modal by clicking outside it.
475-
* You can also pass a custom function returning a boolean value, e.g. if you want
476-
* to disable outside clicks for the loading state of a modal.
477-
*
478-
* @default true
479-
*/
480-
allowOutsideClick?: ValueOrThunk<boolean>;
481-
482455
/**
483456
* If set to false, the user can't dismiss the modal by pressing the Escape key.
484457
* You can also pass a custom function returning a boolean value, e.g. if you want

0 commit comments

Comments
 (0)