UAParser Class Overview

Constructor

UAParser(uastring?: string, extensions?: UAParserExt, headers?: UAParserHeaders): IResult`

TIP

• In browser environment, the User-Agent string is automatically taken from window.navigator.userAgent.
• In Node.js environment, you need to pass the User-Agent string manually, usually from request.headers["user-agent"].

• new UAParser()

When called with the new keyword, it will return a new instance of UAParser.

example-with-new.js

const parser = new UAParser("your user-agent here");
console.log(parser); 
/* 
    UAParser instance
*/

const result = parser.getResult();
console.log(result);
/* 
    {
        ua      : "your user-agent here",
        browser : {},
        engine  : {},
        os      : {},
        device  : {},
        cpu     : {}
    }
*/

• UAParser()

When called without the new keyword, it will directly return the results of getResult()

TIP

UAParser() equals with new UAParser().getResult()

example-without-new.js

const result = UAParser("your user-agent here");
console.log(result);
/* 
    {
        ua      : "your user-agent here",
        browser : {},
        engine  : {},
        os      : {},
        device  : {},
        cpu     : {}
    }
*/

Methods

The methods are self explanatory, here's a small overview of available methods:

• getBrowser(): IBrowser

returns the browser name, version, and major.

• getCPU(): ICPU

returns CPU architectural design name.

• getDevice(): IDevice

returns the device model, type, vendor.

• getEngine(): IEngine

returns the browser engine name and version.

• getOS(): IOS

returns the operating system name and version.

• getResult(): IResult

returns all function object calls, user-agent string, browser info, cpu, device, engine, os.

• getUA(): string

returns the user-agent string.

• setUA(ua: string): UAParser

set a custom user-agent string to be parsed.

Fields

• static readonly VERSION: string

Contains the current version of the library.

example-version.js

const UAParser = require('ua-parser-js');

console.log(`Current library version: ${UAParser.VERSION}`);

• static readonly BROWSER: { NAME, VERSION, MAJOR, TYPE }

Contains a list of the property names of IBrowser.

example-browser.js

const myOwnListOfBrowsers = [
    [/(mybrowser)\/([\w\.]+)/i], 
    [UAParser.BROWSER.NAME, UAParser.BROWSER.VERSION]
];
const myUA = 'Mozilla/5.0 MyBrowser/1.3';
const myParser = new UAParser({ browser: myOwnListOfBrowsers });

console.log(myParser.setUA(myUA).getBrowser());  
// {name: "MyBrowser", version: "1.3", major: "1"}

• static readonly CPU: { ARCHITECTURE }

Contains a list of the property names of ICPU.

• static readonly DEVICE: { TYPE, VENDOR, MODEL, CONSOLE, EMBEDDED, MOBILE, SMARTTV, TABLET, WEARABLE, XR }

Contains a list of the property names of IDevice and possible values for IDevice.type.

example-device.js

const myOwnListOfDevices = [
    [/(mytab) ([\w ]+)/i], 
    [UAParser.DEVICE.VENDOR, UAParser.DEVICE.MODEL, [UAParser.DEVICE.TYPE, UAParser.DEVICE.TABLET]],
    [/(myphone)/i], 
    [UAParser.DEVICE.VENDOR, [UAParser.DEVICE.TYPE, UAParser.DEVICE.MOBILE]]
];
const myUA2 = 'Mozilla/5.0 MyTab 14 Pro Max';
const myParser2 = new UAParser({ device: myOwnListOfDevices });

console.log(myParser2.setUA(myUA2).getDevice());  
// {vendor: "MyTab", model: "14 Pro Max", type: "tablet"}

• static readonly ENGINE: { NAME, VERSION }

Contains a list of the property names of IEngine.

• static readonly OS: { NAME, VERSION }

Contains a list of the property names of IOS.