Skip to content

Simply save/load json files to/from file system in electron applications

License

Notifications You must be signed in to change notification settings

Cocycles/electron-storage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

electron-storage

simple storage managing module for electron

Electron saves data in app.getPath("userData") folder, which is different in every os. electron-storage gives simple methods to get and set json files to this directory.

  • Creates subdirectories if needed - that means you can write movies/StarWars.json as path, a movies folder will be created and a StarWars.json file inside.
  • Supports callbacks and promises.
  • The data inserted can be a javascript object, or stringified json.
  • You don't have to write .json in the end of a file path, it will add it for you.

NPM [Package Quality](http://packagequality.com/#?package=electron- storage)

npm version license issues forks stars twitter

Installation

$ npm install --save electron-storage

usage

const storage = require('electron-storage');

API

get

get a json file from storage.

storage.get(filePath, cb)

storage.get(filePath, (err, data) => {
  if (err) {
    console.error(err)
  } else {
    console.log(data);
  }
});

storage.get(filePath)

storage.get(filePath)
.then(data => {
  console.log(data);
})
.catch(err => {
  console.error(err);
});

set

set a json file to storage.

storage.set(filePath, data, cb)