Skip to content
Lightweight JavaScript-based User-Agent string parser. Supports browser & node.js environment.
Find file
Pull request Compare This branch is 270 commits behind faisalman:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.gitignore
package.json
readme.md
test.js
ua-parser.js

readme.md

UA-Parser.JS

Lightweight JavaScript-based User-Agent string parser

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: "AppleWebKit", 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);                   // "AppleWebKit"

License

Copyright © 2012 Faisalman <fyzlman@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.

Something went wrong with that request. Please try again.