Skip to main content

hooks/useSCPreference

Functions

useSCPreference()

useSCPreference<T>(preferenceKey, defaultValue?): T

Custom hook to recover a given preference.

Type Parameters

Type ParameterDefault type
Tany

Parameters

ParameterTypeDescription
preferenceKeystringfull preference key (e.g., 'section.name')
defaultValue?Tdefault returned value

Returns

T

the preference value or undefined/defaultValue if doesn't exist

Ex. const customValue = useSCPreference<string>(SCPreferences.CUSTOM_SETTING); const numericValue = useSCPreference<number>(SCPreferences.CUSTOM_SETTING, 0);


useSCPreferenceEnabled()

useSCPreferenceEnabled(preferenceKey, defaultValue): boolean

Custom hook to check if a given preference is present and has a value.

Parameters

ParameterTypeDefault valueDescription
preferenceKeystringundefinedfull preference key (e.g., 'section.name')
defaultValuebooleanfalsedefault returned value (default=false)

Returns

boolean

boolean

Ex. const isEnabled = useSCPreferenceEnabled(SCPreferences.CONFIGURATIONS_CONNECTION_ENABLED);


useSCPreferencesEnabled()

useSCPreferencesEnabled(preferenceKeys, defaultValue): boolean

Custom hook to check if all specified preferences are enabled

Parameters

ParameterTypeDefault valueDescription
preferenceKeysstring[]undefinedArray of preference keys to check
defaultValuebooleanfalseDefault value if a preference doesn't exist

Returns

boolean

boolean - true if all preferences are enabled

Ex. const arePreferencesEnabled = useSCPreferencesEnabled([ SCPreferences.CONFIGURATIONS_POST_USER_ADDRESSING_ENABLED, SCPreferences.CONFIGURATIONS_SCHEDULED_POSTS_ENABLED ]);