Skip to main content

Variable: notify

const notify: {
 error: (
  message: string,
  duration?: number | null,
  options?: NotificationOptions
 ) => Promise<void>;
 info: (
  message: string,
  duration?: number | null,
  options?: NotificationOptions
 ) => Promise<void>;
 persistent: (
  message: string,
  type: string,
  options: NotificationOptions
 ) => Promise<void>;
 success: (
  message: string,
  duration?: number | null,
  options?: NotificationOptions
 ) => Promise<void>;
 warning: (
  message: string,
  duration?: number | null,
  options?: NotificationOptions
 ) => Promise<void>;
 withActions: (
  message: string,
  type: string,
  actions: readonly NotificationAction[],
  options: NotificationOptions
 ) => Promise<void>;
};

Defined in: utils/ui/notifications/showNotification.ts:472

Convenience methods for common notification types

Type Declaration​

error​

error: (
 message: string,
 duration?: number | null,
 options?: NotificationOptions
) => Promise<void>;

Shows an error notification.

Parameters​

message​

string

duration?​

number | null

options?​

NotificationOptions

Returns​

Promise<void>

info​

info: (
 message: string,
 duration?: number | null,
 options?: NotificationOptions
) => Promise<void>;

Shows an info notification.

Parameters​

message​

string

duration?​

number | null

options?​

NotificationOptions

Returns​

Promise<void>

persistent​

persistent: (message: string, type: string, options: NotificationOptions) =>
 Promise<void>;

Shows a persistent notification that requires user interaction to dismiss.

Parameters​

message​

string

type?​

string = "info"

options?​

NotificationOptions = {}

Returns​

Promise<void>

success​

success: (
 message: string,
 duration?: number | null,
 options?: NotificationOptions
) => Promise<void>;

Shows a success notification.

Parameters​

message​

string

duration?​

number | null

options?​

NotificationOptions

Returns​

Promise<void>

warning​

warning: (
 message: string,
 duration?: number | null,
 options?: NotificationOptions
) => Promise<void>;

Shows a warning notification.

Parameters​

message​

string

duration?​

number | null

options?​

NotificationOptions

Returns​

Promise<void>

withActions​

withActions: (
 message: string,
 type: string,
 actions: readonly NotificationAction[],
 options: NotificationOptions
) => Promise<void>;

Shows a notification with action buttons.

Parameters​

message​

string

type?​

string = "info"

actions?​

readonly NotificationAction[] = []

options?​

NotificationOptions = {}

Returns​

Promise<void>