UNPKG

1.49 kBJavaScriptView Raw
1"use strict";
2Object.defineProperty(exports, "__esModule", { value: true });
3exports.LifecycleHook = exports.MessageType = exports.PermissionType = void 0;
4/**
5 * @internal
6 */
7var PermissionType;
8(function (PermissionType) {
9 PermissionType["Dispatch"] = "Dispatch";
10 PermissionType["Subscribe"] = "Subscribe";
11})(PermissionType = exports.PermissionType || (exports.PermissionType = {}));
12/**
13 * @internal
14 */
15var MessageType;
16(function (MessageType) {
17 MessageType["GetState"] = "getState";
18 MessageType["Dispatch"] = "dispatch";
19 MessageType["Subscribe"] = "subscribe";
20 MessageType["Unsubscribe"] = "unsubscribe";
21})(MessageType = exports.MessageType || (exports.MessageType = {}));
22/**
23 *
24 * There are two types of hooks: `LifecycleHook.DispatchAction` and `LifecycleHook.UpdateAction`.
25 *
26 * @remarks
27 * `DispatchAction` hooks are run when an action is dispatched with the `.dispatch()` function:
28 *
29 * ```js
30 * const toastNotice = Toast.create(app, {message: 'Product saved'});
31 * toastNotice.dispatch(Toast.Action.SHOW);
32 * ```
33 *
34 * `UpdateAction` hooks are run when an action is updated, using the `.set()` function:
35 *
36 * ```js
37 * toastNotice.set({message: 'Product could not be saved', isError: true});
38 * ```
39 *
40 * @public
41 */
42var LifecycleHook;
43(function (LifecycleHook) {
44 LifecycleHook["UpdateAction"] = "UpdateAction";
45 LifecycleHook["DispatchAction"] = "DispatchAction";
46})(LifecycleHook = exports.LifecycleHook || (exports.LifecycleHook = {}));