UserDataStore

Easily store user data and back up them.

Features:

• Set Item
• Get Item
• Export user data as json
• Import json
• Back up
• Restore

Usage

yarn add git+https://github.com/srymh/user-data-store

Select Store library and its driver. By default, supports localForage and electron-store@5.2.0.

1. Store Your Data by Using localForage

You need install localforage manually.

yarn add localforage

import { UserDataStore } from "user-data-store";
// This driver supports only IndexedDB.
import {
  LocalForageDriver,
  LocalForageDriverOptions,
} from "user-data-store/dist-esm/drivers/LocalForageDriver";
// Just for intellisense of `LocalForageDriverOptions`
import 'localforage';

// Example
type Student = {
  name: string;
};

const userDataStore = new UserDataStore<Student, LocalForageDriverOptions>({
  driver: LocalForageDriver,
  // Intellisense is available if `import 'localforage'` is declared.
  driverOptions: {
    description: "sample text",
  },
  name: "School", // IndexedDB: Database name
  storeName: "Student", // IndexedDB: Table name
  provideKey: (x) => x.name
});

const student: Student = {
  name: "Tanaka Taro"
};

userDataStore.setItem(student);

// A database is created with the name "School"
// A table is created with the name "Student" in the School database.

2. Store Your Data by Using electron-store

You need install electron-store(version 5.2.0) manually.

yarn add electron-store@5.2.0

import { UserDataStore } from "user-data-store";
import {
  ElectronStoreDriver,
  ElectronStoreDriverOptions,
} from "user-data-store/dist-cjs/drivers/ElectronStoreDriver";

// Example
type Student = {
  name: string;
};

const userDataStore = new UserDataStore<
  Student,
  ElectronStoreDriverOptions<Student>
>({
  driver: ElectronStoreDriver,
  driverOptions: {
    // fileExtension: "txt", // A json file named "School_Student.txt" is saved.
  },
  name: "School",
  storeName: "Student",
  provideKey: (x) => x.name
});

const student: Student = {
  name: "Tanaka Taro"
};

userDataStore.setItem(student);

// A json file named "School_Student.json" is saved.

import { ElectronStoreDriver } from "user-data-store/dist-esm/drivers/ElectronStoreDriver";
causes "SyntaxError: Cannot use import statement outside a module"

3. Custom Store Driver

Custom driver class should implements StoreDriver.