# local-access

> Retrieve formatted URL addresses for local and LAN access.

Latest version **1.1.0** (published 2020-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install local-access
pnpm add local-access
yarn add local-access
bun add local-access
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-11-16 |
| First published | 2017-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Luke Edwards |
| Maintainers | lukeed |
| Keywords | ip, url, format, address, network, local, lan |

## Links

- npm: https://www.npmjs.com/package/local-access
- Repository: https://github.com/lukeed/local-access
- Homepage: https://github.com/lukeed/local-access#readme
- Issues: https://github.com/lukeed/local-access/issues
- npm.io page: https://npm.io/package/local-access

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-11-16
- 1.0.1 — 2018-04-19
- 1.0.0 — 2017-07-21

## README

# local-access [![CI](https://github.com/lukeed/local-access/workflows/CI/badge.svg)](https://github.com/lukeed/local-access/actions?query=workflow%3ACI) [![codecov](https://badgen.net/codecov/c/github/lukeed/local-access)](https://codecov.io/gh/lukeed/local-access)

> Retrieve formatted URL addresses for local and LAN access.


## Install

```
$ npm install local-access --save-dev
```


## Usage

```js
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`](https://nodejs.org/api/url.html#url_url_format_urlobject), which means its `options` are inherited.

#### options

Type: `Object`

A [`URL`](https://nodejs.org/api/url.html#url_the_whatwg_url_api) instance, or _any_ object with matching keys.

#### options.https

Type: `Boolean`<br>
Default: `false`

Shortcut for determining the `options.protocol` value.

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

#### options.hostname

Type: `String`<br>
Default: `'localhost'`

Same as [`urlObject.hostname`](https://nodejs.org/api/url.html#url_urlobject_hostname) -- added a default value.

#### options.port

Type: `Number` or `String`<br>
Default: `process.env.PORT || 8080`

Same as [`urlObject.port`](https://nodejs.org/api/url.html#url_urlobject_port) -- added a default value.


## License

MIT © [Luke Edwards](https://lukeed.com)

---
_Source: https://npm.io/package/local-access · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._