The string id that is used to identify the setting that will be stored on the papi
WARNING: MUST BE STABLE - const or wrapped in useState, useMemo, etc. The reference must not be updated every render
The initial value to return while first awaiting the setting value
Optional
subscriberOptions: DataProviderSubscriberOptionsVarious options to adjust how the subscriber emits updates
Note: this parameter is internally assigned to a ref
, so changing it will not cause any hooks
to re-run with its new value. This means that subscriberOptions
will be passed to the data
provider's subscribe<data_type>
method as soon as possible and will not be updated again
until dataProviderSource
or selector
changes.
[setting, setSetting, resetSetting]
setting
: The current state of the setting, either defaultState
or the stored state on the
papi, if anysetSetting
: Function that updates the setting to a new valueresetSetting
: Function that removes the setting and resets the value to defaultState
Gets, sets and resets a setting on the papi. Also notifies subscribers when the setting changes and gets updated when the setting is changed by others.
Throws
When subscription callback function is called with an update that has an unexpected message type