{"_id":"local-access","_rev":"5-8a021fa71da1a701c6986f7fe504398b","name":"local-access","description":"Retrieve formatted URL addresses for local and LAN access.","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"local-access","version":"1.0.0","description":"Retrieve formatted URL addresses for local and LAN access.","repository":{"type":"git","url":"git+https://github.com/lukeed/local-access.git"},"license":"MIT","author":{"name":"Luke Edwards","email":"luke.edwards05@gmail.com","url":"lukeed.com"},"engines":{"node":">=6"},"scripts":{"test":"tape test/*.js | tap-spec"},"files":["index.js"],"keywords":["ip","url","format","address","network","local","lan"],"dependencies":{"ip":"^1.1.5"},"devDependencies":{"tap-spec":"^4.1.1","tape":"^4.7.0"},"gitHead":"dce87ce13aff6c8460df11e8ab7480425d6cdbb0","bugs":{"url":"https://github.com/lukeed/local-access/issues"},"homepage":"https://github.com/lukeed/local-access#readme","_id":"local-access@1.0.0","_shasum":"f8b4fb2eb2da1e21fdfb58122ddd29dd61421125","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.11.1","_npmUser":{"name":"lukeed","email":"luke@lukeed.com"},"dist":{"shasum":"f8b4fb2eb2da1e21fdfb58122ddd29dd61421125","tarball":"https://registry.npmjs.org/local-access/-/local-access-1.0.0.tgz","integrity":"sha512-Z43xibcSyDCD2Zr9X3B20hfQiy7/rrqV7u7yfLrUoJXOqjyda9Kjz4BlvT5IxfGCD+04zD51sV5k2D2X9mz02g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCEJrsVh9i7NI7LC8la1mmrGBNWXMXxo+8Euc79N87a9gIgVPn74fx9RxfEdPm+ugxL9e4DD/1Qi1/Vms37AYDo9Ew="}]},"maintainers":[{"name":"lukeed","email":"luke@lukeed.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/local-access-1.0.0.tgz_1500669277639_0.355718917446211"},"directories":{}},"1.0.1":{"name":"local-access","version":"1.0.1","description":"Retrieve formatted URL addresses for local and LAN access.","repository":{"type":"git","url":"git+https://github.com/lukeed/local-access.git"},"license":"MIT","author":{"name":"Luke Edwards","email":"luke.edwards05@gmail.com","url":"lukeed.com"},"engines":{"node":">=6"},"scripts":{"test":"tape test/*.js | tap-spec"},"files":["index.js"],"keywords":["ip","url","format","address","network","local","lan"],"devDependencies":{"tap-spec":"^4.1.1","tape":"^4.7.0"},"gitHead":"7c3390efb3d2deb9cf82b8ac85526243f56ccc62","bugs":{"url":"https://github.com/lukeed/local-access/issues"},"homepage":"https://github.com/lukeed/local-access#readme","_id":"local-access@1.0.1","_npmVersion":"5.5.1","_nodeVersion":"8.9.0","_npmUser":{"name":"lukeed","email":"luke@lukeed.com"},"dist":{"integrity":"sha512-ykt2pgN0aqIy6KQC1CqdWTWkmUwNgaOS6dcpHVjyBJONA+Xi7AtSB1vuxC/U/0tjIP3wcRudwQk1YYzUvzk2bA==","shasum":"5121258146d64e869046c642ea4f1dd39ff942bb","tarball":"https://registry.npmjs.org/local-access/-/local-access-1.0.1.tgz","fileCount":4,"unpackedSize":3931,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa2CWhCRA9TVsSAnZWagAASBQP/1AJnYyDbinaPB8tAq7j\nehukzCL1lmHzBTdtVy0uV+VYP7XDBY/UjajgctDArBpEvv5wGINaMKLm8/HY\nXoniOYYPxi92VO7h5sggy1+uP0G8kLKacC5s3NtNJWMSgMFM8mEhHJrayfyE\nLhDth9247AKcSBcMFicuooGggfVZTAnP6LGqikcthrUVEoM+FWk0n/LiDsQJ\nTBRkMwWCoEJs0cRnO+SONFdS1FwoubgRsu8P58/A4JlUldtWzxfucg9lIDD/\nLno4lnc60jFdRNKFOuDD4uFbaxlJt5r2XlxmRBSeBxA2Okz/FGsIwXKlmCcX\nn40kAGd80z2RVobowi4sru2iybYOpmhdlxXgPlHOLliV4LwX54q9cKcQXwZT\nVxgv+gOiM+tgodW7I12S0iFhKLtEyHRzTyqeim2dj0dDLYviooir/KdAgetU\n4stMn2mRRG7rkqXIwhwA6oEInITwyAiB5yvdLAZMfLX6A5j9/lFC45pvjhI2\nCMWYsPBMp2llVlWdopDXpoLtuSPBEkMm6uh87OwQgINA/eHdSc4GKGtSteNK\nGsJrHo3jF25NFeJmZNFkMM37l1mAq3zFb3dzScermfBXvVFALhsAH+Gb5UVY\nnndHw9krkeaz6ePpqttGSAUeYotMHC866kUGjgUkXNXJLaENwkyq4qOT5MG5\nbhIq\r\n=tkkT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHQ1BNGMq+yQJLMZRG9IwsiGDEuIF+PXfPyXon+ogPH+AiEAynckV5RUUeO+sAsj/SbuuJ6IJRb0PK0qQohpVyey/uM="}]},"maintainers":[{"name":"lukeed","email":"luke@lukeed.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/local-access_1.0.1_1524114849242_0.17553280733868837"},"_hasShrinkwrap":false},"1.1.0":{"version":"1.1.0","name":"local-access","repository":{"type":"git","url":"git+https://github.com/lukeed/local-access.git"},"description":"Retrieve formatted URL addresses for local and LAN access.","module":"index.mjs","types":"index.d.ts","main":"index.js","license":"MIT","author":{"name":"Luke Edwards","email":"luke.edwards05@gmail.com","url":"https://lukeed.com"},"engines":{"node":">=6"},"scripts":{"build":"bundt","test":"uvu -r esm test"},"keywords":["ip","url","format","address","network","local","lan"],"devDependencies":{"bundt":"1.1.1","esm":"3.2.25","uvu":"0.4.1"},"gitHead":"05c724f6923647cf768fd8cb1431cdb6b903ef26","bugs":{"url":"https://github.com/lukeed/local-access/issues"},"homepage":"https://github.com/lukeed/local-access#readme","_id":"local-access@1.1.0","_nodeVersion":"12.18.4","_npmVersion":"6.14.6","dist":{"integrity":"sha512-XfegD5pyTAfb+GY6chk283Ox5z8WexG56OvM06RWLpAc/UHozO8X6xAxEkIitZOtsSMM1Yr3DkHgW5W+onLhCw==","shasum":"e007c76ba2ca83d5877ba1a125fc8dfe23ba4798","tarball":"https://registry.npmjs.org/local-access/-/local-access-1.1.0.tgz","fileCount":6,"unpackedSize":4960,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfsupuCRA9TVsSAnZWagAAn+wP/izL06qpheKflPQT/B5N\nktLWItcvFq4it/XitQz+YeLDX4PLFEF88wSysG66wCvaNZuIcqJlVtdADQSV\n+4PretBywl7N0krqzrUkOV3Ig3FvioOUeWiAkb3T1N0M5yN/Oa5mXkK7OAU3\nlF8Acd1R+OlnIpxhH2L4yPLfTE/KiXh2Gw+fWGx6VVrCYTNxzUALgipqlOY3\nv0JolAukgE31+Sgw68lAUCs6Tpmp5HvNQHpqDUHPROUFpEZXMrT2m8hOAG44\n79eTLXPjhSEsLgeiQ2yRvlBLnCbwU/wkNoFK+h5sdLPxlv8N6yenCp4GAm3U\nTjGHhmosUvnwSYofOvDraW1xVDVWgHhPYq0BNPlTHnZgQ5QDZg0PB9dpJAw5\nzKtv9W9Tk4+qNYEWhpdAngvc6vkkOxfnllhg/GHM8dwmQauWesi8/Mojbf+e\nQGwu2irh4JBbEztvseO+/lw4WhfeZZQk93+2yg/EjiGkTZ/53r5uPeGNQq6b\ngbex2BaYgnysAdcoPioZ8RwJSqjLqVWKZ8gCCHSxt+EMQFpUib2FoxDbH8DE\nIp5S/LZbDU/iYavv9hHEUOYX+j8p2z75y1wdzROr5cDM0zsNe8EgCgGmdtQs\ngLubAitds2cZ5qlsD2BDL5CCLdK/MpGFe7KbOko+1N/AQPoWo1EyY2Mrz8Pn\nX28x\r\n=kZvd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIE3KCqc/AtlQL5/+k5QDevCHAh7aZ1tenj+YTbx2dxwXAiEAwv/+BIhbY5w2w0vmHp3KLy7vJOWO/5sIzPJl2H2Q2k8="}]},"_npmUser":{"name":"lukeed","email":"luke@lukeed.com"},"directories":{},"maintainers":[{"name":"lukeed","email":"luke@lukeed.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/local-access_1.1.0_1605560942072_0.45365664207049083"},"_hasShrinkwrap":false}},"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)\n\n> Retrieve formatted URL addresses for local and LAN access.\n\n\n## Install\n\n```\n$ npm install local-access --save-dev\n```\n\n\n## Usage\n\n```js\nimport localAccess from 'local-access';\n// or\nconst localAccess = require('local-access');\n\nlocalAccess();\n//=> { local:'http://localhost:8080', network:'http://10.0.0.3:8080' }\n\nlocalAccess({ https:true, port:3000 });\n//=> { local:'https://localhost:3000', network:'https://10.0.0.3:3000' }\n\nlocalAccess({ pathname:'foo/bar' });\n//=> { local:'http://localhost:8080/foo/bar', network:'http://10.0.0.3:8080/foo/bar' }\n```\n\n\n## API\n\n### localAccess(options)\n\nParsing and formatting is controlled by [`url.format`](https://nodejs.org/api/url.html#url_url_format_urlobject), which means its `options` are inherited.\n\n#### options\n\nType: `Object`\n\nA [`URL`](https://nodejs.org/api/url.html#url_the_whatwg_url_api) instance, or _any_ object with matching keys.\n\n#### options.https\n\nType: `Boolean`
\nDefault: `false`\n\nShortcut for determining the `options.protocol` value.\n\n> **Note:** This is the only config value unique to `local-access`!\n\n#### options.hostname\n\nType: `String`
\nDefault: `'localhost'`\n\nSame as [`urlObject.hostname`](https://nodejs.org/api/url.html#url_urlobject_hostname) -- added a default value.\n\n#### options.port\n\nType: `Number` or `String`
\nDefault: `process.env.PORT || 8080`\n\nSame as [`urlObject.port`](https://nodejs.org/api/url.html#url_urlobject_port) -- added a default value.\n\n\n## License\n\nMIT © [Luke Edwards](https://lukeed.com)\n","maintainers":[{"name":"lukeed","email":"luke@lukeed.com"}],"time":{"modified":"2022-06-19T13:16:32.352Z","created":"2017-07-21T20:34:37.712Z","1.0.0":"2017-07-21T20:34:37.712Z","1.0.1":"2018-04-19T05:14:09.348Z","1.1.0":"2020-11-16T21:09:02.305Z"},"homepage":"https://github.com/lukeed/local-access#readme","keywords":["ip","url","format","address","network","local","lan"],"repository":{"type":"git","url":"git+https://github.com/lukeed/local-access.git"},"author":{"name":"Luke Edwards","email":"luke.edwards05@gmail.com","url":"https://lukeed.com"},"bugs":{"url":"https://github.com/lukeed/local-access/issues"},"license":"MIT","readmeFilename":"readme.md"}