Class CORSMiddleware

CORSMiddleware is used to enable CORS on APIs. It will automatically add the necessary headers necessary to communicate with CORS enabled clients.

Hierarchy

Middleware
- CORSMiddleware

Index

Constructors

constructor

Methods

Constructors

constructor

new CORSMiddleware(allowedOrigin?: string, allowedHeaders?: Array<string>, allowedMethods?: Array<string>): CORSMiddleware

Overrides Middleware.constructor
- Defined in src/CORSMiddleware.ts:30
Parameters
- Optional allowedOrigin: string
  
  The allowed origin. By default it will use the request origin.
- Optional allowedHeaders: Array<string>
  
  Array of allowed headers.
- Optional allowedMethods: Array<string>
  
  Array of allowed HTTP methods.
Returns CORSMiddleware

Methods

Protected _execute

_execute(request: Request, response: Response): Promise<IRequestResponse>

Overrides Middleware._execute
- Defined in src/CORSMiddleware.ts:74
Parameters
- request: Request
- response: Response
Returns Promise<IRequestResponse>

execute

execute(request: Request, response: Response): Promise<IRequestResponse>

Inherited from Middleware.execute
- Defined in src/Middleware.ts:26
Parameters
- request: Request
- response: Response
Returns Promise<IRequestResponse>

getDefaultAllowedHeaders

getDefaultAllowedHeaders(): Array<string>

- Defined in src/CORSMiddleware.ts:53
Returns Array<string>

getDefaultAllowedMethods

getDefaultAllowedMethods(): Array<string>

- Defined in src/CORSMiddleware.ts:63
Returns Array<string>

getDefaultAllowedOrigin

getDefaultAllowedOrigin(): string

- Defined in src/CORSMiddleware.ts:49
Sets the allowed origin. By default,

Returns string

Generated using TypeDoc