Skip to content
This repository was archived by the owner on Aug 8, 2024. It is now read-only.

Commit d117167

Browse files
committed
improve README and change version to 0.8.0
1 parent ca0a7a4 commit d117167

File tree

3 files changed

+147
-93
lines changed

3 files changed

+147
-93
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A small library for [AWS Lambda](https://aws.amazon.com/lambda/details) providin
1010
## Features
1111

1212
* Easy Handling of [ANY method](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-add-http-method) in API Gateways
13-
* Simplifies writing lambda handlers (in nodejs)
13+
* Simplifies writing lambda handlers (in nodejs > 8)
1414
* Lambda Proxy Resource support for AWS API Gateway
1515
* Enable CORS for requests
1616
* No external dependencies
@@ -19,6 +19,7 @@ A small library for [AWS Lambda](https://aws.amazon.com/lambda/details) providin
1919
* SNS
2020
* SQS
2121
* S3
22+
* Compatibility with Typescript >= 3.5
2223

2324
## Installation
2425

@@ -106,7 +107,7 @@ export const handler = router.handler({
106107
proxyIntegration: {
107108
routes: [
108109
{
109-
path: '/save',
110+
path: '/saveExample',
110111
method: 'POST',
111112
// request.body needs type assertion, because it defaults to type unknown (user input should be checked):
112113
action: (request, context) => {
@@ -115,7 +116,7 @@ export const handler = router.handler({
115116
}
116117
},
117118
{
118-
path: '/save',
119+
path: '/saveExample2',
119120
method: 'POST',
120121
// it's also possible to set a type (no type check):
121122
action: (request: ProxyIntegrationEvent<{ text: string }>, context) => {
@@ -358,7 +359,7 @@ See here: https://yarnpkg.com/en/docs/cli/link
358359
359360
360361
## Release History
361-
* 0.7.2
362+
* 0.8.0
362363
* fix: changed ProxyIntegrationEvent body type to be generic but defaults to unknown
363364
* fix: changed @types/aws-lambda from devDependency to dependency
364365
* **breaking**: error response objects (thrown or rejected) now need to set `statusCode` instead of `status` (consistent with response)

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "aws-lambda-router",
3-
"version": "0.7.2",
3+
"version": "0.8.0",
44
"description": "AWS lambda router",
55
"main": "index.js",
66
"types": "index.d.ts",
@@ -30,12 +30,12 @@
3030
},
3131
"homepage": "https://github.com/spring-media/aws-lambda-router#readme",
3232
"devDependencies": {
33-
"@types/jest": "^24.0.25",
33+
"@types/jest": "^24.9.0",
3434
"@types/node": "^8.10.59",
35-
"codecov": "^3.6.1",
35+
"codecov": "^3.6.2",
3636
"jest": "24.9.0",
3737
"ts-jest": "24.2.0",
38-
"typescript": "3.7.4"
38+
"typescript": "3.7.5"
3939
},
4040
"dependencies": {
4141
"@types/aws-lambda": "^8.10.40"

0 commit comments

Comments
 (0)