deprecated-decorator
deprecated-decorator是什么
什么是deprecated-decorator,A simple decorator for deprecated methods and properties.
deprecated-decorator使用教程帮助文档
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.
本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。
转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]
本文地址:https://www.javascriptcn.com/read-42600.html
文章标题:deprecated-decorator