random-ipv6
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/random-ipv6 package

1.0.2 • Public • Published

random-ipv6

Return a random ipv6 address.

MIT License

build:? coverage:?

Install

$ npm install --save random-ipv6 

Usage

For more use-cases see the tests

var randomIpv6 = require('random-ipv6');
 
// API
// - randomIpv6(schema[, options]);
 
 
randomIpv6();
// => 2c56:9a76:aee6:3552:855a:f757:3611:255a
 
 
randomIpv6('127:0::{token}.1', {
    token: {
        min: 0,
        max: 65535
    }
});
// => 127.0.::f757.1
 
 
randomIpv6('{token}::1', {
    padded: true,
    token:{
        min: 0,
        max: 65535
    }
});
// => 0ee1::0001
 
 
randomIpv6('{token}:0:0:0:0:1:0:0', {
    compressed: true,
    token:{
        min: 0,
        max: 65535
    }
});
// => f07a::1:0:0

Note:

  • schema - the ipv6 schema, default '{token1}:{token2}:{token3}:{token4}:{token5}:{token6}:{token7}:{token8}'.
  • options - options for every token, each token has min and max option, which both are from 0 to 65535.
  • options.padded - pad prefix 0 with part when it's length less than 4.
  • options.compressed - compress the ipv6.

Related

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.

Package Sidebar

Install

npm i random-ipv6

Weekly Downloads

124

Version

1.0.2

License

MIT

Last publish

Collaborators

  • bubkoo