@tadashi/local-access

Retrieve formatted URL addresses for local and LAN access.

Install

$ npm install @tadashi/local-access

Usage

import la from '@tadashi/local-access'

la()
//=> { local:'http://localhost:8080/', network:'http://10.0.0.3:8080/' }

la({ protocol:'https', port:3000 })
//=> { local:'https://localhost:3000/', network:'https://10.0.0.3:3000/' }

la({ protocol:'ws', port:3000 })
//=> { local:'ws://localhost:3000/', network:'ws://10.0.0.3:3000/' }

la({ pathname:'foo/bar' })
//=> { local:'http://localhost:8080/foo/bar', network:'http://10.0.0.3:8080/foo/bar' }

API

localAccess(options)

Parsing and formatting is controlled by WHATWG URL API, which means its options are inherited.

options

Type: Object

A URL instance, or any object with matching keys.

options.protocol

Type: String
Default: http

Same as urlObject.protocol -- added a default value.

options.hostname

Type: String
Default: 'localhost'

Same as urlObject.hostname -- added a default value.

options.port

Type: Number or String
Default: process.env.PORT || 8080

Same as urlObject.port -- added a default value.

License

MIT © Luke Edwards
MIT © Thiago Lagden