electronade-filestore-util

It's a package that provides some utilities for electronade-filestore.

It's an optional module for electronade-filestore so electronade-filestore should be installed before using electronade-filestore-util.

installation

npm install electronade-filestore-util
content_copy

interfaces

classDiagram

class FileStore {
  +constructor(filePath: string, exposedName?: string)
  +get(id: string) Promise~any~
  +getIds() Promise~stringArray~
  +save(item: object) Promise~any~
  +remove(id: string) Promise~undefined~
}

usage

import and use FileStore class in Renderer process.

import { FileStore } from "electronade-filestore-util";

const filePath = "path/to/store/file";
const fileStore = new FileStore(filePath);

const savedItem = await fileStore
  .save({ some: "thing" });

console.log(savedItem.some); // thing

console.log(
  await fileStore
    .get(savedItem._id)
    .then(({ some }) => some)
); // thing

console.log(
  await fileStore.getIds()
); // [ ...savedItem._id ]

console.log(
  await fileStore.remove(savedItem._id)
); // undefined
content_copy