kibana/docs/development/core/public/kibana-plugin-public.uisettingsclient.set.md
Mikhail Shustov 53b133dd50
Route tags (#37344)
* expose route info in KibanaRequest

* update mocks in test

* make tags readonly, getRouteInfo is private method

* add mocks for hapi internals

* mode deepFreeze to core utils level as it env agnostic

* freeze route props

* fix typo

* add tests for route options

* fix integration tests. deep_freeze was moved under core utils

* add comments, expose public types and regenerate docs

* address comment. remove unnecessary async in route handlers

* make routeSchema optional instead of union with undefined

* @skaapgif improvements

* update docs
2019-06-06 15:49:37 +02:00

992 B

Home > kibana-plugin-public > UiSettingsClient > set

UiSettingsClient.set() method

Sets the value for a uiSetting. If the setting is not defined in the uiSettingDefaults it will be stored as a custom setting. The new value will be synchronously available via the get() method and sent to the server in the background. If the request to the server fails then a toast notification will be displayed and the setting will be reverted it its value before set() was called.

Signature:

set(key: string, val: any): Promise<boolean>;

Parameters

Parameter Type Description
key string
val any

Returns:

Promise<boolean>