npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

running-at

v0.3.22

Published

Get local and network ip address

Downloads

333

Readme

running-at

Test Coverage Status GitHub David npm

Get/Print local and network IP address

preview

👋 Introduction

running-at returns (or directly prints) your current local and network ip address. This is useful if you want to know the address your server is running at.

🚀 Get started

Install running-at via npm:

npm install running-at

📚 Usage

const runningAt = require('running-at')

runningAt()

Will return:

{
    ip: "192.168.2.115",
    local: "http://localhost:3000/",
    network: "http://192.168.2.115:3000/"
}

Or run it like this:

const runningAt = require('running-at')

runningAt.print()

to directly print the URLs to the console:

Running at:
- Local:   http://localhost:3000/
- Network: http://192.168.2.115:3000/

⚙️ Options

You can change the behaviour of running-at by passing an options object to runningAt() or runningAt.print():

const options = {
    port: 8080, // default: '3000'
    protocol: 'https', // default: 'http'
    host: '127.0.0.1', // default: 'localhost'
    pathname: '/app', // default: '/'
    family: 'IPv6', // default: 'IPv4'
    interface: 'wlan0', // default: 'prefered interface'
    getNetwork: false, // default: true,
    indentation: true // default: false
}

runningAt()

// or runningAt.print()

If you only want to specify the port, you can directly pass it as a parameter:

runningAt.print(8080) // Will use 8080 as port

use process.env.PORT for your server and then just pass it in here

🛠️ Example

Use running-at in an Express app:

const runningAt = require('running-at')
const express = require('express')
const app = express()
const port = 3000

app.get('/', (req, res) => {
  res.send('Hello World!')
})

app.listen(port, () => {
  runningAt.print(port)
})

After the app has started, it will print:

Running at:
- Local:   http://localhost:3000/
- Network: http://192.168.2.115:3000/

💻 Development

Issues and PRs are very welcome!

Run yarn lint or npm run lint to lint the project and run yarn test or npm run test to run all unit tests.

❔ About

This library was developed by me (@betahuhn) in my free time. If you want to support me:

Donate via PayPal

Credits

The library was inspired by how the vue cli prints the local and network address when you run vue-cli-service serve.

License

Copyright 2020 Maximilian Schiller

This project is licensed under the MIT License - see the LICENSE file for details.