@eagleoutice/flowr - v2.15.8
    Preparing search index...

    Interface DeprecatedFunctionInformation

    Information about a deprecated function

    Used in DeprecatedFunctionsConfig.conditionally to mark a function as deprecated under certain conditions

    interface DeprecatedFunctionInformation {
        replacedBy?: string;
        sinceVersion?: Range;
        state?: DeprecationState;
        whenArgs?: readonly DeprecatedArgumentInformation[];
    }
    Index
    replacedBy? sinceVersion? state? whenArgs?
    replacedBy?: string

    Suggested replacement for this function

    sinceVersion?: Range

    The version since this function is deprecated, if version is provided the entire function will be marked as deprecated, if the version range matches

    state?: DeprecationState

    Lifecycle State DeprecationState, i.e. is the function completely removed, or are there better alternatives

    whenArgs?: readonly DeprecatedArgumentInformation[]

    Mark specific arguments as deprecated If only whenArgs is provided, and not sinceVersion, the function is only marked as deprecated, if the argument is provided.

    Settings
    Member Visibility

    On This Page
    Properties