Giter VIP home page Giter VIP logo

browser-dtector's Introduction

browser-dtector Tests

A Javascript library to detect browser, version and platform

Getting Started

Installation

Install via Package managers such as npm or yarn

npm install browser-dtector --save
# or
yarn add browser-dtector

or use cdn

//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.

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.

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:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
    <title>BrowserDetector</title>
  </head>

  <body>
    Hello World!
    <script type="module">
      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());
    </script>
  </body>
</html>

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

API

Sample

import BrowserDetector from 'browser-dtector';

const browser = new BrowserDetector(window.navigator.userAgent);
browser.parseUserAgent();
  • parseUserAgent() [object]: Returns parsed useragent info

    {
      "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.

    {
      "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.

browser-dtector's People

Contributors

dependabot[bot] avatar ilyasemenov avatar michaelmano avatar oleksandr-danylchenko avatar sibiraj-s avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

browser-dtector's Issues

Add helper functions

Hello, it would be great if you could add some helper functions like: isChrome(), isFirfoex() etc.

`TS4023: Exported variable ...  has or is using name  BrowserInfoFull  from external module` error in V4

When the TS file in my project has the next structure:

import BrowserDetector, { KnownBrowsers } from 'browser-dtector';

const browser = new BrowserDetector(window.navigator.userAgent);
export const parsedUserAgent = browser.parseUserAgent();

I'm getting an error on the exported parsedUserAgent variable:

TS4023: Exported variable  parsedUserAgent  has or is using name  BrowserInfoFull  from an external module ".../node_modules/browser-dtector/dist/browser-dtector" but cannot be named

The suggested fix is to export the BrowserInfoFull from the browser-dtector package to let the TS figure out an appropriate name for this type

Demo:
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.