JSPM

local-access

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 48861
  • Score
    100M100P100Q141549F
  • License MIT

Retrieve formatted URL addresses for local and LAN access.

Package Exports

  • local-access

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (local-access) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

local-access CI codecov

Retrieve formatted URL addresses for local and LAN access.

Install

$ npm install local-access --save-dev

Usage

import localAccess from 'local-access';
// or
const localAccess = require('local-access');

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

localAccess({ https:true, port:3000 });
//=> { local:'https://localhost:3000', network:'https://10.0.0.3:3000' }

localAccess({ 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 url.format, which means its options are inherited.

options

Type: Object

A URL instance, or any object with matching keys.

options.https

Type: Boolean
Default: false

Shortcut for determining the options.protocol value.

Note: This is the only config value unique to local-access!

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