Function init

Creates, initializes, and returns a SettingsManager for the given settings namespace. If a manager for the namespace already exists, then that instance will be returned. Use this function rather than creating instances of SettingsManager directly.

Settings are stored synchronously in the window, and updates are dispatched asynchronously to the file system. See SettingsManager for more information on how this works.

Here's an example of how to use this in a plugin:

import { settings } from "replugged";

const defaultSettings = {
  hello: "world",
};

const cfg = await settings.init<{ hello: string; something: string }, "something">(
  "dev.replugged.Example",
  { something: "everything" },
);

export function start() {
  cfg.set("hello", "world");
  console.log(cfg.get("hello")); // world

  cfg.get("hello", "world"); // "world" will be used if there is no value for hello
  cfg.get("something"); // "everything" will be used if there is no value for something
}

Copy