• Version 0.1.6
  • Published
  • No dependencies
  • MIT license


npm i deprecated-decorator
yarn add deprecated-decorator
pnpm add deprecated-decorator


A simple decorator for deprecated methods and properties.



function deprecated

deprecated: {
(options?: DeprecatedOptions): DeprecatedDecorator;
(alternative?: string, version?: string, url?: string): DeprecatedDecorator;
<T extends Function>(fn: T): T;
<T extends Function>(options: DeprecatedOptions, fn: T): T;
<T extends Function>(alternative: string, fn: T): T;
<T extends Function>(alternative: string, version: string, fn: T): T;
<T extends Function>(
alternative: string,
version: string,
url: string,
fn: T
): T;


    interface DeprecatedOptions

    interface DeprecatedOptions {}

      property alternative

      alternative?: string;

        property url

        url?: string;

          property version

          version?: string;

            Type Aliases

            type DeprecatedDecorator

            type DeprecatedDecorator = ClassDecorator & PropertyDecorator;

              Package Files (1)

              Dependencies (0)

              No dependencies.

              Dev Dependencies (5)

              Peer Dependencies (0)

              No peer dependencies.


              To add a badge like this badgeto your package's README, use the codes available below.

              You may also use to create a custom badge linking to

              • Markdown
              • HTML
                <a href=""><img src="" alt=""></a>