Class HSTS

Generates a middleware that includes the HSTS header on the responses.

See

https://tools.ietf.org/html/rfc6797

Prettierignore

Index

Constructors

Properties

_header _options

Accessors

Methods

_buildHeader getMiddleware

Constructors

constructor

new HSTS(options?): HSTS
Parameters
- options: Partial<HSTSMiddlewareOptions> = {}
  The options to construct the class.
Returns HSTS
- Defined in src/middlewares/common/hsts.ts:71

Properties

`Protected` `Readonly` _header

_header: string

The value of the header that will be included in the responses.

`Protected` `Readonly` _options

_options: HSTSMiddlewareOptions

The customization options for the header.

Accessors

header

get header(): string
The value of the header that will be included in the responses.

Returns string
- Defined in src/middlewares/common/hsts.ts:98

options

get options(): Readonly<HSTSMiddlewareOptions>
The customization options.

Returns Readonly<HSTSMiddlewareOptions>
- Defined in src/middlewares/common/hsts.ts:92

Methods

`Protected` _buildHeader

_buildHeader(): string
Creates the header value based on the customization options.

Returns string
- Defined in src/middlewares/common/hsts.ts:104

getMiddleware

getMiddleware(): ExpressMiddleware
Generates the middleware that includes the HSTS header on the responses.

Returns ExpressMiddleware
- Defined in src/middlewares/common/hsts.ts:83

Generated using TypeDoc