Skip to content

Re-add JSDoc. #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Re-add JSDoc. #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 2 additions & 29 deletions Alert.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ declare module 'electron-alert' {
* })
* );
*/
function uncaughtException(hideTrace?: boolean, closure?: function, alwaysOnTop?: boolean): Promise<SweetAlertResult>
function uncaughtException(hideTrace?: boolean, closure?: function, alwaysOnTop?: boolean): void

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

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

/**
* The type of the modal.
* SweetAlert2 comes with 5 built-in types which will show a corresponding icon animation: 'warning', 'error',
* 'success', 'info' and 'question'.
* It can either be put in the array under the key "type" or passed as the third parameter of the function.
*
* @default null
*/
type?: SweetAlertType;

/**
* Whether or not SweetAlert2 should show a full screen click-to-dismiss backdrop.
* Either a boolean value or a css background value (hex, rgb, rgba, url, etc.)
*
* @default true
*/
backdrop?: boolean | string;

/**
* Whether or not an alert should be treated as a toast notification.
* This option is normally coupled with the `position` parameter and a timer.
Expand Down Expand Up @@ -470,15 +452,6 @@ declare module 'electron-alert' {
*/
heightAuto?: boolean;

/**
* If set to false, the user can't dismiss the modal by clicking outside it.
* You can also pass a custom function returning a boolean value, e.g. if you want
* to disable outside clicks for the loading state of a modal.
*
* @default true
*/
allowOutsideClick?: ValueOrThunk<boolean>;

/**
* If set to false, the user can't dismiss the modal by pressing the Escape key.
* You can also pass a custom function returning a boolean value, e.g. if you want
Expand Down
Loading