localStorage

// No import needed - available globally
localStorage.setItem("key", value);

Your favorite browser API in a modern version. localStorage provides persistent key-value storage that survives script reloads and restarts. Each script has its own isolated storage - scripts cannot access each other’s data. Unlike the browser version, values are serialized using the structured clone algorithm (same as IndexedDB), so any JS type is supported - not just strings.

Supported value types: objects, arrays, numbers, strings, booleans, null, Date, RegExp, Map, Set, ArrayBuffer, TypedArray. No more JSON.stringify / JSON.parse wrappers - just store and retrieve.

Overview

Methods

setItem, getItem, removeItem, clear, key, length.

Property access

Read and write values using direct property syntax.

Methods

localStorage.setItem

localStorage.setItem(key: string, value: any): void

Stores a value under the given key. The value can be any type supported by the structured clone algorithm.

string

required

The key to store the value under.

any

required

The value to store. Any serializable type.

localStorage.setItem("name", "Player1");
localStorage.setItem("score", 42);
localStorage.setItem("settings", { fov: 90, crosshair: true });
localStorage.setItem("teammates", new Set(["Alice", "Bob"]));

localStorage.getItem

localStorage.getItem(key: string): any | null

Retrieves a value by key. Returns null if the key doesn’t exist.

const name = localStorage.getItem("name");         // "Player1"
const score = localStorage.getItem("score");        // 42
const settings = localStorage.getItem("settings");  // { fov: 90, crosshair: true }

const missing = localStorage.getItem("nope");       // null

localStorage.removeItem

localStorage.removeItem(key: string): void

Removes a key and its value from storage.

localStorage.removeItem("name");
localStorage.getItem("name"); // null

localStorage.clear

localStorage.clear(): void

Removes all keys for this script. Other scripts’ storage is not affected.

localStorage.clear();
console.log(localStorage.length); // 0

localStorage.key

localStorage.key(index: number): string | null

Returns the key name at the given index. Returns null if out of bounds.

number

required

Zero-based index into the key list.

localStorage.setItem("a", 1);
localStorage.setItem("b", 2);

localStorage.key(0); // "a"
localStorage.key(1); // "b"
localStorage.key(2); // null

key() and length scan storage internally - avoid calling them in hot loops or inside on("render", ...).

localStorage.length

localStorage.length: number  // read-only

Returns the number of stored keys.

console.log(`${localStorage.length} keys in storage`);

Property access

You can also use direct property syntax via a Proxy - reads, writes, and deletes all work as expected.

// Write
localStorage.config = { fov: 90, sens: 2.5 };

// Read
console.log(localStorage.config); // { fov: 90, sens: 2.5 }

// Delete
delete localStorage.config;

// Iterate
for (const key in localStorage) {
    console.log(key, localStorage[key]);
}

Built-in property names (setItem, getItem, removeItem, clear, key, length) cannot be used as storage keys via property syntax. Use setItem / getItem for these names:

// Won't work - "length" is a built-in
localStorage.length = 42;

// Use methods instead
localStorage.setItem("length", 42);
localStorage.getItem("length"); // 42

Recipes

Persistent settings

// Load saved settings or use defaults
const defaults = { fov: 90, crosshair: true, sensitivity: 2.0 };
const settings = localStorage.getItem("settings") ?? defaults;

function updateSetting(key, value) {
    settings[key] = value;
    localStorage.setItem("settings", settings);
}

updateSetting("fov", 110);

Kill counter across reloads

const stats = localStorage.getItem("stats") ?? { kills: 0, deaths: 0 };

function onKill() {
    stats.kills++;
    localStorage.setItem("stats", stats);
}

console.log(`K/D: ${(stats.kills / (stats.deaths || 1)).toFixed(2)}`);

Per-player notes

function setNote(steamId, note) {
    const notes = localStorage.getItem("notes") ?? {};
    notes[steamId] = note;
    localStorage.setItem("notes", notes);
}

function getNote(steamId) {
    const notes = localStorage.getItem("notes") ?? {};
    return notes[steamId] ?? null;
}

setNote("76561199517768849", "suspicious movement");

Overview

Modules

Types

Overview

Methods

Property access

Methods

localStorage.setItem

localStorage.getItem

localStorage.removeItem

localStorage.clear

localStorage.key

localStorage.length

Property access

Recipes

Persistent settings

Kill counter across reloads

Per-player notes

​Overview

Methods

Property access

​Methods

​localStorage.setItem

​localStorage.getItem

​localStorage.removeItem

​localStorage.clear

​localStorage.key

​localStorage.length

​Property access

​Recipes

​Persistent settings

​Kill counter across reloads

​Per-player notes

Overview

Methods

localStorage.setItem

localStorage.getItem

localStorage.removeItem

localStorage.clear

localStorage.key

localStorage.length

Property access

Recipes

Persistent settings

Kill counter across reloads

Per-player notes