# Deprecated Decorator
Module | import { Deprecated } from "@tsed/core" |
---|---|
Source | /packages/core/src/decorators/deprecated.ts |
# Overview
function Deprecated(message: string): Function;
# Description
The @Deprecated()
decorators wraps the given method in such a way that it is marked as deprecated.
provide Foo {
@Deprecated("Foo.method: Use Foo.method2 instead")
public method() {
}
2
3
4
5
6
When called, @Deprecated() will return a function that will emit a DeprecationWarning
using the process.on('warning')
event.
By default, this warning will be emitted and printed to stderr
exactly once, the first time it is called. After the warning is emitted, the wrapped method is called.
If either the --no-deprecation
or --no-warnings
command line flags are used, or if the process.noDeprecation
property is set to true
prior to the first deprecation warning, the @Deprecated()
decorators does nothing.
If the --trace-deprecation
or --trace-warnings
command line flags are set, or the process.traceDeprecation
property is set to true
, a warning and a stack trace are printed to stderr the first time the deprecated function is called.
If the --throw-deprecation
command line flag is set, or the process.throwDeprecation
property is set to true
,
then an exception will be thrown when the deprecated function is called.
The --throw-deprecation
command line flag and process.throwDeprecation
property take precedence over --trace-deprecation
and process.traceDeprecation
.
- Session & cookies
- Passport.js
- TypeORM
- Mongoose
- GraphQL
- Socket.io
- Swagger
- AJV
- Multer
- Serve static files
- Templating
- Throw HTTP Exceptions
- Customize 404
- AWS
- Jest
- Seq
- Controllers
- Providers
- Model
- Converters
- Middlewares
- Pipes
- Interceptors
- Authentication
- Hooks
- Injection scopes
- Custom providers
- Custom endpoint decorator
- Testing