Class PersistedStore<T>

Manages persistent storage of data with automatic serialization

Example: Storing Complex Data

interface Player {
    name: string;
    inventory: string[];
    health: number;
}

const playerData = new PersistedStore<Player>("player", {
    name: "Steve",
    inventory: [],
    health: 20
});

// Load saved data
playerData.load();

// Update and save
playerData.value.inventory.push("diamond");
playerData.save();

Type Parameters

  • T extends any

    Type of data being stored

Constructors

constructor

Properties

name value

Methods

load save

Constructors

constructor

  • new PersistedStore<T extends unknown>(
        name: string,
        defaultValue: T,
        serializer?: Serializer<any>,
    ): PersistedStore<T>

  • Type Parameters

    • T extends unknown

    Parameters

    • name: string
    • defaultValue: T
    • Optionalserializer: Serializer<any>

    Returns PersistedStore<T>

Properties

Readonlyname

name: string

Creates a new persistent store

Param: name

Filename to store data in (under /persisted/)

Param: defaultValue

Initial value if no data exists

Param: serializer

Optional custom serializer (defaults to textutils)

Throws

If file operations fail

value

value: T

Methods

load

  • load(): void

  • Loads saved value from disk If no saved data exists, keeps the default value

    Returns void

save

  • save(): void

  • Saves current value to disk

    Returns void

    Throws

    If file write fails

Settings

Member Visibility

On This Page

Constructors
Properties
Methods