uws-cors

Plugin for uWebSockets.js for Cross Origin Requests (CORS) Inspired by @elysiajs/cors.

Installation

yarn add uws-cors

Usage

import { App } from 'uWebSockets.js'
import { cors } from 'uws-cors'

const port = +(process.env.PORT || 3000)

const app = cors(App())
  .listen(port, (listenSocket) => {
    if (listenSocket) {
      console.log(`Server running at http://localhost:${port}`)
    } else {
      console.log(`Failed to listen to port ${port}`)
    }
  })

Config

origin

@default true

Assign the Access-Control-Allow-Origin header.

Value can be one of the following:

• string - String of origin which will directly assign to Access-Control-Allow-Origin

• boolean - If set to true, Access-Control-Allow-Origin will be set to * (accept all origin)

• RegExp - Pattern to use to test with request's url, will accept origin if matched.

• Function - Custom logic to validate origin acceptance or not. will accept origin if true is returned.

  • Function will accepts Context just like Handler

  // Example usage
  app.use(cors, {
    origin: ({ request, headers }) => true
  })
  
  // Type Definition
  type CORSOriginFn = (context: Context) => boolean | void

• Array<string | RegExp | Function> - Will try to find truthy value of all options above. Will accept Request if one is true.

methods

@default *

Assign Access-Control-Allow-Methods header.

Value can be one of the following: Accept:

• undefined | null | '' - Ignore all methods.

• * - Accept all methods.

• HTTPMethod - Will be directly set to Access-Control-Allow-Methods.

  • Expects either a single method or a comma-delimited string (eg: 'GET, PUT, POST')

• HTTPMethod[] - Allow multiple HTTP methods.

  • eg: ['GET', 'PUT', 'POST']

allowedHeaders

@default *

Assign Access-Control-Allow-Headers header.

Allow incoming request with the specified headers.

Value can be one of the following:

• string

  • Expects either a single method or a comma-delimited string (eg: 'Content-Type, Authorization').

• string[] - Allow multiple HTTP methods.

  • eg: ['Content-Type', 'Authorization']

exposedHeaders

@default *

Assign Access-Control-Exposed-Headers header.

Return the specified headers to request in CORS mode.

Value can be one of the following:

• string

  • Expects either a single method or a comma-delimited string (eg: 'Content-Type, 'X-Powered-By').

• string[] - Allow multiple HTTP methods.

  • eg: ['Content-Type', 'X-Powered-By']

credentials

@default true

Assign Access-Control-Allow-Credentials header.

Allow incoming requests to send credentials header.

• boolean - Available if set to true.

maxAge

@default 5

Assign Access-Control-Max-Age header.

Allow incoming requests to send credentials header.

• number - Duration in seconds to indicates how long the results of a preflight request can be cached.

preflight

@default true

Add [OPTIONS] /* handler to handle preflight request which response with HTTP 204 and CORS hints.

• boolean - Available if set to true.

License

This project is licensed under the MIT License.

Licenses for third-party projects are listed in THIRD-PARTY-LICENSE.