foundation-util-messenger

An utility to store messages in the session storage that will be prompted in the subsequence page load.

AdaptTo Interface

type

foundation-util-messenger

condition

window object

returned type

FoundationUtilMessenger

interface FoundationUtilMessenger {
  /**
   * Stores a message in the session storage to be shown in the subsequence page load.
   *
   * @param title The title of the notification. By default the value is autogenerated based on type.
   * @param message The message to be displayed
   * @param type The type of notification. Valid values are "error", "notice", "success", "help", "info".
   */
  put: (title?: string, message: string, type = "info") => void;

  /**
   * Prompts all the stored messages.
   * The stored messaged would be then cleared and will not be shown in the subsequence page load.
   */
  promptAll: () => void;
}