hooks/useSCPreference
Functions
useSCPreference()
useSCPreference<
T
>(preferenceKey
,defaultValue?
):T
Custom hook to recover a given preference.
Type Parameters
Type Parameter | Default type |
---|---|
T | any |
Parameters
Parameter | Type | Description |
---|---|---|
preferenceKey | string | full preference key (e.g., 'section.name') |
defaultValue? | T | default 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
Parameter | Type | Default value | Description |
---|---|---|---|
preferenceKey | string | undefined | full preference key (e.g., 'section.name') |
defaultValue | boolean | false | default 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
Parameter | Type | Default value | Description |
---|---|---|---|
preferenceKeys | string [] | undefined | Array of preference keys to check |
defaultValue | boolean | false | Default 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 ]);