npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

express-user-agent-blocker

v2.0.4

Published

Express middleware for blocking access based on User Agent

Downloads

540

Readme

Express User-agent Blocker 🤖

npm Build Status Coverage Status

A lightweight user-agent blocker for Express.

Why?

Some bots just don't play by the rules and blatantly disrespect robots.txt. To these bots, we say "Nothing to see here - move along please..."

Installation

npm i express-user-agent-blocker

Usage

This module has no dependencies and can be added anywhere in the express chain as long as it runs before serving any content that needs to be blocked.

// JavaScript
const express = require('express')
const blocker = require('express-user-agent-blocker')

const app = express()

// ...
// other middleware
// ...
app.use(blocker(['Baiduspider', 'SomeHorridUA']))
// ...
// more middleware
// ...
// TypeScript
import express from 'express'
import blocker from 'express-user-agent-blocker'

const app = express()

// ...
// other middleware
// ...
app.use(blocker(['Baiduspider', 'SomeHorridUA']))
// ...
// more middleware
// ...

Specifying a custom message

// html response
app.use(blocker(['Baiduspider'], {
  html: '<h1>Let me make a bologna sandwich...</h1>'
}))

// plain text response
app.use(blocker(['Baiduspider'], {
  text: 'Words hold no weight'
}))

Result

If no custom message has been set (see above), any unwanted UAs visiting your application will be sent a default JSON response:

{
  "message": "Nothing to see here - move along please..."
}

Enable default debug logging

Pass euab:* in as part DEBUG when starting the express server, e.g.

# log everything
DEBUG=euab:* node server.js

# log only denied requests
DEBUG=euab:index node server.js

# log the block regex only during startup 
DEBUG=euab:buildUaBlockRegex node server.js

# log only the message sent to the blocked UA
DEBUG=euab:respondToBlockedUa node server.js

Specifying a custom logger

Pass in a logger object with a log function to call

// console log
app.use(blocker(['Baiduspider'], {
  logger: {
    log: (message) => {
      console.log(message)
    }
  }
}))

Tests

Tested in node >= 7

Run tests with:

npm test

Changelog

v2.04

  • Chore: updated dev dependencies only - no functional changes

v2.0.3

  • Chore: updated test dependencies only - no functional changes

v2.0.2

  • Fixes broken test

v2.0.1

  • Adds Typescript usage documentation

v2.0.0

  • Adds TypeScript types

v1.5.2

  • Adds testing support for Node 10 & 11
  • Removes references to bithound
  • Updates dependencies

v1.5.1

  • Adds testing support for Node 9
  • Updates dependencies
  • Removes done() callbacks in tests
  • Removes bithound dependency

v1.5.0

  • Drops testing support for Node 6, but should continue to work as normal

v1.4.0

v1.3.x

  • Additional README information
  • Adds express and debug as peer dependencies
  • Updates JSDoc

v1.3.0

  • Enables passing in of alternative logger (currently defaults to process.stdout)

v1.2.0

  • Adds option to send alternative message to blocked UAs

v1.1.2

  • Moves test files out of src folder
  • Uses rollup to compile module files into single index.js

pre v1.1.2

  • Changelog didn't exist! 🙈

License

MIT