Skip to content

Storage Api

GL.storage

Methods

deleteValue()

deleteValue(pluginName, key): void

Removes a value which has been saved

Parameters

ParameterType
pluginNamestring
keystring

Returns

void


getValue()

getValue(pluginName, key, defaultValue?): any

Gets a value that has previously been saved

Parameters

ParameterType
pluginNamestring
keystring
defaultValue?any

Returns

any


offAllChanges()

offAllChanges(pluginName): void

Removes all listeners added by onChange for a certain plugin

Parameters

ParameterType
pluginNamestring

Returns

void


offChange()

offChange(pluginName, key, callback): void

Removes a listener added by onChange

Parameters

ParameterType
pluginNamestring
keystring
callback(value, remote) => void

Returns

void


onChange()

onChange(pluginName, key, callback): () => void

Adds a listener for when a plugin’s stored value with a certain key changes

Parameters

ParameterType
pluginNamestring
keystring
callback(value, remote) => void

Returns

Function

Returns

void


setValue()

setValue(pluginName, key, value): void

Sets a value which can be retrieved later, through reloads

Parameters

ParameterType
pluginNamestring
keystring
valueany

Returns

void