Type Alias: Options

type Options = object;

Options types contain all the configuration options for Options that can be set in the constructor of KeyValues Class

Example

const kvs = new KeyValues({fileName: 'config.json'})

Properties

atomicSave

atomicSave: boolean;

Whether or not to save the settings file atomically.

Default

true

---

dir?

optional dir: string;

The path to the settings directory. Defaults to your app's user data direcory.

Default

"localdb"

---

fileName

fileName: string;

The name of the settings file that will be saved to the disk.

Default

"keyvalues.json"

---

numSpaces

numSpaces: number;

The number of spaces to use when stringifying the data before saving to disk if prettify is set to true.

Default

2

---

prettify

prettify: boolean;

Whether or not to prettify the data when it's saved to disk.

Default

false