Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saltyaom/kingworld-cors
A plugin for kingworld that for Cross Origin Requests (CORs)
https://github.com/saltyaom/kingworld-cors
Last synced: 2 days ago
JSON representation
A plugin for kingworld that for Cross Origin Requests (CORs)
- Host: GitHub
- URL: https://github.com/saltyaom/kingworld-cors
- Owner: SaltyAom
- License: mit
- Created: 2022-07-15T11:29:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-04T13:36:46.000Z (almost 2 years ago)
- Last Synced: 2024-10-25T08:50:53.742Z (19 days ago)
- Language: TypeScript
- Size: 104 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @kingworldjs/cors
A plugin for [kingworld](https://github.com/elysiajs/elysia) that for Cross Origin Requests (CORs)
## Installation
```bash
bun add @kingworldjs/cors
```
## Example
```typescript
import KingWorld from 'kingworld'
import cors from '@kingworldjs/cors'
const app = new KingWorld()
.use(cors())
.listen(8080)
```
## Config
### origin
@default `true`
Assign the **Access-Control-Allow-Origin** header.
Value can be one of the following:
- `string` - String of origin which will be 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`
```typescript
// Example usage
app.use(cors, {
origin: ({ request, headers }) => true
})
// Type Definition
type CORSOriginFn = (context: Context) => boolean | void
```
- `Array` - 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`.