@nestjs/platform-express

@nestjs/platform-express

Version 12.2.0
Published 7 days ago
80.7 kB
5 dependencies
MIT license

Install

npm i @nestjs/platform-express

yarn add @nestjs/platform-express

pnpm add @nestjs/platform-express

Overview

Nest - modern, fast, powerful node.js web framework (@platform-express)

Index

Functions

AnyFilesInterceptor()
FileFieldsInterceptor()
FileInterceptor()
FilesInterceptor()
NoFilesInterceptor()

Functions

function AnyFilesInterceptor

AnyFilesInterceptor: (localOptions?: MulterOptions) => Type<NestInterceptor>;

Parameter localOptions

function FileFieldsInterceptor

FileFieldsInterceptor: (
    uploadFields: MulterField[],
    localOptions?: MulterOptions
) => Type<NestInterceptor>;

Parameter uploadFields
Parameter localOptions

function FileInterceptor

FileInterceptor: (
    fieldName: string,
    localOptions?: MulterOptions
) => Type<NestInterceptor>;

Parameter fieldName
Parameter localOptions

function FilesInterceptor

FilesInterceptor: (
    fieldName: string,
    maxCount?: number,
    localOptions?: MulterOptions
) => Type<NestInterceptor>;

Parameter fieldName
Parameter maxCount
Parameter localOptions

function NoFilesInterceptor

NoFilesInterceptor: (localOptions?: MulterOptions) => Type<NestInterceptor>;

Parameter localOptions

Classes

class ExpressAdapter

class ExpressAdapter extends AbstractHttpAdapter<http.Server | https.Server> {}

constructor

constructor(instance?: any);

method appendHeader

appendHeader: (response: any, name: string, value: string) => any;

method applyVersionFilter

applyVersionFilter: (
    handler: Function,
    version: VersionValue,
    versioningOptions: VersioningOptions
) => VersionedRoute;

method beforeClose

beforeClose: () => void;

method close

close: () => Promise<unknown> | undefined;

method createMiddlewareFactory

createMiddlewareFactory: (
    requestMethod: RequestMethod
) => (path: string, callback: Function) => any;

method disable

disable: (...args: any[]) => any;

method enable

enable: (...args: any[]) => any;

method enableCors

enableCors: (options: CorsOptions | CorsOptionsDelegate<any>) => any;

method end

end: (response: any, message?: string) => any;

method engine

engine: (...args: any[]) => any;

method getHeader

getHeader: (response: any, name: string) => any;

method getRequestHostname

getRequestHostname: (request: any) => string;

method getRequestMethod

getRequestMethod: (request: any) => string;

method getRequestUrl

getRequestUrl: (request: any) => string;

method getRouteMatchingOptions

getRouteMatchingOptions: () => {
    caseSensitive: boolean;
    ignoreTrailingSlash: boolean;
};

method getType

getType: () => string;

method initHttpServer

initHttpServer: (options: NestApplicationOptions) => void;

method isHeadersSent

isHeadersSent: (response: any) => boolean;

method isRouteOrderSensitive

isRouteOrderSensitive: () => boolean;

method listen

listen: {
    (port: string | number, callback?: () => void): Server;
    (port: string | number, hostname: string, callback?: () => void): Server;
};

method mapException

mapException: (error: unknown) => unknown;

method normalizePath

normalizePath: (path: string) => string;

method redirect

redirect: (response: any, statusCode: number, url: string) => any;

method registerParserMiddleware

registerParserMiddleware: (prefix?: string, rawBody?: boolean) => void;

method render

render: (response: any, view: string, options: any) => any;

method reply

reply: (response: any, body: any, statusCode?: number) => any;

method set

set: (...args: any[]) => any;

method setBaseViewsDir

setBaseViewsDir: (path: string | string[]) => any;

method setErrorHandler

setErrorHandler: (handler: Function, prefix?: string) => any;

method setHeader

setHeader: (response: any, name: string, value: string) => any;

method setLocal

setLocal: (key: string, value: any) => this;

method setNotFoundHandler

setNotFoundHandler: (
    handler: Function,
    prefix?: string,
    excludedRoutes?: RouteInfo[]
) => any;

method setOnRequestHook

setOnRequestHook: (
    onRequestHook: (
        req: express.Request,
        res: express.Response,
        done: (err?: Error) => void
    ) => Promise<void> | void
) => void;

Registers a request hook. Call done() to continue processing the request; resolving the returned promise does not continue it. Only the first completion is forwarded to Express. Errors after done() are logged without advancing the request again.

method setOnResponseHook

setOnResponseHook: (
    onResponseHook: (
        req: express.Request,
        res: express.Response
    ) => Promise<void> | void
) => void;

Registers a hook to run after the response has been sent. Thrown errors and rejected promises are logged.

method setViewEngine

setViewEngine: (engine: string) => any;

method status

status: (response: any, statusCode: number) => any;

method useBodyParser

useBodyParser: <ParserType extends keyof NestExpressBodyParserOptionsMap>(
    type: ParserType,
    rawBody: boolean,
    options?: NestExpressBodyParserOptionsFor<ParserType>
) => this;

method useStaticAssets

useStaticAssets: (path: string, options: ServeStaticOptions) => any;

class MulterModule

class MulterModule {}

method register

static register: (options?: MulterModuleOptions) => DynamicModule;

method registerAsync

static registerAsync: (options: MulterModuleAsyncOptions) => DynamicModule;

Interfaces

interface MulterModuleAsyncOptions

interface MulterModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {}

property inject

inject?: any[];

property useClass

useClass?: Type<MulterOptionsFactory>;

property useExisting

useExisting?: Type<MulterOptionsFactory>;

property useFactory

useFactory?: (
    ...args: any[]
) => Promise<MulterModuleOptions> | MulterModuleOptions;

interface MulterOptionsFactory

interface MulterOptionsFactory {}

method createMulterOptions

createMulterOptions: () => Promise<MulterModuleOptions> | MulterModuleOptions;

interface NestExpressApplication

interface NestExpressApplication<
    TServer extends CoreHttpServer | CoreHttpsServer = CoreHttpServer
> extends INestApplication<TServer> {}

Interface describing methods on NestExpressApplication.
See Also
- [Platform](https://docs.nestjs.com/first-steps#platform)

method disable

disable: (...args: any[]) => this;

A wrapper function around native express.disable() method.
Returns
{this}
Example 1
app.disable('x-powered-by')

method enable

enable: (...args: any[]) => this;

A wrapper function around native express.enable() method.
Returns
{this}
Example 1
app.enable('x-powered-by')

method enableCors

enableCors: (options?: CorsOptions | CorsOptionsDelegate<any>) => void;

method engine

engine: (...args: any[]) => this;

A wrapper function around native express.engine() method.
Returns
{this}
Example 1
app.engine('mustache', mustacheExpress())

method getHttpAdapter

getHttpAdapter: () => HttpServer<Express.Request, Express.Response, Express>;

Returns the underlying HTTP adapter bounded to the Express.js app.
Returns
{HttpServer}

method listen

listen: {
    (port: number | string, callback?: () => void): Promise<TServer>;
    (
        port: string | number,
        hostname: string,
        callback?: () => void
    ): Promise<TServer>;
};

Starts the application.
Parameter port
Parameter hostname
Parameter callback
Optional callback
Returns
{Promise} A Promise that, when resolved, is a reference to the underlying HttpServer.

method set

set: (...args: any[]) => this;

A wrapper function around native express.set() method.
Returns
{this}
Example 1
app.set('trust proxy', 'loopback')

method setBaseViewsDir

setBaseViewsDir: (path: string | string[]) => this;

Sets one or multiple base directories for templates (views).
Returns
{this}
Example 1
app.setBaseViewsDir('views')

method setLocal

setLocal: (key: string, value: any) => this;

Sets app-level globals for view templates.
Returns
{this}
Example 1
app.setLocal('title', 'My Site')
See Also
- https://expressjs.com/en/4x/api.html#app.locals

method setViewEngine

setViewEngine: (engine: string) => this;

Sets a view engine for templates (views).
Returns
{this}
Example 1
app.setViewEngine('pug')

method useBodyParser

useBodyParser: <ParserType extends keyof NestExpressBodyParserOptionsMap>(
    parser: ParserType,
    options?: NestExpressBodyParserOptionsFor<ParserType>
) => this;

Register Express body parsers on the fly. Will respect the application's rawBody option.
Returns
{this}
Example 1
const app = await NestFactory.create( AppModule, { rawBody: true } ); app.useBodyParser('json', { limit: '50mb' });
The accepted options are narrowed by the parser argument, so useBodyParser('json', ...) only accepts express.json options, useBodyParser('urlencoded', ...) only accepts express.urlencoded options, and so on.

method useStaticAssets

useStaticAssets: {
    (options: ServeStaticOptions): this;
    (path: string, options?: ServeStaticOptions): this;
};

Sets a base directory for public assets.
Returns
{this}
Example 1
app.useStaticAssets('public')

interface NestExpressBodyParserOptions

interface NestExpressBodyParserOptions {}

Type alias to keep compatibility with @types/body-parser
See Also
- https://github.com/DefinitelyTyped/DefinitelyTyped/blob/dcd1673c4fa18a15ea8cd8ff8af7d563bb6dc8e6/types/body-parser/index.d.ts#L48-L66#L48-L66
Deprecated
Prefer NestExpressBodyParserOptionsFor, which resolves the exact options type for a given parser. The catch-all index signature below makes keyof resolve to string | number, which disables excess-property checking and makes Omit<_, 'verify'> a no-op.

property inflate

inflate?: boolean | undefined;

When set to true, then deflated (compressed) bodies will be inflated; when false, deflated bodies are rejected. Defaults to true.

property limit

limit?: number | string | undefined;

Controls the maximum request body size. If this is a number, then the value specifies the number of bytes; if it is a string, the value is passed to the bytes library for parsing. Defaults to '100kb'.

property type

type?: string | string[] | ((req: IncomingMessage) => any) | undefined;

The type option is used to determine what media type the middleware will parse

index signature

[key: string]: unknown;

interface NestExpressBodyParserOptionsMap

interface NestExpressBodyParserOptionsMap {}

Maps each body parser to the options object accepted by its Express factory.
Derived from express itself so the two can never drift: useBodyParser ultimately calls express[parser](options).

property json

json: NonNullable<Parameters<Express['json']>[0]>;

property raw

raw: NonNullable<Parameters<Express['raw']>[0]>;

property text

text: NonNullable<Parameters<Express['text']>[0]>;

property urlencoded

urlencoded: NonNullable<Parameters<Express['urlencoded']>[0]>;

Type Aliases

type MulterModuleOptions

type MulterModuleOptions = MulterOptions;

type NestExpressBodyParserOptionsFor

type NestExpressBodyParserOptionsFor<ParserType extends NestExpressBodyParserType> =
    Omit<NestExpressBodyParserOptionsMap[ParserType], 'verify'>;

Options accepted by a given body parser.
verify is excluded because it is reserved: Nest sets it internally to capture the raw request body when the application is created with { rawBody: true }.

type NestExpressBodyParserType

type NestExpressBodyParserType = keyof NestExpressBodyParserOptionsMap;

Interface defining possible body parser types, to be used with NestExpressApplication.useBodyParser().

Package Files (12)

Dependencies (5)

Dev Dependencies (2)

Peer Dependencies (2)

Badge

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

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@nestjs/platform-express.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@nestjs/platform-express)

HTML

<a href="https://www.jsdocs.io/package/@nestjs/platform-express"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 6 days ago.
Package analyzed in 2624 ms.
Missing or incorrect documentation? Open an issue for this package.

@nestjs/platform-express

Install

Overview

Index

Functions

Classes

Interfaces

Type Aliases

Functions

function AnyFilesInterceptor

Parameter localOptions

function FileFieldsInterceptor

Parameter uploadFields

Parameter localOptions

function FileInterceptor

Parameter fieldName

Parameter localOptions

function FilesInterceptor

Parameter fieldName

Parameter maxCount

Parameter localOptions

function NoFilesInterceptor

Parameter localOptions

Classes

class ExpressAdapter

constructor

method appendHeader

method applyVersionFilter

method beforeClose

method close

method createMiddlewareFactory

method disable

method enable

method enableCors

method end

method engine

method getHeader

method getRequestHostname

method getRequestMethod

method getRequestUrl

method getRouteMatchingOptions

method getType

method initHttpServer

method isHeadersSent

method isRouteOrderSensitive

method listen

method mapException

method normalizePath

method redirect

method registerParserMiddleware

method render

method reply

method set

method setBaseViewsDir

method setErrorHandler

method setHeader

method setLocal

method setNotFoundHandler

method setOnRequestHook

method setOnResponseHook

method setViewEngine

method status

method useBodyParser

method useStaticAssets

class MulterModule

method register

method registerAsync

Interfaces

interface MulterModuleAsyncOptions

property inject

property useClass

property useExisting

property useFactory

interface MulterOptionsFactory

method createMulterOptions

interface NestExpressApplication

See Also

method disable

Returns

Example 1