js-inet v0.2.0

js-inet

inet-aton, inet-ntoa implementations in javascript

Installation

Available on the npm public registry npm install js-inet yarn add js-inet

Notes

This implementation is written in pure TypeScript, and transpiled to JavaScript for distribution. The implementation is based on that found in FreeBSD, specifically the IPv6 functions inet_pton6() and inet_ntop6().

Examples

import * as inet from 'js-inet'
import {pton4, pton} from 'js-inet/pton'
import {ntop4, ntop} from 'js-inet/ntop'

/**
 * pton, pton4 converts a presentation format IP address to binary form,
 * in network byte order.
 *
 * The pton4 function will only work on IPv4 addresses, while pton function
 * will work on both.
 */
function pton4(addr: string): Buffer|null;
function pton(addr: string): Buffer|null;

inet.pton('127.0.0.1').toString('hex') // = 7F000001
inet.pton('256.0.0.1')                 // = null
inet.pton('::1').toString('hex')       // = 00000000000000000000000000000001

/**
 * ntop, ntop4 converts a network byte order binary form IP address into
 * presentation form.
 *
 * The ntop4 function will only work on IPv4 addresses, while ntop function
 * will work on both.
 */
function ntop4(addr: Buffer): string|null;
function ntop(addr: Buffer): string|null;

inet.ntop(Buffer.fromString('7F000001', 'hex')) // = 127.0.0.1

License

This library keeps the same license as the functions in the FreeBSD implementation, the ISC license. A copy can be found in LICENSE.txt