npmpackage.info

electron-settings

📝 A simple persistent user settings framework for Electron.

4.0.4

819

MIT

TypeScript

29.37 kB

2,643,844 1.5

Installations

npm install electron-settings

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

21.7.3

NPM Version

10.5.0 Score

56.3

Supply Chain

Quality

75.7

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

18

Total

91

Closed

24

Merged

49

Issues

Open

9

Total

90

Closed

81

Releases

v4.0.4

Published on 23 Apr 2024

v4.0.3

Published on 23 Apr 2024

v4.0.2

Published on 27 Jun 2020

v4.0.1

Published on 20 Jun 2020

v4.0.0

Published on 07 Jun 2020

View all 5 releases

Contributors

Unable to fetch Contributors

View all 6 contributors

Languages

TypeScript

JavaScript

TypeScript (98.19%)

JavaScript (1.81%)

Developer

nathanbuchar

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

Bundlephobia

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

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

Versions

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.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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 More

Other packages similar to electron-settings

electron-store

10.0.0

Simple data persistence for your Electron app or module - Save and load user settings, app state, cache, etc

@types/electron-settings

4.0.2

Stub TypeScript definitions entry for electron-settings, which provides its own types definitions

electron-json-storage

4.6.0

Easily write and read user settings in Electron apps

electron-app-settings

1.3.1

Simple IPC-based settings framework for Electron

electron-settings

Installations

Developer Guide

Yes

CommonJS

21.7.3

10.5.0

Score

Pull Requests

18

91

24

49

Issues

9

90

81

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

84.70 kB

29.37 kB

Maintainers

Package Meta Information

Total Downloads

2,643,844

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Electron Settings

Install

Demo

API Docs

10

10

0

0

0

0

0

0

0

0

0

1.5

/10

Other packages similar to electron-settings