Skip to content

Commit d5afb3f

Browse files
committed
rename also in readme #110
1 parent d14c185 commit d5afb3f

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Introduction
22

33
![CI](https://github.com/fastify/aws-lambda-fastify/workflows/CI/badge.svg)
4-
[![NPM version](https://img.shields.io/npm/v/aws-lambda-fastify.svg?style=flat)](https://www.npmjs.com/package/aws-lambda-fastify)
4+
[![NPM version](https://img.shields.io/npm/v/@fastify/aws-lambda.svg?style=flat)](https://www.npmjs.com/package/@fastify/aws-lambda)
55
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
66

77
Inspired by the AWSLABS [aws-serverless-express](https://github.com/awslabs/aws-serverless-express) library tailor made for the [Fastify](https://www.fastify.io/) web framework.
@@ -13,12 +13,12 @@ Inspired by the AWSLABS [aws-serverless-express](https://github.com/awslabs/aws-
1313
## 👨🏻‍💻Installation
1414

1515
```bash
16-
$ npm install aws-lambda-fastify
16+
$ npm install @fastify/aws-lambda
1717
```
1818

1919
## Options
2020

21-
**aws-lambda-fastify** can take options by passing them with : `awsLambdaFastify(app, options)`
21+
**@fastify/aws-lambda** can take options by passing them with : `awsLambdaFastify(app, options)`
2222

2323
| property | description | default value |
2424
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
@@ -33,7 +33,7 @@ $ npm install aws-lambda-fastify
3333
### lambda.js
3434

3535
```js
36-
const awsLambdaFastify = require('aws-lambda-fastify')
36+
const awsLambdaFastify = require('@fastify/aws-lambda')
3737
const app = require('./app')
3838

3939
const proxy = awsLambdaFastify(app)
@@ -110,7 +110,7 @@ Since [AWS Lambda now enables the use of ECMAScript (ES) modules](https://aws.am
110110
We can use this by calling the [`fastify.ready()`](https://www.fastify.io/docs/latest/Reference/Server/#ready) function outside of the Lambda handler function, like this:
111111

112112
```js
113-
import awsLambdaFastify from 'aws-lambda-fastify'
113+
import awsLambdaFastify from '@fastify/aws-lambda'
114114
import app from './app.js'
115115
export const handler = awsLambdaFastify(app)
116116
await app.ready() // needs to be placed after awsLambdaFastify call because of the decoration: https://github.com/fastify/aws-lambda-fastify/blob/master/index.js#L9
@@ -121,19 +121,19 @@ await app.ready() // needs to be placed after awsLambdaFastify call because of t
121121

122122
## ⚡️Some basic performance metrics
123123

124-
**aws-lambda-fastify (decorateRequest : false)** x **56,892 ops/sec** ±3.73% (79 runs sampled)
124+
**@fastify/aws-lambda (decorateRequest : false)** x **56,892 ops/sec** ±3.73% (79 runs sampled)
125125

126-
**aws-lambda-fastify** x **56,571 ops/sec** ±3.52% (82 runs sampled)
126+
**@fastify/aws-lambda** x **56,571 ops/sec** ±3.52% (82 runs sampled)
127127

128-
**aws-lambda-fastify (serializeLambdaArguments : true)** x **56,499 ops/sec** ±3.56% (76 runs sampled)
128+
**@fastify/aws-lambda (serializeLambdaArguments : true)** x **56,499 ops/sec** ±3.56% (76 runs sampled)
129129

130130
**[serverless-http](https://github.com/dougmoscrop/serverless-http)** x **45,867 ops/sec** ±4.42% (83 runs sampled)
131131

132132
**[aws-serverless-fastify](https://github.com/benMain/aws-serverless-fastify)** x **17,937 ops/sec** ±1.83% (86 runs sampled)
133133

134134
**[aws-serverless-express](https://github.com/awslabs/aws-serverless-express)** x **16,647 ops/sec** ±2.88% (87 runs sampled)
135135

136-
Fastest is **aws-lambda-fastify (decorateRequest : false), aws-lambda-fastify**
136+
Fastest is **@fastify/aws-lambda (decorateRequest : false), @fastify/aws-lambda**
137137

138138
#### ⚠️Considerations
139139

@@ -146,13 +146,13 @@ Fastest is **aws-lambda-fastify (decorateRequest : false), aws-lambda-fastify**
146146
#### 🎖Who is using it?
147147

148148
<a href="https://locize.com" target="_blank" rel="nofollow">
149-
<img style="max-height: 80px;" src="https://raw.githubusercontent.com/fastify/aws-lambda-fastify/master/images/logos/locize.png" alt="locize is using aws-lambda-fastify"/>
149+
<img style="max-height: 80px;" src="https://raw.githubusercontent.com/fastify/aws-lambda-fastify/master/images/logos/locize.png" alt="locize is using @fastify/aws-lambda"/>
150150
</a>
151151
<br />
152152
<a href="https://localistars.com" target="_blank" rel="nofollow">
153-
<img style="max-height: 80px;" src="https://raw.githubusercontent.com/fastify/aws-lambda-fastify/master/images/logos/localistars.png" alt="localistars is using aws-lambda-fastify"/>
153+
<img style="max-height: 80px;" src="https://raw.githubusercontent.com/fastify/aws-lambda-fastify/master/images/logos/localistars.png" alt="localistars is using @fastify/aws-lambda"/>
154154
</a>
155155

156156
---
157157
<small>The logos displayed in this page are property of the respective organisations and they are
158-
not distributed under the same license as aws-lambda-fastify (MIT).</small>
158+
not distributed under the same license as @fastify/aws-lambda (MIT).</small>

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@
3535
"performance": "npm run lint && node performanceTest/test"
3636
},
3737
"devDependencies": {
38-
"@types/aws-lambda": "8.10.97",
38+
"@types/aws-lambda": "8.10.98",
3939
"aws-lambda": "^1.0.7",
4040
"aws-serverless-express": "^3.4.0",
4141
"aws-serverless-fastify": "^1.0.28",
4242
"benchmark": "^2.1.4",
43-
"eslint": "^8.16.0",
43+
"eslint": "^8.17.0",
4444
"eslint-config-standard": "^17.0.0",
4545
"eslint-plugin-import": "^2.26.0",
46-
"eslint-plugin-n": "^15.2.0",
46+
"eslint-plugin-n": "^15.2.1",
4747
"eslint-plugin-promise": "^6.0.0",
4848
"eslint-plugin-standard": "^5.0.0",
4949
"fastify": "^4.0.0-rc.3",

performanceTest/test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const event = {
1010
queryStringParameters: ''
1111
}
1212

13-
// aws-lambda-fastify stuff:
13+
// @fastify/aws-lambda stuff:
1414
const awsLambdaFastify = require('../index')
1515
const appAwsLambdaFastify = fastify()
1616
appAwsLambdaFastify.get('/test', async () => ({ hello: 'world' }))

0 commit comments

Comments
 (0)