npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@toisu/timings

v2.0.0

Published

A Toisu! middleware to add a convenience interface for creating server-timing headers on responses.

Downloads

4

Readme

toisu-timings

The timings middleware provides an interface for building a "Server-Timing" header, which can be used to communicate durations local to the server to a browser when responding to a request (for example, timing making database queries etc.) Browsers render this information in the devtools network panel. See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing

Usage

import { createServer } from 'http';
import { setTimeout } from 'timers/promises';
import Toisu from '@toisu/toisu';
import makeTimings from '@toisu/timings';

const app = new Toisu();

// Serve the "public" directory (relative to the app root).
app.use(makeTimings());
app.use(async function (req, res) {
  const delay = Math.random() * 1000;
  await setTimeout(delay);
  this.timing({ name: 'delay', description: 'a random delay', duration: delay });
  res.writeHead(204).end();
});

createServer(app.requestHandler).listen(3000);

API

Place app.use(makeTimings()); early in the set of middlewares your application uses. Any subsequent middlewares will have access to the this.timing function.

this.timing

Since timing is appended to the toisu request-response context, middlewares which use it must be plain synchronous or asynchronous functions. In other words, you must not use an arrow function.

this.timing is a function which takes an object with the fields:

| field | required | description | | ----- | -------- | ----------- | | name | true | The name of the metric. | | description | false | An optional string to describe the metric. Should be short! | | duration | false | An optional number of milliseconds. |

Limitations

The (optional) description field can be any "quoted-string". However, since the server-timing spec encourages short descriptions (or none at all), the characters in the description are limited to ascii word characters, the ascii space character, and horizontal tabs. Other characters are filtered out.

Server timing header values could be collected into a comma separated list. In order to avoid complexity and headers too long for proxy servers to handle, each timing is sent in its own header by this library.

The server-timings spec allows timings to be appended to the end of a response as trailing headers. This package does not support trailing headers, but since timings can be added in any middleware it's anticipated that they'll rarely be needed. One case in which they might be is when a body is streamed.