initial commit

node_modules/listhen/README.md

@@ -0,0 +1,168 @@
+![listhen](https://user-images.githubusercontent.com/904724/101662837-46845280-3a4a-11eb-9e9a-d5399e8af753.png)
+
+# 👂 listhen
+
+> Elegant http listener
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions][github-actions-src]][github-actions-href]
+[![Codecov][codecov-src]][codecov-href]
+
+✔️ 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](https://github.com/unjs/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](https://github.com/thedillonb/http-shutdown)
+
+## Install
+
+Install using npm or yarn:
+
+```bash
+npm i listhen
+# or
+yarn add listhen
+```
+
+Import into your Node.js project:
+
+```js
+// CommonJS
+const { listen } = require('listhen')
+
+// ESM
+import { listen } from 'listhen'
+```
+
+## Usage
+
+**Function signature:**
+
+```ts
+const { url, getURL, server, close } = await listen(handle, options?)
+```
+
+**Plain handle function:**
+
+```ts
+listen((_req, res) => {
+  res.end('hi')
+})
+```
+
+**With express/connect:**
+
+```ts
+const express = require('express')
+const app = express()
+
+app.use('/', ((_req, res) => {
+  res.end('hi')
+})
+
+listen(app)
+```
+
+## Options
+
+### `port`
+
+- Default: `process.env.PORT` or 3000 or memorized random (see [get-port-please](https://github.com/unjs/get-port-please))
+
+Port to listen.
+
+### `hostname`
+
+- Default: `process.env.HOST || '0.0.0.0'`
+
+Default hostname to listen.
+
+### `https`
+
+- Type: Boolean | Object
+- Default: `false`
+
+Listen on https with SSL enabled.
+
+#### Self Signed Certificate
+
+By setting `https: true`, listhen will use an auto generated self-signed certificate.
+
+You can set https to an object for custom options. Possible options:
+
+- `domains`: (Array) Default is `['localhost', '127.0.0.1', '::1']`.
+- `validityDays`: (Number) Default is `1`.
+
+#### User Provided Certificate
+
+Set `https: { cert, key }` where cert and key are path to the ssl certificates.
+
+You can also provide inline cert and key instead of reading from filesystem. In this case, they should start with `--`.
+
+### `showURL`
+
+- Default: `true` (force disabled on test environment)
+
+Show a CLI message for listening URL.
+
+### `baseURL`
+
+- Default: `/`
+
+### `open`
+
+- Default: `false` (force disabled on test and production environments)
+
+Open URL in browser. Silently ignores errors.
+
+### `clipboard`
+
+- Default: `false` (force disabled on test and production environments)
+
+Copy URL to clipboard. Silently ignores errors.
+
+### `isTest`
+
+- Default: `process.env.NODE_ENV === 'test'`
+
+Detect if running in a test environment to disable some features.
+
+### `autoClose`
+
+- Default: `true`
+
+Automatically close when an exit signal is received on process.
+
+## License
+
+MIT. Made with 💖
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/listhen?style=flat-square
+[npm-version-href]: https://npmjs.com/package/listhen
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/listhen?style=flat-square
+[npm-downloads-href]: https://npmjs.com/package/listhen
+
+[github-actions-src]: https://img.shields.io/github/workflow/status/unjs/listhen/ci/main?style=flat-square
+[github-actions-href]: https://github.com/unjs/listhen/actions?query=workflow%3Aci
+
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/listhen/main?style=flat-square
+[codecov-href]: https://codecov.io/gh/unjs/listhen