https://github.com/die-welle/output-host
A simple and convenient tool to output host for website developing.
https://github.com/die-welle/output-host
address convenient copy-paste host ip localhost nodejs terminal web-development
Last synced: about 1 month ago
JSON representation
A simple and convenient tool to output host for website developing.
- Host: GitHub
- URL: https://github.com/die-welle/output-host
- Owner: die-welle
- License: mit
- Created: 2016-01-07T08:39:44.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-28T05:52:04.000Z (over 8 years ago)
- Last Synced: 2025-02-25T07:41:58.861Z (over 1 year ago)
- Topics: address, convenient, copy-paste, host, ip, localhost, nodejs, terminal, web-development
- Language: JavaScript
- Homepage:
- Size: 42 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
output-host
=========================
A simple and convenient tool to output host for website developing.
## Motivation
When testing your website on mobile or other devices from LAN, you usually need to get your external server host (eg: http://192.168.1.123:3000), and then copy and paste it to your browser address bar, and share to other devices.
This tool makes these easily.
## Quick Start
#### outputHost([options])
```js
import outputHost from 'output-host';
import http from 'http';
const port = 3000;
const app = http.createServer();
app.listen(port, () => outputHost({
// Here's all options.
port: 3000, // Defaults to `3000`
host: 'localhost', // Host name. Defaults to 'localhost'
name: 'Server', // Prefix name. Defaults to 'Server'
protocol: 'http', // Defaults to `http`
local: true, // Enable to log localhost. Defaults to `true`
external: true, // Enable to log external host. Defaults to `true`
copy: true, // Enable to copy external host. So you could easy to paste to browser address bar. Defaults to `true`
color: true, // Enable color. Defaults to `true`
logger: console.log.bind(console), // Custom logger function. Defaults to `console.log.bind(console)`
launch: 'none', // Enable to auto launch browser. Value could be one of 'none', 'chrome' or 'firefox'. Defaults to 'none'
launchDelay: 2000, // Launch browser delay. Only work if `launch=chrome|firefox`. Defaults to `2000`
}));
// output:
//
// Server Local URL http://localhost:3000
// Server External URL http://192.168.1.123:3000
// `http://192.168.1.123:3000` would be added to clipboard automatically.
```
#### outputHost.curry([options, callback])
```js
app.listen(2333, outputHost.curry());
// output:
//
// Server Local URL http://localhost:2333
// Server External URL http://192.168.1.123:2333
```
#### cli
```bash
$ output-host -p 2333
# output:
#
# Server Local URL http://localhost:2333
# Server External URL http://192.168.1.123:2333
```
Please run `output-host -h` to learn more.
## Installation
Using [npm](https://www.npmjs.com/):
```bash
$ npm install output-host --save-dev
```
## License
MIT