https://github.com/ts-stack/cors
https://github.com/ts-stack/cors
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ts-stack/cors
- Owner: ts-stack
- License: mit
- Created: 2022-10-01T20:09:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T18:56:14.000Z (about 1 year ago)
- Last Synced: 2025-03-12T19:34:29.955Z (2 months ago)
- Language: TypeScript
- Size: 264 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @ts-stack/cors
CORS is a node.js package writen in TypeScript for providing a sync middleware that can be used to enable [CORS](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing) with various options.
This package is a fork of express/cors module from [this state](https://github.com/expressjs/cors/tree/f038e772283).
* [Installation](#installation)
* [Usage](#usage)
* [Simple Usage](#simple-usage-enable-all-cors-requests)
* [Enabling CORS Pre-Flight](#enabling-cors-pre-flight)
## Installation
```bash
npm install @ts-stack/cors
```
## Usage
### Simple Usage (Enable CORS Requests to https://example.com)
```js
import http from 'http';
import { cors, mergeOptions } from '@ts-stack/cors';
const hostname = '127.0.0.1';
const port = 3000;
const corsOptions = mergeOptions({ origin: 'https://example.com' });
const server = http.createServer((req, res) => {
res.statusCode = 200;
const headersSent = cors(req, res, corsOptions);
if (headersSent) {
return;
}
res.setHeader('Content-Type', 'text/plain');
res.end('This is CORS-enabled for https://example.com!');
});
server.listen(port, hostname, () => {
console.log(`Server running at http://${hostname}:${port}/`);
});
```
### Enabling CORS Preflight
Certain CORS requests are considered 'complex' and require an initial `OPTIONS` request (called the [preflight request][1]). An example of a 'complex' CORS request is one that uses an HTTP verb other than GET/HEAD/POST (such as DELETE) or that uses custom headers. To enable preflighting, you must add a new OPTIONS handler for the route you want to support.
# The default configuration
The default configuration is the equivalent of:
```json
{
"origin": "*",
"allowedMethods": "GET,HEAD,PUT,PATCH,POST,DELETE",
"preflightContinue": false,
"optionsSuccessStatus": 204
}
```
For details on the effect of each CORS header, read [this article on web.dev][2].
[1]: https://developer.mozilla.org/en-US/docs/Glossary/Preflight_request
[2]: https://web.dev/cross-origin-resource-sharing/