Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 2 KB

readme.md

File metadata and controls

111 lines (76 loc) · 2 KB

ua-parser-modern

Detect Browser, Engine, OS, CPU, and Device type/model from User-Agent data. Supports browser & node.js environment.

Forked from my-ua-parser, rewritten in TypeScript with functional API in ESM.

Install

pnpm i ua-parser-modern

Usage

import { parseUA } from 'ua-parser-modern'

const result = parseUA(navigator.userAgent)
console.log(result.browser) // { name: 'Chrome', version: '113.0.0.0', major: '113' }

Named parser functions

import {
  parseBrowser,
  parseCPU,
  parseDevice,
  parseEngine,
  parseOS,
  parseUA,
} from 'ua-parser-modern'

const ua = 'Mozilla/5.0 (...)'

parseBrowser(ua)
parseCPU(ua)
parseDevice(ua)
parseEngine(ua)
parseOS(ua)
parseUA(ua)

Extend regexes

import { BROWSER, parseUA } from 'ua-parser-modern'

const customBrowser = [
  [/(mybrowser)\/([\w.]+)/i],
  [BROWSER.NAME, BROWSER.VERSION],
]

const result = parseUA('Mozilla/5.0 MyBrowser/1.3', {
  browser: customBrowser,
})

API

parseUA(uastring?, extensions?)

Returns:

interface IResult {
  ua: string
  browser: { name?: string, version?: string, major?: string }
  cpu: { architecture?: string }
  device: { model?: string, type?: string, vendor?: string }
  engine: { name?: string, version?: string }
  os: { name?: string, version?: string }
}

parseBrowser(uastring?, extensions?)

Returns { name, version, major }.

parseCPU(uastring?, extensions?)

Returns { architecture }.

parseDevice(uastring?, extensions?)

Returns { model, type, vendor }.

parseEngine(uastring?, extensions?)

Returns { name, version }.

parseOS(uastring?, extensions?)

Returns { name, version }.

Exported constants

  • BROWSER
  • CPU
  • DEVICE
  • ENGINE
  • OS
  • version

Credits

Forked from my-ua-parser by Matteo Collina, which was a fork of ua-parser-js by Faisal Salman.

License

MIT License