Skip to main content

is_deprecated_setting

Checks if a specific setting is deprecated by attempting to retrieve its deprecation attribute from the settings collection.

def is_deprecated_setting(
setting: string
) - > string

Checks if a specific configuration setting is marked for deprecation and returns the version or date by which it will be removed.

Parameters​

NameTypeDescription
settingstringThe unique key or name of the configuration setting to check for deprecation status.

Returns​

TypeDescription
stringThe deprecation milestone (version or date) if the setting is deprecated, otherwise null if the setting is active or not found.