{"id":13508334,"url":"https://github.com/nathanbuchar/electron-settings","last_synced_at":"2025-05-15T08:07:02.803Z","repository":{"id":1936740,"uuid":"45360814","full_name":"nathanbuchar/electron-settings","owner":"nathanbuchar","description":"📝 A simple persistent user settings framework for Electron.","archived":false,"fork":false,"pushed_at":"2024-04-23T12:27:16.000Z","size":861,"stargazers_count":824,"open_issues_count":27,"forks_count":60,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-10T03:38:57.347Z","etag":null,"topics":["electron","javascript","node"],"latest_commit_sha":null,"homepage":"https://electron-settings.js.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nathanbuchar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-11-01T22:48:04.000Z","updated_at":"2025-03-08T13:49:27.000Z","dependencies_parsed_at":"2024-04-11T15:43:04.780Z","dependency_job_id":null,"html_url":"https://github.com/nathanbuchar/electron-settings","commit_stats":{"total_commits":204,"total_committers":12,"mean_commits":17.0,"dds":0.2450980392156863,"last_synced_commit":"11c0f16e1958887267492f66d66d3d8c77e8d58d"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanbuchar%2Felectron-settings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanbuchar%2Felectron-settings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanbuchar%2Felectron-settings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanbuchar%2Felectron-settings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nathanbuchar","download_url":"https://codeload.github.com/nathanbuchar/electron-settings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248854414,"owners_count":21172358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","javascript","node"],"created_at":"2024-08-01T02:00:51.578Z","updated_at":"2025-04-14T13:49:12.164Z","avatar_url":"https://github.com/nathanbuchar.png","language":"TypeScript","funding_links":[],"categories":["Tools","JavaScript","TypeScript","Library"],"sub_categories":["For Electron","Persistent"],"readme":"# Electron Settings\n\nA simple and robust settings management library for [Electron](https://electronjs.org).\n\nBorn from Atom's original internal configuration manager and the settings manager of choice for Electron's own [API Demos app](https://github.com/electron/electron-api-demos), Electron Settings allows you to persist user settings and other data between app loads simply and easily.\n\n[![Npm version][badge_npm-version]][external_npm]\n[![Npm downloads][badge_npm-downloads]][external_npm]\n[![David][badge_david]][external_david]\n[![Travis][badge_travis]][external_travis]\n\n\u003cbr/\u003e\n\n### Install\n\n```\nnpm install electron-settings\n```\n\n### Demo\n\n```ts\nimport settings from 'electron-settings';\n\nawait settings.set('color', {\n  name: 'cerulean',\n  code: {\n    rgb: [0, 179, 230],\n    hex: '#003BE6'\n  }\n});\n\nawait settings.get('color.name');\n// =\u003e \"cerulean\"\n\nawait settings.get('color.code.rgb[1]');\n// =\u003e 179\n```\n\n⚠ 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](https://github.com/nathanbuchar/electron-settings/issues/133) for more info.\n\n```js\nnew BrowserWindow({\n  webPreferences: {\n    enableRemoteModule: true // \u003c-- Add me\n  }\n});\n```\n\n### API Docs\n\nAPI docs and can be found at [electron-settings.js.org](https://electron-settings.js.org).\n\n\n\n\u003cbr/\u003e\n\u003cbr/\u003e\n\u003chr/\u003e\n\n\u003csmall\u003e**Having trouble?** [Get help on Gitter][external_gitter].\u003c/small\u003e\n\n\n\n\n\n[docs]: https://nathanbuchar.github.io/electron-settings/\n\n[badge_npm-version]: https://img.shields.io/npm/v/electron-settings.svg\n[badge_npm-downloads]: https://img.shields.io/npm/dm/electron-settings.svg\n[badge_david]: https://img.shields.io/david/nathanbuchar/electron-settings.svg\n[badge_travis]: https://img.shields.io/travis/nathanbuchar/electron-settings/master.svg\n\n[external_david]: https://david-dm.org/nathanbuchar/electron-settings\n[external_electron]: https://electron.atom.io\n[external_gitter]: https://gitter.im/nathanbuchar/electron-settings\n[external_npm]: https://npmjs.org/package/electron-settings\n[external_travis]: https://travis-ci.org/nathanbuchar/electron-settings.svg?branch=master\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathanbuchar%2Felectron-settings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnathanbuchar%2Felectron-settings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathanbuchar%2Felectron-settings/lists"}