common

Defines an HTTP exception for Bad Gateway type errors.

Defines an HTTP exception for Bad Request type errors.

Factory that lets you create configurable modules and provides a way to reduce the majority of dynamic module boilerplate.

Defines an HTTP exception for Conflict type errors.

Defines the built-in FileTypeValidator. It validates incoming files by examining their magic numbers using the file-type package, providing more reliable file type validation than just checking the mimetype string.

Interface describing FileValidators, which can be added to a ParseFilePipe

Defines an HTTP exception for Forbidden type errors.

Defines an HTTP exception for Gateway Timeout type errors.

Defines an HTTP exception for Gone type errors.

Defines the base Nest HTTP exception, which is handled by the default Exceptions Handler.

Defines an HTTP exception for Http Version Not Supported type errors.

Defines an HTTP exception for ImATeapotException type errors.

Defines an HTTP exception for Internal Server Error type errors.

Exception that represents an intrinsic error in the application. When thrown, the default exception filter will not log the error message.

Defines the built-in MaxSize File Validator

Defines an HTTP exception for Method Not Allowed type errors.

Defines an HTTP exception for Misdirected type errors.

Defines an HTTP exception for Not Acceptable type errors.

Defines an HTTP exception for Not Found type errors.

Defines an HTTP exception for Not Implemented type errors.

Defines an HTTP exception for Payload Too Large type errors.

Defines an HTTP exception for Precondition Failed type errors.

Defines an HTTP exception for Request Timeout type errors.

Defines an HTTP exception for Service Unavailable type errors.

Defines an HTTP exception for Unauthorized type errors.

Defines an HTTP exception for Unprocessable Entity type errors.

Defines an HTTP exception for Unsupported Media Type type errors.

Decorator that binds parameter decorators to the method that follows.

Route handler parameter decorator. Extracts the entire body object property, or optionally a named property of the body object, from the req object and populates the decorated parameter with that value. Also applies pipes to the bound body parameter.

Decorator that marks a class as a Nest exception filter. An exception filter handles exceptions thrown by or not handled by your application code.

Decorator that marks a class as a Nest controller that can receive inbound requests and produce responses.

Decorator that makes a module global-scoped.

Request method Decorator. Sets a response header.

Route handler parameter decorator. Extracts the hosts property from the req object and populates the decorated parameter with the value of params. May also apply pipes to the bound parameter.

Request method Decorator. Defines the HTTP response status code. Overrides default status code for the decorated request method.

Decorator that marks a constructor parameter as a target for Dependency Injection (DI).

Decorator that marks a class as a provider. Providers can be injected into other classes via constructor parameter injection using Nest's built-in Dependency Injection (DI) system.

Decorator that marks a class as a module.

Parameter decorator for an injected dependency marking the dependency as optional.

Route handler parameter decorator. Extracts the params property from the req object and populates the decorated parameter with the value of params. May also apply pipes to the bound parameter.

Route handler parameter decorator. Extracts the query property from the req object and populates the decorated parameter with the value of query. May also apply pipes to the bound query parameter.

Route handler parameter decorator. Extracts the rawBody Buffer property from the req object and populates the decorated parameter with that value. Also applies pipes to the bound rawBody parameter.

Redirects request to the specified URL.

Route handler method Decorator. Defines a template to be rendered by the controller.

Declares this route as a Server-Sent-Events endpoint

Route handler parameter decorator. Extracts the file object and populates the decorated parameter with the value of file. Used in conjunction with multer middleware for Express-based applications.

Route handler parameter decorator. Extracts the files object and populates the decorated parameter with the value of files. Used in conjunction with multer middleware for Express-based applications.

Decorator that binds guards to the scope of the controller or method, depending on its context.

Decorator that binds interceptors to the scope of the controller or method, depending on its context.

Decorator that binds pipes to the scope of the controller or method, depending on its context.

Sets the version of the endpoint to the passed version

Defines HTTP route param decorator

Defines the built-in DefaultValue Pipe

Defines the built-in ParseArray Pipe

Defines the built-in ParseBool Pipe

Defines the built-in ParseEnum Pipe

Defines the built-in ParseFile Pipe. This pipe can be used to validate incoming files with @UploadedFile() decorator. You can use either other specific built-in validators or provide one of your own, simply implementing it through FileValidator interface and adding it to ParseFilePipe's constructor.

Defines the built-in ParseFloat Pipe

Defines the built-in ParseInt Pipe

Defines the built-in ParseUUID Pipe

Function that returns a new decorator that applies all decorators provided by param

Interface describing a pipe implementation's transform() method metadata argument.

Provides methods for retrieving the arguments being passed to a handler. Allows choosing the appropriate execution context (e.g., Http, RPC, or WebSockets) to retrieve the arguments from.

Interface providing access to the response stream.

Interface defining the canActivate() function that must be implemented by a guard. Return value indicates whether or not the current request is allowed to proceed. Return can be either synchronous (boolean) or asynchronous (Promise or Observable).

Interface defining a Class type provider.

Interface that represents the module async options object Factory method name varies depending on the "FactoryClassMethodKey" type argument.

Configurable module host. See properties for more details

Interface defining options that can be passed to @Controller() decorator

Interface defining a Dynamic Module.

Interface describing implementation of an exception filter.

Interface describing details about the current request pipeline.

Interface defining an Existing (aliased) type provider.

Interface defining a Factory type provider.

Interface defining the core NestApplication object.

Interface defining NestApplicationContext.

Interface describing Microservice Context.

Interface defining method for applying user defined middleware to routes.

Interface defining the property object that describes the module.

Interface describing implementation of an interceptor.

Interface defining method called once the application has fully started and is bootstrapped.

Interface defining method to respond to system signals (when application gets shutdown by, e.g., SIGTERM)

Interface defining method called just before Nest destroys the host module (app.close() method has been evaluated). Use to perform cleanup on resources (e.g., Database connections).

Interface defining method called once the host module has been initialized.

Interface describing implementation of a pipe.

Interface describing implementation of an RPC exception filter.

Validation error description.

Interface defining a Value type provider.

Interface describing implementation of a Web Sockets exception filter.

Route handler (method) Decorator. Routes all HTTP requests to the specified path.

Class that represents a blueprint/prototype for a configurable Nest module. This class provides static methods for constructing dynamic modules. Their names can be controlled through the "MethodKey" type argument.

Interface that must be implemented by the module options factory class. Method key varies depending on the "FactoryClassMethodKey" type argument.

Route handler (method) Decorator. Routes Webdav COPY requests to the specified path.

Route handler (method) Decorator. Routes HTTP DELETE requests to the specified path.

Decorator that sets required dependencies (required with a vanilla JavaScript objects)

Route handler (method) Decorator. Routes HTTP GET requests to the specified path.

Route handler (method) Decorator. Routes HTTP HEAD requests to the specified path.

Route handler parameter decorator. Extracts the headers property from the req object and populates the decorated parameter with the value of headers.

Defines the injection scope.

Route handler parameter decorator. Extracts the Ip property from the req object and populates the decorated parameter with the value of ip.

Route handler (method) Decorator. Routes Webdav LOCK requests to the specified path.

Route handler (method) Decorator. Routes Webdav MKCOL requests to the specified path.

Route handler (method) Decorator. Routes Webdav MOVE requests to the specified path.

Route handler parameter decorator. Extracts reference to the Next function from the underlying platform and populates the decorated parameter with the value of Next.

Route handler (method) Decorator. Routes HTTP OPTIONS requests to the specified path.

Route handler (method) Decorator. Routes HTTP PATCH requests to the specified path.

Route handler (method) Decorator. Routes HTTP POST requests to the specified path.

Route handler (method) Decorator. Routes Webdav PROPFIND requests to the specified path.

Route handler (method) Decorator. Routes Webdav PROPPATCH requests to the specified path.

Route handler (method) Decorator. Routes HTTP PUT requests to the specified path.

Route handler parameter decorator. Extracts the Request object from the underlying platform and populates the decorated parameter with the value of Request.

Route handler parameter decorator. Extracts the Response object from the underlying platform and populates the decorated parameter with the value of Response.

Route handler (method) Decorator. Routes HTTP SEARCH requests to the specified path.

Route handler parameter decorator. Extracts the Session object from the underlying platform and populates the decorated parameter with the value of Session.

Decorator that assigns metadata to the class/function using the specified key.

Route handler (method) Decorator. Routes Webdav UNLOCK requests to the specified path.

Decorator that binds exception filters to the scope of the controller or method, depending on its context.

Indicates that this will work for any version passed in the request, or no version.