Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lolo32/fastify-response-time
Add X-Response-Time header at each request (in ms) for Fastify
https://github.com/lolo32/fastify-response-time
fastify
Last synced: about 2 months ago
JSON representation
Add X-Response-Time header at each request (in ms) for Fastify
- Host: GitHub
- URL: https://github.com/lolo32/fastify-response-time
- Owner: lolo32
- Created: 2017-09-15T21:34:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-30T14:30:47.000Z (about 1 year ago)
- Last Synced: 2024-07-13T10:23:23.104Z (6 months ago)
- Topics: fastify
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 17
- Watchers: 4
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-fastify - `fastify-response-time` - Response-Time` header at each request for Fastify, in milliseconds. (<h2 align="center">Awesome Fastify</h2> / <h2 align="center">Ecosystem</h2>)
README
# fastify-response-time
[](https://travis-ci.org/lolo32/fastify-response-time)
[](https://coveralls.io/github/lolo32/fastify-response-time?branch=master)
[](https://snyk.io/test/github/lolo32/fastify-response-time)
Add `X-Response-Time` header at each request for Fastify. The unit used is milliseconds.
Add `Server-Timing` header, that could be used to pass timing server to client (useful to debug).
You could find some documentation at [W3C Server-Timing](https://www.w3.org/TR/server-timing/) documentation.
**You need to use Fastify version 0.31 or newer, the hook used (onSend) was added in this version**
_If you need older Fastify version, use version 1.0.1 of this plugin_
## Install
``
npm install --save fastify-response-time
``
## Usage
Add it to you project with `register` and you are done!
```javascript
// Register the plugin
fastify.register(require("fastify-response-time"));
// Define a new route in hapijs notation
fastify.route({
method: "GET",
url: "/header-hapi",
handler: (request, reply) => {
reply.send();
}
});
// Define a new route in express notation
fastify.get("/header-express", (request, reply) => {
reply.send();
});
// Add server timing information
fastify.get("/header-express", (request, reply) => {
reply.setServerTiming("cache", 5.3, "Cache read");
reply.send();
});
```
Both examples responds with:
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 17
< X-Response-Time: 0.08
< Date: Fri, 15 Sep 2017 21:14:33 GMT
< Connection: keep-alive
<
## Options
This plugin allow you to specify options:
- `header` can be used to change default header name to something else _(`X-Response-Time` by default)_
- `digits` to specify the number of digits in the response _(`2` by default, so 1.03)_
## `reply.setServerTiming` usage
`reply.setServerTiming( name , duration , description ) => boolean`
With:
* `name`: _[mandatory]_ the name of the measure, and must be unique. Any already existing value will not be replaced
* `duration`: _[optional]_ the duration, that must be an integer or float. If not needed, pass `0` or `null`
* `description`: _[optional]_ the description is needed. It must be a string
* return `true` if the measure is added the the list that will be send with the request, `false` is the name already
exists
The response will be:
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 17
< X-Response-Time: 0.08
< Server-Timing: cache;dur=5.3;desc="Cache read"
< Date: Fri, 15 Sep 2017 21:14:33 GMT
< Connection: keep-alive
<