nuǝɯ pǝɥsᴉꞁod mǝu

    handset-detect

    4.2.1 • Public • Published

    npm version Build Status Dependency Status devDependency Status

    High-peformance userAgent parser

    A light-weight, high-performance userAgent parser that detects >50 browsers, ~40 OS's, >35,000 devices, bots, smart TVs, gaming consoles, and more. Optimized for Node.js.

    Capabilities

    browser detection
    • 56 distinct browsers
    • 1,179 browser versions
    operating system detection
    • 38 distinct operating systems detectable
    • 359 OS versions
    devices detection
    • 35,156 devices from 3,281 device manufacturers
    • Including 754 bots, 14 cameras, 12 computer devices, 31 gaming consoles, 1 glass device, 25,035 mobile devices, 30 netbooks, 136 set-top-boxes, 9,126 tablets, 15 smart-tvs, 2 smart-watches

    and more...

    See the full list of devices you can detect at https://www.handsetdetection.com/properties

    How to use; TLDR

    // load the library
    const userAgentParser = require('@handsetdetection/apikit')({ free: true });
    // have a userAgent? pump it into the library
    const userAgent = 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1';
    // like this
    userAgentParser( userAgent );
    /* returns:
            {
                vendor: 'Apple',
                model: 'iPhone',
                type: 'Mobile',
                platform: 'iOS',
                platformVersion: '9.1',
                browser: 'Safari',
                browserVersion: '9.0'
            }
     
            vendor is the device manufacturer
            model is device model name
            platform is the Operating System
            type is the kind of device, such as Mobile, Tablet, Gaming Console, TV, SetTopBox, Bot, Watch, etc
    */

    That's all folks!

    You know everything you need to know to rock and roll.

    If you want to learn about more advanced usage, continue reading on. Otherwise, pump in those UAs, and get going!

    Performance

    The first time you query a userAgent, it'll take about 3.20 ms to return results.

    After that, a cache kicks in.

    Cache hits take around 0.05 ms to return full parsed UA results.

    Advanced usage

    This client is the free version of a premium, enterprise-grade UA parser. If you have an enterprise license, then the following sections are designed for your advanced usage. If you do not have an enterprise API key, then no need to read the sections below, stick to example above and you'll be good to go.

    Config options

    // enterprise setup
    const config = {
        username: '007',    // required to access enterprise
        secret: 'shhh',     // required to access enterprise
        module: 'hosted',   // required to be either hosted, cloud, or cache
        verbose: false,     // optional. make the library console.log, for debugging
        autoUpdate: false,  // optional. for hosted only. auto update your database.json file
        onlyLoad: []        // optional. for cloud and cache only. returns the attributes you specify
    };
    const userAgentParser = require('@handsetdetection/apikit')( config );

    module hosted

    const userAgent = 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1';
     
    const userAgentParser = require('@handsetdetection/apikit')({
        module: 'hosted', // required
        autoUpdate: true, // optional
        username: 'username', // required
        secret: 'yourSecret' // required
    });
    // usage:
    console.log( userAgentParser( userAgent ) );
    // returns undefined if no results
    // or returns an obj (see above for a sample response)
    autoUpdate

    If enabled, a new event loop is created on the master thread / master event loop. This forked event loop will manage datebase updates for you. A new database is downloaded every 3 days.

    module cloud

    const userAgent = 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1';
     
    const userAgentParser = require('@handsetdetection/apikit')({
        module: 'cloud',
        username: 'userName',
        secret: 'yourSecret'
    });
     
    userAgentParser( userAgent, function( error, parsedUA ) {
        console.log({ error, parsedUA });
    });

    module caching

    Synchronous caching ability built on the cloud module. On cache miss returns null, and then does a cloud lookup in the background. Future requests for the same UA will be cached in Redis and in-memory. Redis cache is pulled into memory on process start. Redis cache TTL is set to 20 days.

    const userAgentParser = require('@handsetdetection/apikit')({
        module: 'cache',
        username: 'userName',
        secret: 'yourSecret'
    });
     
    console.log( userAgentParser( userAgent ) ); // => null
    console.log( userAgentParser( userAgent ) ); // => actual data

    Install

    npm i handset-detect

    DownloadsWeekly Downloads

    2

    Version

    4.2.1

    License

    ISC

    Last publish

    Collaborators

    • stephenthoma
    • jiminikiz
    • jferge
    • nawar
    • augur