Elegant http listener
✔️ Promisified interface for listening and closing server
✔️ Works with express/connect or plain http handle function
✔️ Support HTTP and HTTPS
✔️ Automatically assign a port or fallback to human friendly alternative (with get-port-please)
✔️ Automatically generate listening URL and show on console
✔️ Automatically copy URL to clipboard
✔️ Automatically open in browser (opt-in)
✔️ Automatically generate self signed certificate
✔️ Automatically detect test and production environments
✔️ Automatically close on exit signal
✔️ Gracefully shutdown server with http-shutdown
Install using npm or yarn:
npm i listhen
# or
yarn add listhenImport into your Node.js project:
// CommonJS
const { listen } = require('listhen')
// ESM
import { listen } from 'listhen'Function signature:
const { url, getURL, server, close } = await listen(handle, options?)Plain handle function:
listen('/', ((_req, res) => {
res.end('hi')
})With express/connect:
const express = require('express')
const app = express()
app.use('/', ((_req, res) => {
res.end('hi')
})
listen(app)- Default:
process.env.PORTor 3000 or memorized random (see get-port-please)
Port to listen.
- Default:
false
Listen with https protocol. By default uses a self-signed certificated.
Path to https certificate files { key, cert }
Options for self-signed certificate (see selfsigned).
- Default:
true(force disabled on test environment)
Show a CLI message for listening URL.
- Default:
/
- Default:
false(force disabled on test and production environments)
Open URL in browser. Silently ignores errors.
- Default:
false(force disabled on test and production environments)
Copy URL to clipboard. Silently ignores errors.
- Default:
process.env.NODE_ENV === 'test'
Detect if running in a test environment to disable some features.
- Default:
true
Automatically close when an exit signal is received on process.
MIT. Made with 💖