Skip to main content

Property

Decorator for deprecated properties.

def Property(
deprecation: string = null,
removal: string = null,
alternative: string = null,
description: string = null
) - > function

Decorator for deprecated properties.

Parameters

NameTypeDescription
deprecationstring = nullThe version or date when the property was first marked as deprecated
removalstring = nullThe version or date when the property is scheduled to be removed from the codebase
alternativestring = nullA string describing the recommended replacement or alternative approach for callers to use
descriptionstring = nullA custom description of the property; defaults to the name of the decorated function if not provided

Returns

TypeDescription
functionA decorator function that wraps a property with deprecation metadata and logic