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

UAParser.js

The most comprehensive, compact, & up-to-date isomorphic JavaScript library to detect user's Browser, Engine, OS, CPU, and Device type/model. Runs either in browser (client-side) or node.js (server-side).

Demo

• Live demo: https://uaparser.dev

Documentation

• version 1.x : https://github.com/faisalman/ua-parser-js/tree/1.0.x#documentation
• version 2.x : https://docs.uaparser.dev

Before upgrading from v0.7 / v1.0, please read CHANGELOG to see what's new & breaking.

License Options

	Open-Source Editions	PRO / Commercial Editions
License options	MIT (v0.7~v1.0)	AGPL (>=v2.0)	PRO Personal	PRO Business	PRO Enterprise
Browser detection	⚠️	✅	✅	✅	✅
CPU detection	⚠️	✅	✅	✅	✅
Device detection	⚠️	✅	✅	✅	✅
Engine detection	⚠️	✅	✅	✅	✅
OS detection	⚠️	✅	✅	✅	✅
Bot detection	❌	✅	✅	✅	✅
AI Bot detection	❌	✅	✅	✅	✅
Extras (Apps, Libs, Emails, Media Players, etc) detection	❌	✅	✅	✅	✅
Enhanced detection result	❌	✅	✅	✅	✅
Client Hints support	❌	✅	✅	✅	✅
CommonJS support	✅	✅	✅	✅	✅
ES modules support	❌	✅	✅	✅	✅
npm module	✅	✅	✅	✅	✅
TypeScript declarations	⚠️	✅	✅	✅	✅
Allows commercial use	✅	✅	❌	✅	✅
Permissive (non-copyleft) license	✅	❌	✅	✅	✅
Unlimited use per 1 license	✅	✅	✅	❌	✅
1-year product support	❌	❌	✅	✅	✅
Lifetime updates	✅	✅	✅	✅	✅
Price	FREE (License)	FREE (License)	$14 (License)	$29 (License)	$599 (License)
GET THE PRO PACKAGES 📥

Development

Contributors

Please read CONTRIBUTING guide first for the instruction details.

Made with contributors-img.

Backers & Sponsors

Support the open-source editions of UAParser.js on OpenCollective or GitHub Sponsors.

Changelog

Version 2.0.0

• ua-parser-js/extensions submodule:
  • Add new CLI: ELinks, HTTPie
  • Add new crawler: AI2Bot, aiHitBot, anthropic-ai, Diffbot, ImagesiftBot, magpie-crawler, Omgilibot, Screaming Frog SEO Spider, Seznambot, Teoma, Timpibot, VelenPublicWebCrawler, Webzio-Extended, YouBot
  • Add new email: Airmail, BlueMail, eMClient, NaverMailApp, Sparrow, Yahoo
  • Add new fetcher: cohere-ai, Vercelbot
  • Add new library: java, python-urllib, python-requests
• ua-parser-js/helpers submodule:
  • Add new method isAIBot(): Checks if the user-agent is an AI bot