@tadashi/local-access

    1.0.1 • Public • Published

    local-access CI codecov

    Retrieve formatted URL addresses for local and LAN access.

    Install

    $ npm install @tadashi/local-access
    

    Usage

    import localAccess from 'local-access'
    
    localAccess()
    //=> { local:'http://localhost:8080/', network:'http://10.0.0.3:8080/' }
    
    localAccess({ protocol:'https', port:3000 })
    //=> { local:'https://localhost:3000/', network:'https://10.0.0.3:3000/' }
    
    localAccess({ protocol:'ws', port:3000 })
    //=> { local:'ws://localhost:3000/', network:'ws://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 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

    Install

    npm i @tadashi/local-access

    DownloadsWeekly Downloads

    6

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    4.31 kB

    Total Files

    4

    Last publish

    Collaborators

    • lagden