Class JarvisStore

constructor

• new JarvisStore(filename?: string): JarvisStore

• filename is optional if you only need one store file. If you plan to have multiple stores, e.g. one for settings, one for data, you can specify different filenames.

  Parameters

  • filename: string = "default.bin"

    filename for the store. Defaults to default.bin.

  Returns JarvisStore

  Example

  const store = new JarvisStore("settings.bin");
  await store.set("theme", "dark");
  const theme = await store.get("theme");
  console.log(theme); // dark
  Copy

path

clear

• clear(): Promise<void>

• Clears the store, removing all key-value pairs.

  Note: To clear the storage and reset it to it's default value, use reset instead.

  Returns Promise<void>

delete

• delete(key: string): Promise<boolean>

• Removes a key-value pair from the store.

  Parameters

  • key: string

  Returns Promise<boolean>

entries

• entries<T>(): Promise<[key: string, value: T][]>

• Returns a list of all entries in the store.

  Type Parameters

  • T

  Returns Promise<[key: string, value: T][]>

get

• get<T>(key: string): Promise<null | T>

• Returns the value for the given key or null the key does not exist.

  Type Parameters

  • T

  Parameters

  • key: string

  Returns Promise<null | T>

has

• has(key: string): Promise<boolean>

• Returns true if the given key exists in the store.

  Parameters

  • key: string

  Returns Promise<boolean>

keys

• keys(): Promise<string[]>

• Returns a list of all key in the store.

  Returns Promise<string[]>

length

• length(): Promise<number>

• Returns the number of key-value pairs in the store.

  Returns Promise<number>

load

• load(): Promise<void>

• Attempts to load the on-disk state at the stores path into memory.

  This method is useful if the on-disk state was edited by the user and you want to synchronize the changes.

  Note: This method does not emit change events.

  Returns Promise<void>

onChange

• onChange<T>(cb: (key: string, value: null | T) => void): Promise<UnlistenFn>

• Listen to changes on the store.

  Type Parameters

  • T

  Parameters

  • cb: (key: string, value: null | T) => void

  Returns Promise<UnlistenFn>

  A promise resolving to a function to unlisten to the event.

onKeyChange

• onKeyChange<T>(key: string, cb: (value: null | T) => void): Promise<UnlistenFn>

• Listen to changes on a store key.

  Type Parameters

  • T

  Parameters

  • key: string
  • cb: (value: null | T) => void

  Returns Promise<UnlistenFn>

  A promise resolving to a function to unlisten to the event.

reset

• reset(): Promise<void>

• Resets the store to it's default value.

  If no default value has been set, this method behaves identical to clear.

  Returns Promise<void>

save

• save(): Promise<void>

• Saves the store to disk at the stores path.

  As the store is only persisted to disk before the apps exit, changes might be lost in a crash. This method lets you persist the store to disk whenever you deem necessary.

  Returns Promise<void>

set

• set(key: string, value: unknown): Promise<void>

• Inserts a key-value pair into the store.

  Parameters

  • key: string
  • value: unknown

  Returns Promise<void>

values

• values<T>(): Promise<T[]>

• Returns a list of all values in the store.

  Type Parameters

  • T

  Returns Promise<T[]>