electron-storage

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

Showing:

Popularity

Downloads/wk

76

GitHub Stars

122

Maintenance

Last Commit

5yrs ago

Contributors

3

Package

Dependencies

2

Size (min+gzip)

12.4KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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)

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

storage.set(filePath, data)

storage.set(filePath, data)
.then(() => {
  console.log('The file was successfully written to the storage');
})
.catch(err => {
  console.error(err);
});

isPathExists

check if a file or directory exists.

// you have to write .json suffix for json files.
// this method works on directories as well, if you don't write `.json` suffix it checks for a directory.

storage.isPathExists(path, cb)

storage.isPathExists(path, (itDoes) => {
  if (itDoes) {
    console.log('pathDoesExists !')
  }
});

storage.isPathExists(path)

storage.isPathExists(path)
.then(itDoes => {
  if (itDoes) {
    console.log('pathDoesExists !')
  }
});

remove

remove a file or a directory from storage

storage.remove(path, cb)

storage.remove(path, err => {
  if (err) {
    console.log(err)
  }
});

storage.remove(path)

storage.remove(path)
.then(err => {
  if (err) {
    console.log(err)
  }
});

Development

npm run build for creating es5 files in dist folder

Contribute

Contributions are welcome! please open issues and pull request :)

License

The MIT License (MIT) Copyright (c)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial