Skip to content

pine/is-lo

Repository files navigation

is-lo  npm build License

🔁 Check if it is a loopback network interface or not

Features

  • Supports TypeScript
  • Supports both CommonJS and ESModules

Getting Started

$ npm install --save is-lo # for npm users
$ yarn add is-lo           # for yarn users

Breaking Changes

There are breaking changes in v1.0.0. See the release note for more details.

Usage

ESModules

import os from 'node:os'
import { isLo } from 'is-lo'

const interfaces = os.networkInterfaces()
const names = Object.keys(interfaces)

console.log(isLo(interfaces[names[0]])) // true or false

CommonJS

const os = require('node:os')
const { isLo } = require('is-lo')

const interfaces = os.networkInterfaces()
const names = Object.keys(interfaces)

console.log(isLo(interfaces[names[0]])) // true or false

Reference

isLo({ family: 'IPv4', address: '127.0.0.1' })

isLo([ { family: 'IPv4', address: '127.0.0.1' }, ... ])

  • family (string): 'IPv4' or 'IPv6'
  • address (string): IP address
  • Result (bool): true if it is loopback network interface

Development

Test

$ yarn test

Publish

$ yarn publish

License

MIT © Pine Mizune

About

🔁 Check if it is a loopback network interface or not

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •