0.3.2 • Published 12 months ago

express-useragent-middleware v0.3.2

Weekly downloads
89
License
MIT
Repository
github
Last release
12 months ago

Build Status Maintainability Test Coverage

express-useragent-middleware

Install

yarn add express-useragent-middleware

or

npm install --save express-useragent-middleware

How to use

As an ExpressJS middleware

const express = require('express')
const useragent = require('express-useragent-middleware')

const app = express()

app.use(useragent())
app.get('/', (req, res) => res.send(res.locals.useragent))
app.listen(3000)

On client side

import { UserAgent } from 'express-useragent-middleware'

const userAgent = new UserAgent(navigator.userAgent)
const parsedUserAgent = userAgent.getParsed()

The parsed objects looks like the following:

{
  browser: 'Chrome',
  browserVersion: '40.0.2214.38',
  isBot: false,
  isCaptive: false,
  isChrome: true,
  isDesktop: true,
  isIECompatibilityMode: false,
  isMac: true,
  isMobile: false,
  isTablet: false,
  os: 'OS X Yosemite',
  osVersion: '10.10.2',
  platform: 'Unknown'
}

API

getParsed()

This method returns the object with the user agent parsed values.

getUA()

This method returns the user agent string used to get the parsed values.

checkCompatibility(browsers)

This method checks if the user's browser is supported over a list of browsers and versions.

{
  Chrome: "> 50", // This checks if the browser version is under 50
  IE: "< 10", // This checks if the browser version is over 10
  Firefox: "~ 66" // This checks if the major version is equal to 66
}

Test

Run:

yarn
yarn test

Coverage:

yarn test:coverage

Creator

https://www.npmjs.com/org/mytheresa