whitequark / ipaddr.js

IP address manipulation library in JavaScript
MIT License
570 stars 92 forks source link

Using `subnetMatch` in TypeScript? #170

Open Manouchehri opened 10 months ago

Manouchehri commented 10 months ago

Related to #94. The example given does not work for me:

const rangeList = {
  documentationOnly: [ ipaddr.parse('2001:db8::'), 32 ],
  tunnelProviders: [
    [ ipaddr.parse('2001:470::'), 32 ], // he.net
    [ ipaddr.parse('2001:5c0::'), 32 ]  // freenet6
  ]
};
ipaddr.subnetMatch(ipaddr.parse('2001:470:8:66::1'), rangeList, 'unknown'); // => "tunnelProviders"

But.. This works:

const rangeList: {
  documentationOnly: [ipaddr.IPv6|ipaddr.IPv4, number];
  tunnelProviders: [ipaddr.IPv6|ipaddr.IPv4, number][];
} = {
  documentationOnly: [ipaddr.parse('2001:db8::'), 32],
  tunnelProviders: [
    [ipaddr.parse('2001:470::'), 32], // he.net
    [ipaddr.parse('2001:5c0::'), 32]  // freenet6
  ]
};

ipaddr.subnetMatch(ipaddr.parse('2001:470:8:66::1'), rangeList, 'unknown'); // => "tunnelProviders"       

I'm not really sure if this is the cleanest solution. Also, it isn't copy/pastable for those using JavaScript instead of TypeScript.

Manouchehri commented 10 months ago

Ah, found a clean solution!

const rangeList = {
  documentationOnly: ipaddr.parseCIDR('2001:db8::/32'),
  tunnelProviders: [
    ipaddr.parseCIDR("2001:470::/32"), // he.net
    ipaddr.parseCIDR("2001:5c0::/32") // freenet6
  ]
};

ipaddr.subnetMatch(ipaddr.parse('2001:470:8:66::1'), rangeList, 'unknown'); // => "tunnelProviders"