Fast Middleware exposing user-agent for NodeJS

@trulysinclair/parse-useragent is a simple NodeJS/ExpressJS user-agent middleware exposing user-agent details to your application and views.

Installation

# npm
npm install --save @trulysinclair/parse-useragent
# Yarn
yarn add @trulysinclair/parse-useragent

Usage overview

Simple Node App

var http = require("http"),
  useragent = require("@trulysinclair/parse-useragent");

var app = http.createServer(function(req, res) {
  var source = req.headers["user-agent"],
    ua = useragent.parse(source);
  res.writeHead(200, { "Content-Type": "text/plain" });
  res.end(JSON.stringify(ua));
});

app.listen(3000);

For ExpressJS

var express = require("express");
var app = express();
var useragent = require("@trulysinclair/parse-useragent");

app.use(useragent.express());
app.get("/", function(req, res) {
  res.send(req.useragent);
});
app.listen(3000);

module provides details such as the following:

{
  "isMobile":false,
  "isDesktop":true,
  "isBot":false,
  .....
  "browser":"Chrome",
  "version":"17.0.963.79",
  "os":"Windows 7",
  "platform":"Microsoft Windows",
  "source":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.79..."
}

Accessing the User-Agent

If you are using express or connect, then @trulysinclair/parse-useragent provides an easy way to access the user-agent as:

req.useragent from your app server
useragent helper accessible from your express views.

Running Tests

Ensure you have nodeunit by running npm install -g nodeunit. Then, run npm test.

npm install
npm test

Run Example Node App

npm run-script http

Run Example Express App

npm run-script express

Original Author of `express-useragent`

Aleksejs Gordejevs aleksej@gordejev.lv

License

(The MIT License)

Copyright (c) 2023 TrulySinclair truly.sinclair@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

License

trulysinclair/parse-useragent

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages