deprecated-decorator

What is deprecated-decorator?

The deprecated-decorator npm package provides a way to mark methods or classes as deprecated in JavaScript/TypeScript. This helps developers to signal that certain parts of the codebase should no longer be used and may be removed in future versions.

What are deprecated-decorator's main functionalities?

Deprecate a Method

This feature allows you to mark a method as deprecated. When the deprecated method is called, a warning message will be logged to the console.

const { deprecated } = require('deprecated-decorator');

class Example {
  @deprecated('This method will be removed in future versions. Use newMethod instead.')
  oldMethod() {
    console.log('This is the old method.');
  }

  newMethod() {
    console.log('This is the new method.');
  }
}

const example = new Example();
example.oldMethod();

Deprecate a Class

This feature allows you to mark an entire class as deprecated. When an instance of the deprecated class is created, a warning message will be logged to the console.

const { deprecated } = require('deprecated-decorator');

@deprecated('This class will be removed in future versions. Use NewClass instead.')
class OldClass {
  method() {
    console.log('This is a method in the old class.');
  }
}

class NewClass {
  method() {
    console.log('This is a method in the new class.');
  }
}

const oldInstance = new OldClass();
oldInstance.method();

Other packages similar to deprecated-decorator

core-decorators

The core-decorators package provides a set of decorators for common use cases, including deprecation. It offers a more comprehensive set of decorators compared to deprecated-decorator, making it a more versatile choice for developers who need additional functionality beyond deprecation.

deprecated

The deprecated package is another option for marking methods and classes as deprecated. It is similar in functionality to deprecated-decorator but offers a simpler API. It is a good choice for developers who need a straightforward solution for deprecation without additional features.

README

Deprecated Decorator

A simple decorator for deprecated properties, methods and classes. It can also wrap normal functions via the old-fashioned way.

Transpilers supported:

• TypeScript with experimentalDecorators option enabled.
• Babel with transform-decorators-legacy for version 6.x.

Install

npm install deprecated-decorator --save

API References

export declare type DeprecatedDecorator = ClassDecorator & PropertyDecorator;

export interface DeprecatedOptions {
    alternative?: string;
    version?: string;
    url?: string;
}

export declare function deprecated(options?: DeprecatedOptions): DeprecatedDecorator;
export declare function deprecated(alternative?: string, version?: string, url?: string): DeprecatedDecorator;

export declare function deprecated<T extends Function>(fn: T): T;
export declare function deprecated<T extends Function>(options: DeprecatedOptions, fn: T): T;
export declare function deprecated<T extends Function>(alternative: string, fn: T): T;
export declare function deprecated<T extends Function>(alternative: string, version: string, fn: T): T;
export declare function deprecated<T extends Function>(alternative: string, version: string, url: string, fn: T): T;

export default deprecated;

Usage

Decorating a class will enable warning on constructor and static methods (including static getters and setters):

import deprecated from 'deprecated-decorator';

// alternative, since version, url
@deprecated('Bar', '0.1.0', 'http://vane.life/')
class Foo {
    static method() { }
}

Or you can decorate methods respectively:

import deprecated from 'deprecated-decorator';

class Foo {
    @deprecated('otherMethod')
    method() { }
    
    @deprecated({
        alternative: 'otherProperty',
        version: '0.1.2',
        url: 'http://vane.life/'
    })
    get property() { }
}

For functions:

import deprecated from 'deprecated-decorator';

let foo = deprecated({
    alternative: 'bar',
    version: '0.1.0'
}, function foo() {
    // ...
});

License

MIT License.