ua-parser2/js/doc/uaparser.md

An improved user agent parser.

ua-parser


_Source: [index.js](../index.js)_

<a name="tableofcontents"></a>

- <a name="toc_uaparserparseuastr"></a><a name="toc_uaparser"></a>[uaParser.parseUA](#uaparserparseuastr)
- <a name="toc_uaparserparseenginestr"></a>[uaParser.parseEngine](#uaparserparseenginestr)
- <a name="toc_uaparserparseosstr"></a>[uaParser.parseOS](#uaparserparseosstr)
- <a name="toc_uaparserparsedevicestr"></a>[uaParser.parseDevice](#uaparserparsedevicestr)
- <a name="toc_uaparserparsestr"></a>[uaParser.parse](#uaparserparsestr)
- <a name="toc_uaparserloadsyncoptions"></a>[uaParser.loadSync](#uaparserloadsyncoptions)
- <a name="toc_uaparserloadoptions-callback"></a>[uaParser.load](#uaparserloadoptions-callback)
- <a name="toc_uaparserwatchoptions-callback"></a>[uaParser.watch](#uaparserwatchoptions-callback)

<a name="uaparser"></a>

# uaParser.parseUA(str)

> Parse the User-Agent string `str` for User-Agent

**Parameters:**

- `{string} str` - Browsers User-Agent string

**Return:**

`{Object}` - { family:, major:, minor:, patch: }

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

# uaParser.parseEngine(str)

> Parse the User-Agent string `str` for Engine

**Parameters:**

- `{string} str` - Browsers User-Agent string

**Return:**

`{Object}` - { family:, major:, minor:, patch: }

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

# uaParser.parseOS(str)

> Parse the User-Agent string `str` for Operating System

**Parameters:**

- `{string} str` - Browsers User-Agent string

**Return:**

`{Object}` - { family:, major:, minor:, patch:, patchMinor: }

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

# uaParser.parseDevice(str)

> Parse the User-Agent string `str` for Device

**Parameters:**

- `{string} str` - Browsers User-Agent string

**Return:**

`{Object}` { family:, brand:, model: }

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

# uaParser.parse(str)

> Parse the User-Agent string `str` for User-Agent, Operating System, Device

**Parameters:**

- `{string} str` - Browsers User-Agent string

**Return:**

`{Object}` - { family:, brand:, model: }

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

# uaParser.loadSync(options)

> Synchronously load the ua-parsers regexes file

**Parameters:**

- `{Object | string} options` - (optional) if "undefined" than default file is choosen. If string is given than that file is used.




**Return:**

`{Boolean}` true if file was loaded otherwise false.

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

# uaParser.load(options, callback)

> Asynchronously load the ua-parsers regexes file

**Parameters:**

- `{Object | string} options` - (optional) if "undefined" than default file is choosen. If string is given than that file is used.




- `{Function} callback` - callback(error)

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

# uaParser.watch(options, callback)

> Watch a regexes file and reload if there are any changes

**Parameters:**

- `{Object | string} options` - (optional) if "undefined" than default file is choosen. If string is given than that file is used.




- `{Function} callback` - callback(error)

<sub>Go: [TOC](#tableofcontents) | [uaParser](#toc_uaparser)</sub>

_&mdash;generated by [apidox](https://github.com/codeactual/apidox)&mdash;_