https://github.com/electron-utils/electron-profile

Store and manipulate your profile for your Electron app.
https://github.com/electron-utils/electron-profile

electron profile

Last synced: 2 months ago
JSON representation

Store and manipulate your profile for your Electron app.

• Host: GitHub
• URL: https://github.com/electron-utils/electron-profile
• Owner: electron-utils
• License: mit
• Created: 2017-02-16T11:21:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-26T02:54:10.000Z (about 7 years ago)
• Last Synced: 2025-03-14T20:49:00.827Z (2 months ago)
• Topics: electron, profile
• Language: JavaScript
• Size: 34.2 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# electron-profile

[![Linux Build Status](https://travis-ci.org/electron-utils/electron-profile.svg?branch=master)](https://travis-ci.org/electron-utils/electron-profile)

[![Windows Build status](https://ci.appveyor.com/api/projects/status/xs18f8goees9w9bb?svg=true)](https://ci.appveyor.com/project/jwu/electron-profile)

[![Dependency Status](https://david-dm.org/electron-utils/electron-profile.svg)](https://david-dm.org/electron-utils/electron-profile)

[![devDependency Status](https://david-dm.org/electron-utils/electron-profile/dev-status.svg)](https://david-dm.org/electron-utils/electron-profile#info=devDependencies)

Store and manipulate your profile for your Electron app.

## Why?

  - Profile migration/update

  - Sync profile changes in runtime for all renderer processes.

## Install

```bash

npm install --save electron-profile

```

## Run Examples:

```bash

npm start examples/${name}

```

## Usage

```javascript

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

let settings = profile.load('profile://local/settings.json');

settings.set('user.name', 'Johnny Wu');

console.log(settings.get('user.name')); // Johnny Wu

settings.save();

```

## API Reference

  - [Module: profile (main process)](docs/profile-main.md)

  - [Module: profile (renderer process)](docs/profile-renderer.md)

## License

MIT © 2017 Johnny Wu