UNPKG

1.4 kBTypeScriptView Raw
1/**
2 * Defines what MST should do when running into reads / writes to objects that have died.
3 * - `"warn"`: Print a warning (default).
4 * - `"error"`: Throw an exception.
5 * - "`ignore`": Do nothing.
6 */
7export declare type LivelinessMode = "warn" | "error" | "ignore";
8/**
9 * Defines what MST should do when running into reads / writes to objects that have died.
10 * By default it will print a warning.
11 * Use the `"error"` option to easy debugging to see where the error was thrown and when the offending read / write took place
12 *
13 * @param mode `"warn"`, `"error"` or `"ignore"`
14 */
15export declare function setLivelinessChecking(mode: LivelinessMode): void;
16/**
17 * Returns the current liveliness checking mode.
18 *
19 * @returns `"warn"`, `"error"` or `"ignore"`
20 */
21export declare function getLivelinessChecking(): LivelinessMode;
22/**
23 * @deprecated use LivelinessMode instead
24 * @hidden
25 */
26export declare type LivelynessMode = LivelinessMode;
27/**
28 * @deprecated use setLivelinessChecking instead
29 * @hidden
30 *
31 * Defines what MST should do when running into reads / writes to objects that have died.
32 * By default it will print a warning.
33 * Use the `"error"` option to easy debugging to see where the error was thrown and when the offending read / write took place
34 *
35 * @param mode `"warn"`, `"error"` or `"ignore"`
36 */
37export declare function setLivelynessChecking(mode: LivelinessMode): void;