Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sibiraj-s/browser-dtector
🌐 A Javascript library to detect browser, version and platform
https://github.com/sibiraj-s/browser-dtector
browser-detector useragent-parser
Last synced: about 1 month ago
JSON representation
🌐 A Javascript library to detect browser, version and platform
- Host: GitHub
- URL: https://github.com/sibiraj-s/browser-dtector
- Owner: sibiraj-s
- License: mit
- Created: 2020-06-27T03:11:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T04:15:50.000Z (11 months ago)
- Last Synced: 2024-05-02T00:01:06.724Z (10 months ago)
- Topics: browser-detector, useragent-parser
- Language: TypeScript
- Homepage: https://sibiraj-s.github.io/browser-dtector/
- Size: 3.87 MB
- Stars: 26
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# browser-dtector [](https://github.com/sibiraj-s/browser-dtector/actions)
> A Javascript library to detect browser, version and platform
## Getting Started
### Installation
Install via Package managers such as [npm][npm] or [yarn][yarn]
```bash
npm install browser-dtector --save
# or
yarn add browser-dtector
```
or use cdn
```bash
//cdn.jsdelivr.net/npm/browser-dtector@latest/dist/browser-dtector.js
```
### Usage
This library exports both ESM and CJS formats, you should be able to use it in both `Node.js` and `browser`.
```js
import BrowserDetector from 'browser-dtector';
const browser = new BrowserDetector(window.navigator.userAgent);
browser.parseUserAgent();
```
**Usage in Node.js:**
> [!IMPORTANT]
> While using in nodejs, it is mandatory to input `useragent`.
```js
const http = require('http');
const { BrowserDetector } = require('browser-dtector');
const browser = new BrowserDetector();
http
.createServer((req, res) => {
// get user-agent header
const ua = browser.parseUserAgent(req.headers['user-agent']);
// write the result as response
res.end(JSON.stringify(ua, null, 4));
})
.listen(8080, '127.0.0.1');
console.log('Server running at http://127.0.0.1:8080/');
```
**Usage in HTML:**
```html
BrowserDetector
Hello World!
import BrowserDetector from 'https://cdn.jsdelivr.net/npm/browser-dtector/dist/browser-dtector.js';
const detector = new BrowserDetector(window.navigator.userAgent);
console.log(detector.parseUserAgent());
```
### Supported Browsers
- Google Chrome
- Mozilla Firefox
- Microsoft Edge
- Safari
- Brave
- Microsoft Internet Explorer
- Opera
- Samsung Browser
- Electron
### Supported Platforms
- Macintosh
- Microsoft Windows
- Linux
- Windows Phone
- Android
- Android Tablet
- IPad
- IPhone
- Chrome OS
- Microsoft Xbox
### Demo
- Browser Detector:
- UserAgent Parser:
### API
Sample
```js
import BrowserDetector from 'browser-dtector';
const browser = new BrowserDetector(window.navigator.userAgent);
browser.parseUserAgent();
```
- **parseUserAgent()** [`object`]: Returns parsed useragent info
```json
{
"name": "Google Chrome",
"platform": "Macintosh",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) ...",
"version": "71.0.3578.98",
"shortVersion": "71",
"isAndroid": false,
"isTablet": false,
"isMobile": false,
"isDesktop": true,
"isWebkit": true,
"isIE": false
}
```
- **getBrowserInfo()** [`object`]: Returns a minimal and necessary browser info.
```json
{
"name": "Google Chrome",
"platform": "Macintosh",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) ...",
"version": "71.0.3578.98",
"shortVersion": "71"
}
```
- **userAgent** [`string | null`]: Useragent for current instance
**Miscellaneous:**
- **BrowserDetector.VERSION** [`string`]: Current version of the library.
[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/lang/en/
[umd]: https://github.com/umdjs/umd