github_mirrors/ua-parser-js
3
0
Fork 1
mirror of https://github.com/faisalman/ua-parser-js.git synced 2025-09-28 00:18:45 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation

Browse Source 
`readme.md` refers to a `parser.getResults` function, which does not exist. This PR corrects the function name to `getResult`.
This commit is contained in:
Riley Shaw 2022-10-26 13:17:33 -04:00 committed by GitHub
parent d11fc47dc9
commit 7f71024161
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
readme.md
View File

@ -36,7 +36,7 @@ Like so:
```js
let parser = new UAParser("user-agent"); // you need to pass the user-agent for nodejs
console.log(parser); // {}
let parserResults = parser.getResults();
let parserResults = parser.getResult();
console.log(parserResults);
/** {
"ua": "",
@ -48,7 +48,7 @@ console.log(parserResults);
} */
```
When you call UAParser without the `new` keyword, it will automatically call `getResults()` function and return the parsed results.
When you call UAParser without the `new` keyword, it will automatically call `getResult()` function and return the parsed results.
* `UAParser([uastring][,extensions])`
* returns result object `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`