ip-set
v2.2.0
Published
Efficient mutable set for IP addresses
Downloads
16,781
Readme
ip-set
IP Address Set
Efficient mutable set data structure optimized for use with IPv4 and IPv6 addresses. The primary use case is for working with potentially large IP blacklists.
Works in the browser with browserify! This module is used by WebTorrent.
install
npm install ip-set
usage
const IPSet = require('ip-set')
const ipSet = new IPSet(/* optionally pass an array of IP addresses to seed the set with */)
ipSet.add(exampleBlockedIP1)
ipSet.add(exampleBlockedIP2)
let isBlocked = ipSet.contains(exampleBlockedIP2) // isBlocked will be true
CIDR ip's are also supported
ipSet.add(`192.168.1.0/24`);
let isBlockedInList = ipSet.contains('192.168.1.0');// isBlockedInList will be true
isBlockedInList = ipSet.contains('192.168.1.255');// isBlockedInList will be true
todo
(prioritized highest to lowest)
- [x] Port IPv4 implementation from
torrent-stream
- [x] Add basic tests
- [x] Support CIDR notation
- [ ] Support IPv6
- [ ] Investigate potential use of node-iptrie
credits
Original interval-tree written by galedric for torrent-stream. Ported to an isolated npm module by transitive-bullshit for webtorrent.
license
MIT. Copyright (c) Travis Fischer
Support my OSS work by following me on twitter