Interface StorageAPI

interface StorageAPI {
    SetString(key: string, value: string): void;
    GetString(key: string): null | string;
    SetObject(key: string, value: unknown): void;
    GetObject<T = unknown>(key: string): null | T;
}

Methods

SetString GetString SetObject GetObject

Methods

SetString

  • SetString(key: string, value: string): void

    Persists a string value under the given key. Data is scoped to the current script. Values are stored locally for fast access and synced to the server in the background.

    Parameters

    • key: string

      Storage key.

    • value: string

      String value to store.

    Returns void

    Example

    Storage.SetString("count", "42");
    Storage.SetString("lastRun", new Date().toISOString());

GetString

  • GetString(key: string): null | string

    Retrieves a previously stored string value.

    Parameters

    • key: string

      Storage key.

    Returns null | string

    The stored string, or null if the key does not exist.

    Remarks

    ALWAYS check for null. The return value is null when the key has never been set.

    Example

    const count = Storage.GetString("count");
    if (count !== null) {
    Console.Log("count: " + count);
    }

SetObject

  • SetObject(key: string, value: unknown): void

    Persists a JSON-serializable object under the given key.

    Parameters

    • key: string

      Storage key.

    • value: unknown

      Any JSON-serializable value (object, array, number, etc.).

    Returns void

    Example

    Storage.SetObject("prefs", { delay: 100, enabled: true });

GetObject

  • GetObject<T = unknown>(key: string): null | T

    Retrieves a previously stored object.

    Type Parameters

    • T = unknown

    Parameters

    • key: string

      Storage key.

    Returns null | T

    The deserialized object, or null if the key does not exist.

    Remarks

    ALWAYS check for null. The return value is null when the key has never been set. The returned value is a plain deserialized JS object; prototype methods are not preserved.

    Example

    const prefs = Storage.GetObject<{ delay: number; enabled: boolean }>("prefs");
    if (prefs !== null) {
    Console.Log("delay: " + prefs.delay);
    }

Settings

Member Visibility

On This Page

Methods