Parser - Documentation

Constructor

new Parser(UA, skipParsingopt)

Source:

parser.js, line 10

Create instance of Parser

Parameters:

Name	Type	Attributes	Default	Description
`UA`	String			User-Agent string
`skipParsing`	Boolean	<optional>	`false`	parser can skip parsing in purpose of performance improvements if you need to make a more particular parsing like Parser#parseBrowser or Parser#parsePlatform

Methods

compare(checkTree) → {Boolean}

Source:

parser.js, line 334

Check if parsed browser matches certain conditions

Example

const browser = new Bowser(UA);
if (browser.check({chrome: '>118.01.1322' }))
// or with os
if (browser.check({windows: { chrome: '>118.01.1322' } }))
// or with platforms
if (browser.check({desktop: { chrome: '>118.01.1322' } }))

Parameters:

Name	Type	Description
`checkTree`	Object	It's one or two layered object, which can include a platform or an OS on the first layer and should have browsers specs on the bottom-laying layer

Returns:

whether the browser satisfies the set conditions or not

Type: Boolean

getBrowser() → {Object}

Source:

parser.js, line 105

Get parsed browser object

Returns:

Type: Object

getBrowserName() → {String}

Source:

parser.js, line 119

Get browser's name

Returns:

Browser's name or an empty string

Type: String

getBrowserVersion() → {String}

Source:

parser.js, line 133

Get browser's version

Returns:

version of browser

Type: String

getEngine() → {Object}

Source:

parser.js, line 262

Get parsed engine

Returns:

Type: Object

getOS() → {Object}

Source:

parser.js, line 148

Get OS

Example

this.getOS();
{
  name: 'macOS',
  version: '10.11.12'
}

Returns:

Type: Object

getOSName(toLowerCaseopt) → {String}

Source:

parser.js, line 187

Get OS name

Parameters:

Name	Type	Attributes	Description
`toLowerCase`	Boolean	<optional>	return lower-cased value

Returns:

name of the OS — macOS, Windows, Linux, etc.

Type: String

getOSVersion() → {String}

Source:

parser.js, line 201

Get OS version

Returns:

full version with dots ('10.11.12', '5.6', etc)

Type: String

getPlatform() → {Object}

Source:

parser.js, line 209

Get parsed platform

Returns:

Type: Object

getPlatformType(toLowerCase) → {*}

Source:

parser.js, line 222

Get platform name

Parameters:

Name	Type	Description
`toLowerCase`	Boolean

Returns:

Type: *

getResult() → {ParsedResult}

Source:

parser.js, line 312

Get parsed result

Returns:

Type: ParsedResult

getUA() → {String}

Source:

parser.js, line 60

Get UserAgent string of current Parser instance

Returns:

User-Agent String of the current object

Type: String

is(anything) → {Boolean}

Source:

parser.js, line 382

Is anything? Check if the browser is called "anything", the OS called "anything" or the platform called "anything"

Parameters:

Name	Type	Description
`anything`	String

Returns:

Type: Boolean

parse()

Source:

parser.js, line 299

Parse full information about the browser

parseBrowser() → {Object}

Source:

parser.js, line 77

Get parsed browser object

Returns:

Type: Object

parseEngine() → {Object}

Source:

parser.js, line 274

Get parsed platform

Returns:

Type: Object

parseOS() → {*|Object}

Source:

parser.js, line 160

Parse OS and save it to this.parsedResult.os

Returns:

Type: * | Object

parsePlatform() → {Object}

Source:

parser.js, line 236

Get parsed platform

Returns:

Type: Object

test(regex) → {Boolean}

Source:

parser.js, line 69

Test a UA string for a regexp

Parameters:

Name	Type	Description
`regex`	RegExp

Returns:

Type: Boolean