ua-parser-js

What is ua-parser-js?

The ua-parser-js package is a utility for parsing user agent strings. It can be used to extract detailed information about the browser, engine, OS, CPU, and device from the user agent string provided by the client's browser.

What are ua-parser-js's main functionalities?

Browser Detection

This feature allows you to detect the browser name and version from the user agent string.

const UAParser = require('ua-parser-js');
const parser = new UAParser();
const browser = parser.getBrowser();
console.log(browser);

Operating System Detection

This feature enables you to determine the operating system and its version from the user agent string.

const UAParser = require('ua-parser-js');
const parser = new UAParser();
const os = parser.getOS();
console.log(os);

Device Detection

With this feature, you can identify the device type, vendor, and model from the user agent string.

const UAParser = require('ua-parser-js');
const parser = new UAParser();
const device = parser.getDevice();
console.log(device);

Engine Detection

This feature allows you to extract the layout engine name and version from the user agent string.

const UAParser = require('ua-parser-js');
const parser = new UAParser();
const engine = parser.getEngine();
console.log(engine);

CPU Architecture Detection

This feature provides information about the CPU architecture from the user agent string.

const UAParser = require('ua-parser-js');
const parser = new UAParser();
const cpu = parser.getCPU();
console.log(cpu);

Other packages similar to ua-parser-js

device

The 'device' package is another npm package that allows you to parse user agent strings to determine device type (phone, tablet, desktop, etc.). It is simpler than ua-parser-js and does not provide detailed information about browser, engine, or OS.

platform

The 'platform' package is used for parsing and interpreting user agent strings. It provides information about the operating system, browser, and device in a structured format. It is similar to ua-parser-js but has a different API and may offer different levels of detail in the results.

bowser

Bowser is a browser detection library that is similar to ua-parser-js. It focuses on identifying browser type, version, and engine. It also provides methods to check if the browser matches certain criteria, which can be useful for feature detection and browser-specific adjustments.

README

UA-Parser.JS

Lightweight JavaScript-based User-Agent string parser

• Author : Faisalman <[e-mail]>
• Home : http://faisalman.github.com/ua-parser-js
• Source : https://github.com/faisalman/ua-parser-js
• License : GPLv2 & MIT

Features

Extract detailed type of web browser, layout engine, operating system, and device purely from user-agent string.

Methods

• getBrowser()
• getDevice()
• getEngine()
• getOS()
• getResult()
• getUA()
• setUA(uastring)

Example

<script type="text/javascript" src="ua-parser.js"></script>
<script type="text/javascript">
    
	var parser = new UAParser();
	
    // by default it takes ua string from current browser's window.navigator.userAgent
    console.log(parser.getResult());
    /*
        /// this will print an object structured like this:
        {
            browser: {
                name: "",
                version: "",
                major: ""
            },
            engine: {
                name: "",
                version: ""
            },
            os: {
                name: "",
                version: ""
            },
            device: {
                model: "",
                type: "",
                vendor: ""
            }
        }
    */

    // let's test a custom user-agent string as an example
    var uastr = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2";
    parser.setUA(uastr);
    
    console.log(parser.getResult().browser);    // {name: "Chromium", major: "15", version: "15.0.874.106"}
    console.log(parser.getResult().device);     // {model: undefined, type: undefined, vendor: undefined}
    console.log(parser.getResult().engine);     // {name: "WebKit", version: "535.2"}
    console.log(parser.getResult().os);         // {name: "Ubuntu", version: "11.10"}
    
    // let's take another test please
    console.log(parser.setUA("Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)").getBrowser().name); // "Konqueror"
    console.log(parser.getOS());                // {name: "OpenBSD", version: undefined}
    console.log(parser.getEngine());            // {name: "KHTML", version: "4.1.4"}
</script>

Using node.js

$ npm install ua-parser-js

var UAParser    = require('ua-parser');
var parser      = new UAParser();
var uaString    = 'Mozilla/5.0 (PlayBook; U; RIM Tablet OS 1.0.0; en-US) AppleWebKit/534.11 (KHTML, like Gecko) Version/7.1.0.7 Safari/534.11';

console.log(parser.setUA(uaString).getDevice().model);  // "PlayBook"
console.log(parser.getOS())                             // {name: "RIM Tablet OS", version: "1.0.0"}
console.log(parser.getEngine().name);                   // "WebKit"

License

Copyright © 2012 Faisalman <[e-mail]>

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.