diff options
| author | kibigo! <marrus-sh@users.noreply.github.com> | 2017-07-14 11:13:02 -0700 |
|---|---|---|
| committer | kibigo! <marrus-sh@users.noreply.github.com> | 2017-07-16 17:13:16 -0700 |
| commit | d0aad1ac854eaa53f9b7d38cc8dd90e289790629 (patch) | |
| tree | 492c5fbc81bfb6dee10017814afb14d5ef549f27 /app/javascript/glitch/actions | |
| parent | 21b04af524888fea134cc7dfa04e1203ede0427a (diff) | |
Documentation and cleanup
Diffstat (limited to 'app/javascript/glitch/actions')
| -rw-r--r-- | app/javascript/glitch/actions/local_settings.js | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/app/javascript/glitch/actions/local_settings.js b/app/javascript/glitch/actions/local_settings.js index 479b5841d..93c5a9a17 100644 --- a/app/javascript/glitch/actions/local_settings.js +++ b/app/javascript/glitch/actions/local_settings.js @@ -21,12 +21,12 @@ consists of the following: */ - /* * * * */ +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* -Constants ---------- +Constants: +---------- We provide the following constants: @@ -39,12 +39,12 @@ We provide the following constants: export const LOCAL_SETTING_CHANGE = 'LOCAL_SETTING_CHANGE'; - /* * * * */ +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* -`changeLocalSetting(key, value)` --------------------------------- +`changeLocalSetting(key, value)`: +--------------------------------- Changes the local setting with the given `key` to the given `value`. `key` **MUST** be an array of strings, as required by @@ -67,12 +67,12 @@ export function changeLocalSetting(key, value) { }; }; - /* * * * */ +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* -`saveLocalSettings()` ---------------------- +`saveLocalSettings()`: +---------------------- Saves the local settings to `localStorage` as a JSON object. `changeLocalSetting()` calls this whenever it changes a setting. We |