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 (View Summary)

Middleware
- CORSMiddleware

Index

Constructors

Methods

_execute execute getDefaultAllowedHeaders getDefaultAllowedMethods getDefaultAllowedOrigin

Constructors

constructor

new CORSMiddleware(
    allowedOrigin?: string,
    allowedHeaders?: string[],
    allowedMethods?: string[],
): CORSMiddleware
Parameters
- OptionalallowedOrigin: string
  The allowed origin. By default it will use the request origin.
- OptionalallowedHeaders: string[]
  Array of allowed headers.
- OptionalallowedMethods: string[]
  Array of allowed HTTP methods.
Returns CORSMiddleware
Overrides Middleware.constructor
- Defined in src/CORSMiddleware.ts:39

Methods

`Protected`_execute

_execute(
request: Request,
response: Response,
): Promise<IRequestResponse<any, any>>
Parameters
- request: Request
- response: Response
Returns Promise<IRequestResponse<any, any>>
Overrides Middleware._execute
- Defined in src/CORSMiddleware.ts:75

execute

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

getDefaultAllowedHeaders

getDefaultAllowedHeaders(): string[]
Returns string[]
- Defined in src/CORSMiddleware.ts:54

getDefaultAllowedMethods

getDefaultAllowedMethods(): string[]
Returns string[]
- Defined in src/CORSMiddleware.ts:64

getDefaultAllowedOrigin

getDefaultAllowedOrigin(): string
Sets the allowed origin. By default,

Returns string
- Defined in src/CORSMiddleware.ts:50