Skip to main content

Interface: ExpressHttpPluginOptions

An interface extending the base HttpPluginOptions to include additional configuration options specific to the Express HTTP plugin. This includes options for body parsing, URL encoding, CORS, session management, cookie parsing, and response compression.

Extends​

Properties​

adapter​

adapter: HttpAdapterClass

The HTTP adapter to use. Express or Fastify are supported.

Inherited from​

HttpPluginOptions.adapter

basePath​

basePath: string

The base path for the HTTP server.

Inherited from​

HttpPluginOptions.basePath

bodyParser​

bodyParser: boolean

Whether to use the body parser middleware.

Inherited from​

HttpPluginOptions.bodyParser

bodyParserOptions?​

optional bodyParserOptions?: OptionsJson

Options for configuring the body parser middleware.

Overrides​

HttpPluginOptions.bodyParserOptions

compression​

compression: boolean

Whether to use compression middleware.

Inherited from​

HttpPluginOptions.compression

compressionOptions?​

optional compressionOptions?: CompressionOptions

Options for configuring the compression middleware.

Overrides​

HttpPluginOptions.compressionOptions

cookies​

cookies: boolean

Whether to use the cookie parser middleware.

Inherited from​

HttpPluginOptions.cookies

cookiesOptions?​

optional cookiesOptions?: object

Options for configuring the cookie parser middleware.

options?​

optional options?: CookieParseOptions

secret?​

optional secret?: string | string[]

Overrides​

HttpPluginOptions.cookiesOptions

cors​

cors: boolean

Whether to use CORS middleware.

Inherited from​

HttpPluginOptions.cors

corsOptions?​

optional corsOptions?: CorsOptions

Options for configuring the CORS middleware.

Overrides​

HttpPluginOptions.corsOptions

fileUpload?​

optional fileUpload?: boolean

Whether to use the file upload (multipart/form-data) middleware. Disabled by default.

Inherited from​

HttpPluginOptions.fileUpload

fileUploadOptions?​

optional fileUploadOptions?: FileUploadOptions

Options for configuring the file upload middleware.

Inherited from​

HttpPluginOptions.fileUploadOptions

healthChecks?​

optional healthChecks?: boolean

Whether to use the health check endpoints.

Inherited from​

HttpPluginOptions.healthChecks

logErrors?​

optional logErrors?: boolean

Whether to log all errors.

Inherited from​

HttpPluginOptions.logErrors

logHttpErrors?​

optional logHttpErrors?: boolean

Whether to log HTTP errors.

Inherited from​

HttpPluginOptions.logHttpErrors

logHttpRequests?​

optional logHttpRequests?: boolean

Whether to log HTTP requests.

Inherited from​

HttpPluginOptions.logHttpRequests

logHttpResponses?​

optional logHttpResponses?: boolean

Whether to log HTTP responses.

Inherited from​

HttpPluginOptions.logHttpResponses

plugin​

plugin: PluginType

Inherited from​

HttpPluginOptions.plugin

port​

port: number

The port on which the HTTP server will listen.

Inherited from​

HttpPluginOptions.port

rateLimit?​

optional rateLimit?: boolean

Whether to use HTTP rate limiting. Disabled by default.

Inherited from​

HttpPluginOptions.rateLimit

rateLimitOptions?​

optional rateLimitOptions?: RateLimitOptions

Default rate limits applied to endpoints without decorator overrides.

Inherited from​

HttpPluginOptions.rateLimitOptions

routeValidation?​

optional routeValidation?: boolean

Whether to validate route compatibility during plugin registration. Defaults to true.

Inherited from​

HttpPluginOptions.routeValidation

routeValidationOptions?​

optional routeValidationOptions?: RouteValidationOptions

Actions to apply to each kind of route compatibility finding.

Inherited from​

HttpPluginOptions.routeValidationOptions

session​

session: boolean

Whether to use the session middleware.

Inherited from​

HttpPluginOptions.session

sessionOptions?​

optional sessionOptions?: SessionOptions

Options for configuring the session middleware.

Overrides​

HttpPluginOptions.sessionOptions

timeout​

timeout: boolean

Whether to use the timeout middleware.

Inherited from​

HttpPluginOptions.timeout

timeoutOptions?​

optional timeoutOptions?: TimeoutOptions

Options for configuring the timeout middleware.

Inherited from​

HttpPluginOptions.timeoutOptions

urlEncoded?​

optional urlEncoded?: boolean

Whether to use the URL-encoded middleware.

Inherited from​

HttpPluginOptions.urlEncoded

urlEncodedOptions?​

optional urlEncodedOptions?: OptionsUrlencoded

Options for configuring the URL-encoded middleware.

Overrides​

HttpPluginOptions.urlEncodedOptions

version​

version: boolean

Whether to use the versioning guard.

Inherited from​

HttpPluginOptions.version

versionOptions?​

optional versionOptions?: VersionOptions

Options for configuring the versioning guard.

Inherited from​

HttpPluginOptions.versionOptions