# browser-detect
> Simplify detecting your browser
Latest version **0.2.28** (published 2018-06-08) · MIT license · 0 weekly downloads
## Install
```sh
npm install browser-detect
pnpm add browser-detect
yarn add browser-detect
bun add browser-detect
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.2.28 |
| Published | 2018-06-08 |
| First published | 2017-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 149.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 126 |
| Author | PIGNOSE |
| Maintainers | kenneth-ceyer |
| Keywords | browser, agent, modernizr, detect, node, client |
## Links
- npm: https://www.npmjs.com/package/browser-detect
- Repository: https://github.com/KennethanCeyer/browser-detect
- Issues: https://github.com/KennethanCeyer/browser-detect/issues
- npm.io page: https://npm.io/package/browser-detect
## Dependencies (1)
- [core-js](https://npm.io/package/core-js.md) ^2.5.7
## Alternatives
- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads
## Recent versions
- 0.2.28 (latest) — 2018-06-08
- 0.2.27 — 2018-04-30
- 0.2.26 — 2018-04-02
- 0.2.25 — 2018-04-01
- 0.2.24 — 2018-04-01
- 0.2.23 — 2018-04-01
- 0.2.22 — 2017-12-06
- 0.2.21 — 2017-12-06
- 0.2.20 — 2017-12-06
- 0.2.19 — 2017-12-06
- 0.2.18 — 2017-05-16
- 0.2.17 — 2017-05-14
- 0.2.16 — 2017-05-14
- 0.2.15 — 2017-05-13
- 0.2.14 — 2017-05-13
- … 13 more at https://npm.io/package/browser-detect/versions
## README
## :package: Installation
#### npm
```bash
$ npm install browser-detect
```
#### yarn
```bash
$ yarn add browser-detect
```
## :page_with_curl: Example
### Web
```html
```
```javascript
const result = browserDetect();
console.log(result);
```
**output**
```javascript
{
name: 'chrome',
version: '58.0.3029',
versionNumber: 58.03029,
mobile: false,
os: 'Windows NT 10.0'
}
```
### Web with module
```javascript
import browser from 'browser-detect';
const result = browser();
console.log(result);
```
**output**
```javascript
{
name: 'chrome',
version: '58.0.3029',
versionNumber: 58.03029,
mobile: false,
os: 'Windows NT 10.0'
}
```
### NodeJS
Just simple :trollface:
```javascript
const browser = require('browser-detect');
const result = browser();
console.log(result);
```
**output**
```javascript
{
name: 'node',
version: '9.9.0',
versionNumber: 9.9,
mobile: false,
os: 'win32'
}
```
### NodeJS with Express
```javascript
const router = express.Router();
const browser = require('browser-detect');
router.get('/', req => {
const result = browser(req.headers['user-agent']);
console.log(result);
});
return router;
```
**output**
```javascript
{
name: 'ie',
version: '9.0',
versionNumber: 9,
mobile: false,
os: 'Windows NT 10.0'
}
```
Or set a middleware and send to `res.locals`.
```javascript
// browserDetectMiddleware.js
const browser = require('browser-detect');
const MiddleWare = () => req => {
res.locals.browser = browser(req.headers['user-agent']);
next();
};
module.exports = MiddleWare;
```
```javascript
// app.js
const express = require('express');
const browserDetectMiddleware = require('./browserDetectMiddleware');
const app = express();
app.use(browserDetectMiddleware())
```
View will can access `browser` variable.
```ejs
<%=JSON.stringify(browser)%>
```
**output**
```javascript
"{ name: 'firefox', version: '53.0.0', versionNumber: 53, mobile: false, os: 'Windows NT 10.0' }"
```
## :page_with_curl: Demo
#### Web
- open `examples/client.html` by your browser.
#### NodeJS
- open command or terminal
- move directory to `browser-detect` path that you download
- type following code
```bash
$ node ./examples/server.js
```
## :zap: Type
| name | type | description | example |
| ---- | ---- | ----------- | ------- |
| name | string | a browser name | ie, chrome, firefox |
| version | string | browser or node version | 59.2.22 |
| versionNumber | number | browser or node number casted to number | 59.222 |
| mobile | boolean | if browser is in mobile environment, it will be true | ture |
| os | string | os type name | Windows NT 10.0 |
## :triangular_flag_on_post: Roadmap
- [x] detect browser both compatible client and server
- [x] support AMD and CommonJS module feature
- [x] support typings
- [x] support guideline and documentations for contributors
- [x] support browser compatity to IE7
- [x] support to detect mobile and OS
- [x] support CI (TravisCI)
- [x] support unit tests
- [ ] support e2e tests
- [ ] suport cdn
## :mag_right: Compatibility
- [x] IE 7+
- [x] Chrome (Windows, MacOS)
- [x] Edge
- [x] Firefox
- [x] Safari (Windows, MacOS)
- [x] Opera
- [x] Android
- [x] Chromium Browsers (Will be named chrome)
## :octocat: Contribution
### environment
1. clone project from Github
```bash
$ git clone git@github.com:KennethanCeyer/browser-detect.git
```
2. install npm packages
```bash
$ cd browser-detect
$ npm install
```
3. build sources
```bash
$ npm run build
```
### test
```bash
$ npm run test
```
## :yellow_heart: Contributors
- [**yarkeev**](https://github.com/yarkeev)
- [**vlewin**](https://github.com/vlewin)
## :mag_right: License
[](https://app.fossa.io/projects/git%2Bgithub.com%2FKennethanCeyer%2Fbrowser-detect?ref=badge_large)
---
_Source: https://npm.io/package/browser-detect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._