Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@middy/http-cors
Advanced tools
@middy/http-cors - npm Package Compare versions
Comparing version 4.0.0 to 4.0.1
| { | ||
| "name": "@middy/http-cors", | ||
| "version": "4.0.0", | ||
| "version": "4.0.1", | ||
| "description": "CORS (Cross-Origin Resource Sharing) middleware for the middy framework", | ||
@@ -63,9 +63,9 @@ "type": "module", | ||
| "homepage": "https://middy.js.org", | ||
| "gitHead": "582286144bcd79968a8c7c2f8867a23c80079a47", | ||
| "gitHead": "c5ece2bfbb0d607dcdea5685bf194a6cc19acc8d", | ||
| "dependencies": { | ||
| "@middy/util": "4.0.0" | ||
| "@middy/util": "4.0.1" | ||
| }, | ||
| "devDependencies": { | ||
| "@middy/core": "4.0.0" | ||
| "@middy/core": "4.0.1" | ||
| } | ||
| } |
@@ -39,80 +39,2 @@ <div align="center"> | ||
| This middleware sets HTTP CORS headers (`Access-Control-Allow-Origin`, `Access-Control-Allow-Headers`, `Access-Control-Allow-Credentials`), necessary for making cross-origin requests, to the response object. | ||
| Sets headers in `after` and `onError` phases. | ||
| ## Install | ||
| To install this middleware you can use NPM: | ||
| ```bash | ||
| npm install --save @middy/http-cors | ||
| ``` | ||
| ## Options | ||
| - `credentials` (boolean) (default `undefined`): if true, sets `Access-Control-Allow-Credentials` | ||
| - `headers` (string) (default `undefined`): value to put in `Access-Control-Allow-Headers` | ||
| - `methods` (string) (default `undefined`): value to put in `Access-Control-Allow-Methods` | ||
| - `getOrigin` (function(incomingOrigin:string, options)): take full control of the generating the returned origin. Defaults to using the origin or origins option. | ||
| - `origin` (string) (default `'*'`): origin to put in the header | ||
| - `origins` (array) (default `[]`): An array of allowed origins. The incoming origin is matched against the list and is returned if present. | ||
| - `exposeHeaders` (string) (default `undefined`): value to put in `Access-Control-Expose-Headers` | ||
| - `maxAge` (string) (default `undefined`): value to put in `Access-Control-Max-Age` header | ||
| - `requestHeaders` (string) (default `undefined`): value to put in `Access-Control-Request-Headers` | ||
| - `requestMethods` (string) (default `undefined`): value to put in `Access-Control-Request-Methods` | ||
| - `cacheControl` (string) (default `undefined`): value to put in `Cache-Control header` on pre-flight (OPTIONS) requests | ||
| - `vary` (string) (default `undefined`): value to put in `Vary`, will set to `Origin` if `Access-Control-Allow-Origin` is not `*` and option unset. | ||
| ```javascript | ||
| import middy from '@middy/core' | ||
| import httpErrorHandler from '@middy/http-error-handler' | ||
| import cors from '@middy/http-cors' | ||
| const handler = middy((event, context) => { | ||
| throw new createError.UnprocessableEntity() | ||
| }) | ||
| handler.use(httpErrorHandler()) | ||
| .use(cors()) | ||
| // when Lambda runs the handler... | ||
| handler({}, {}, (_, response) => { | ||
| t.is(response.headers['Access-Control-Allow-Origin'],'*') | ||
| t.deepEqual(response,{ | ||
| statusCode: 422, | ||
| body: 'Unprocessable Entity' | ||
| }) | ||
| }) | ||
| ``` | ||
| ## Sample usage | ||
| ```javascript | ||
| import middy from '@middy/core' | ||
| import cors from '@middy/http-cors' | ||
| const handler = middy((event, context) => { | ||
| return {} | ||
| }) | ||
| handler.use(cors()) | ||
| // when Lambda runs the handler... | ||
| handler({}, {}, (_, response) => { | ||
| t.is(response.headers['Access-Control-Allow-Origin'],'*') | ||
| }) | ||
| ``` | ||
| ## Middy documentation and examples | ||
| For more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org). | ||
| ## Contributing | ||
| Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls). | ||
| ## License | ||
@@ -119,0 +41,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-17.32%
14153
- Number of lines in readme file
- decreased by-62.9%
46
Dependency changes
+ Added@middy/util@4.0.1(transitive)
- Removed@middy/util@4.0.0(transitive)
Updated@middy/util@4.0.1