Neanderthals Programming Machines

npm

Need private packages and team management tools?Check out npm Orgs. »

ip-filter

2.0.0 • Public • Published

ip-filter npmjs.com The MIT License

Validates valid IPs (IPv4 and IPv6) using micromatch - glob patterns, RegExp, string or array of globs. If match returns the IP, otherwise null.

code climate standard code style travis build status coverage status dependency status

You might also be interested in is-match-ip, to-object-path, to-file-path or koa-ip-filter.

Install

npm i ip-filter --save

Usage

For more use-cases see the tests

const ipFilter = require('ip-filter')

ipFilter

Filter ip against glob patterns, using micromatch under the hood, so options are passed to it.

Params

  • ip {String}: Accepts only valid IPs by default
  • patterns {String|Array|RegExp|Function|Object}: Basically everything that is-match can accept.
  • options {Object}: Pass strict: false if want to validate non-ip values, also passed to is-match.
  • returns {String|null}: If not match returns null, otherwise the passed ip.

Example

var ipFilter = require('ip-filter')
 
console.log(ipFilter('123.77.34.89', '123.??.34.8*')) // => '123.77.34.89'
console.log(ipFilter('123.222.34.88', '123.??.34.8*')) // => null
console.log(ipFilter('123.222.33.1', ['123.*.34.*', '*.222.33.*'])) // => '123.222.33.1'
 
// should notice the difference
console.log(ipFilter('123.222.34.88', ['123.*.34.*', '!123.222.**']))
// => null
console.log(ipFilter('123.222.34.88', ['123.*.34.*', '!123.222.*']))
// => '123.222.34.88'
 
//
// NON-STRICT mode
//
 
var res = ipFilter('x-koaip', ['*-koaip', '!foo-koa*'], { strict: false })
console.log(res) // => 'x-koaip'
 
var res = ipFilter('x-koa.foo', ['*-koa.*', '!foo-koa.*'], { strict: false })
console.log(res) // => 'x-koa.foo'

Related

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent new message to charlike freenode #charlike

tunnckoCore.tk keybase tunnckoCore tunnckoCore npm tunnckoCore twitter tunnckoCore github

install

npm i ip-filter

Downloadsweekly downloads

493

version

2.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability