Installations
npm install electron-settingsDeveloper Guide
Typescript
Yes
Module System
CommonJS
Node Version
21.7.3
NPM Version
10.5.0
Score
56.3
Supply Chain
91
Quality
75.7
Maintenance
100
Vulnerability
98.9
License
Releases
Contributors
Unable to fetch Contributors
Languages
TypeScript (98.19%)
JavaScript (1.81%)
Developer
Download Statistics
Total Downloads
2,643,844
Last Day
233
Last Week
4,259
Last Month
22,745
Last Year
587,398
GitHub Statistics
819 Stars
265 Commits
60 Forks
10 Watching
21 Branches
6 Contributors
Bundle Size
84.70 kB
Minified
29.37 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
4.0.4
Package Id
electron-settings@4.0.4
Unpacked Size
48.73 kB
Size
12.15 kB
File Count
8
NPM Version
10.5.0
Node Version
21.7.3
Publised On
23 Apr 2024
Total Downloads
Cumulative downloads
Total Downloads
2,643,844
Last day
-47.9%
233
Compared to previous day
Last week
-9.6%
4,259
Compared to previous week
Last month
-34.3%
22,745
Compared to previous month
Last year
145.2%
587,398
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Peer Dependencies
1
Dev Dependencies
20
Electron Settings
A simple and robust settings management library for Electron.
Born from Atom's original internal configuration manager and the settings manager of choice for Electron's own API Demos app, Electron Settings allows you to persist user settings and other data between app loads simply and easily.
Install
npm install electron-settings
Demo
1import settings from 'electron-settings'; 2 3await settings.set('color', { 4 name: 'cerulean', 5 code: { 6 rgb: [0, 179, 230], 7 hex: '#003BE6' 8 } 9}); 10 11await settings.get('color.name'); 12// => "cerulean" 13 14await settings.get('color.code.rgb[1]'); 15// => 179
⚠ For Electron v10+, if you want to use electron-settings within a browser window, be sure to set the enableRemoteModule web preference to true. Otherwise you might get the error Cannot read property 'app' of undefined. See #133 for more info.
1new BrowserWindow({ 2 webPreferences: { 3 enableRemoteModule: true // <-- Add me 4 } 5});
API Docs
API docs and can be found at electron-settings.js.org.
Having trouble? Get help on Gitter.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 0/25 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v4.0.0 not signed: https://api.github.com/repos/nathanbuchar/electron-settings/releases/27305295
- Warn: release artifact v4.0.0 does not have provenance: https://api.github.com/repos/nathanbuchar/electron-settings/releases/27305295
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 10 are checked with a SAST tool
Reason
20 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-mpjm-v997-c4h4
- Warn: Project is vulnerable to: GHSA-3p22-ghq8-v749
- Warn: Project is vulnerable to: GHSA-77xc-hjv8-ww97
- Warn: Project is vulnerable to: GHSA-mq8j-3h7h-p8g7
- Warn: Project is vulnerable to: GHSA-p2jh-44qj-pf2v
- Warn: Project is vulnerable to: GHSA-p7v2-p9m8-qqg7
- Warn: Project is vulnerable to: GHSA-7x97-j373-85x5
- Warn: Project is vulnerable to: GHSA-7m48-wc93-9g85
- Warn: Project is vulnerable to: GHSA-qqvq-6xgj-jw8g
- Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Score
1.5
/10
Last Scanned on 2024-12-16
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to electron-settings
electron-store
Simple data persistence for your Electron app or module - Save and load user settings, app state, cache, etc
@types/electron-settings
Stub TypeScript definitions entry for electron-settings, which provides its own types definitions
electron-json-storage
Easily write and read user settings in Electron apps
electron-app-settings
Simple IPC-based settings framework for Electron