Interface DeprecatedOptions

Options supported by deprecated.

interface DeprecatedOptions {
    alternative?: string;
    name: string;
    packageName?: string;
    since: string;
}

Properties

alternative?: string

Available alternatives, if any. Should be a succinct message like use xyz instead.

name: string

The entity name (class name, function name, option, ...) that was deprecated.

packageName?: string

The package that contains the deprecated entity.

since: string

The version or date in which the entity was deprecated.