running-at/src/index.js

Get local and network ip address

const os = require('os')
const defaultGateway = require('default-gateway')
const url = require('url')

/**
 * Prints local and network ip as url to console
 * @param {number | string | object} options - port or object containing options
 */
const print = function(options) {

	const result = runningAt(options)

	const indentation = options && options.indentation ? '   ' : ''

	console.log(indentation + 'Running at:')
	console.log(indentation + '- Local:   \x1b[34m%s\x1b[0m', result.local)
	if (result.network) console.log(indentation + '- Network: \x1b[34m%s\x1b[0m', result.network)

}

const getNetworkIp = function(name, family) {

	const interfaces = os.networkInterfaces()
	for (let i = -1; i < 8; i++) {
		const interfaceName = name + (i >= 0 ? i : '') // support 'lo' and 'lo0'
		const items = interfaces[interfaceName]
		if (items) {
			for (let j = 0; j < items.length; j++) {
				const item = items[j]
				if (item.family === family) {
					return item.address
				}
			}
		}
	}
	return

}

const getInterfaceName = function() {

	const result = defaultGateway.v4.sync()
	return result && result.interface

}

/**
 * Returns local and network ip as url
 * @param {number | string | object} options - port or object containing options
 * @returns {object} object containing ip, local and network
 */
const runningAt = function(options) {

	const defaultOptions = {
		port: 3000,
		protocol: 'http',
		host: 'localhost',
		pathname: '/',
		family: 'IPv4',
		interface: getInterfaceName(),
		getNetwork: true,
		indentation: false
	}

	if (typeof options === 'number' || typeof options === 'string') {
		options = Object.assign({}, defaultOptions, { port: options })
	} else {
		options = Object.assign({}, defaultOptions, options)
	}

	const formatUrl = (hostname) =>
		url.format({
			protocol: options.protocol,
			hostname: hostname,
			port: options.port,
			pathname: options.pathname
		})

	const networkIp = options.getNetwork ? getNetworkIp(options.interface, options.family) : undefined

	return {
		ip: networkIp,
		local: formatUrl(options.host),
		network: networkIp !== undefined ? formatUrl(networkIp) : undefined
	}

}

module.exports = runningAt
module.exports.print = print