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

express-as-promise

v2.0.1

Published

Simple Promise wrapper for Express

Downloads

1,332

Readme

express-as-promise

build status npm version

ExpressAsPromise is a simple Promise wrapper for Express. It also adds some convenient methods & properties which are especially useful for testing.

Usage

The package returns a class. Instances can be created without any options. The actual express object is available as .app property. The methods .listen and .stop start and stop the listener. The .url property contains a string to the base URL.

Methods

  • async fetch(url, options): Makes a request with node-fetch to the express server. The url is expanded using the servers base URL. If the server isn't listening yet, the server starts listening on a random port.
  • async listen(port, host): Forwards the optional port and host parameters to express method. Returns the base URL as string.
  • async stop(): Stops the listener.

Properties

  • .app: The actual express object.
  • .url: The base URL of the listener.

withServer

The withServer function can be imported from express-as-promise/withServer.js. It creates a server instance and hands it over to an async callback function. Once the callback function finished with resolve or reject, it stops the server and forwards the error if it finished with reject. This function is intended for testing using a pattern like shown in the examples below.

Examples

Simple example which adds one route, starts the server, write the base URL to the console and waits 10s before it stops the server.

import { setTimeout } from 'node:timers/promises'
import ExpressAsPromise from 'express-as-promise'

async function main () {
  // creates a new instance which also creates an express object
  const server = new ExpressAsPromise()

  server.app.get('/', (req, res) => {
    res.send('Hello World!')
  })

  // starts the listener and writes the base URL to the console
  console.log(await server.listen())

  // wait 10s...
  await setTimeout(10000)

  // ...then stop the server
  await server.stop()
}

main()

The following example starts a server with withServer, adds a route, makes a request. Once the function is finished, the server is automatically stopped.

import withServer from 'express-as-promise/withServer.js'

async function main () {
  await withServer(async server => {
    server.app.get('/test', (req, res) => {
      res.end('test response')
    })

    const res = await server.fetch('/test')
    const content = await res.text()

    console.log(content)
  })
}

main()