README
@agmascripts/plugin-settings
Settings plugin for @agmascripts/core
Table of Contents
Features
- Save settings in localStorage
- Single source of truth for your script
- Easy to use methods
Installation
Using NPM:
$ npm install @agmascripts/plugin-settings
Using Yarn:
$ yarn add @agmascripts/plugin-settings
Usage
const { Core } = require('@agmascripts/core');
const Script = new Core();
// Import settings plugin
const settingsPlugin = require('@agmascripts/plugin-settings');
Script.use(settingsPlugin, {
name: 'settings',
defaults: {}
})
Methods
Method | Description |
---|---|
Script.$settings.get(name) |
Get a setting by name, leave empty to get full settings object |
Script.$settings.set(name, value) |
Set a setting with name and value |
Script.$settings.restoreDefaults() |
Restore settings to defaults |
Properties
Property | Description |
---|---|
Script.$settings.settings |
Object of current settings |
Help
Join the discord for help.