Class: State

State()

State class

Constructor

new State()

Source:

Members

(static) contract :Object

State constract
Type:
  • Object
Source:

type_names

Get type names
Source:

Methods

addType(t)

Add type
Parameters:
Name Type Description
t
Source:

(async) deleteConfig(key) → {Promise.<void>}

Delete config parameter by key
Parameters:
Name Type Description
key key of parameter
Source:
Returns:
Type
Promise.<void>

getConfig(key, def) → {*}

Get config parameter by key
Parameters:
Name Type Description
key key of config paramter
def default value
Source:
Returns:
Type
*

getConfigCopy(key, def) → {any}

Get copy of config parameter
Parameters:
Name Type Description
key key of parameter
def default value
Source:
Returns:
Type
any

getLayout(user) → {unknown}

Get Layout by user Based on role of user
Parameters:
Name Type Description
user
Source:
Returns:
Type
unknown

(async) refresh() → {Promise.<void>}

Refresh State cache for all Saltcorn main objects
Source:
Returns:
Type
Promise.<void>

(async) refresh_files() → {Promise.<void>}

Refresh files
Source:
Returns:
Type
Promise.<void>

(async) refresh_pages() → {Promise.<void>}

Refresh pages
Source:
Returns:
Type
Promise.<void>

(async) refresh_tables() → {Promise.<void>}

Refresh tables & fields
Source:
Returns:
Type
Promise.<void>

(async) refresh_triggers() → {Promise.<void>}

Refresh triggers
Source:
Returns:
Type
Promise.<void>

(async) refresh_views() → {Promise.<void>}

Refresh views
Source:
Returns:
Type
Promise.<void>

registerPlugin(name, plugin, cfg, location)

Registre plugin
Parameters:
Name Type Description
name
plugin
cfg
location
Source:

(async) reload_plugins() → {Promise.<void>}

Reload plugins
Source:
Returns:
Type
Promise.<void>

(async) remove_plugin(name) → {Promise.<void>}

Remove plugin
Parameters:
Name Type Description
name
Source:
Returns:
Type
Promise.<void>

(async) setConfig(key, value) → {Promise.<void>}

Set value of config parameter
Parameters:
Name Type Description
key key of parameter
value value of parameter
Source:
Returns:
Type
Promise.<void>