• About Us
  • Blog
  • Basket
  • Account
  • Sign In
  •  

Node.js API

What's Covered

This tutorial illustrates how to append a CSV file containing User-Agent strings with IsMobile, PlatformName and PlatformVersion properties. The following aspects of the API are covered:

  • How to perform a User-Agent match.
  • How to reuse resources to perform subsequent matching.
  • How to retrieve match results for a specific property.
  • How to append a property value to a CSV file.

Code and Explanation

Offline processing example of using 51Degrees device detection. The example shows how to:
  1. Set the configuration using a json object

    var config = {"dataFile" : require("fiftyonedegreeslitepattern"),
                  "properties" : "IsMobile",
                  "cacheSize" : 10000,
                  "poolSize" : 4
    };
    

  2. Instantiate the 51Degrees device detection provider with this connfiguration

    var provider = new fiftyonedegrees.provider(config);
    

  3. Open an input file with a list of User-Agents, and an output file,

    var inStream = fs.createReadStream(inputFile);
    var outStream = fs.createWriteStream(outputFile);
    

  4. Write a header to the output file with the property names in '|' separated CSV format ('|' separated because some User-Agents contain commas)

    outStream.write('User-Agent')
    provider.availableProperties.forEach(function(property) {
        outStream.write('|' + property);
    });
    outStream.write('\n');
    

  5. For the first 20 User-Agents in the input file, perform a match then write the User-Agent along with the values for chosen properties to the CSV.

    rl.on('line', function (userAgent) {
        if (i < 20) {
            outStream.write(userAgent);
            var match = provider.getMatch(userAgent);
            provider.availableProperties.forEach(function(property) {
                outStream.write("|" + match[property]);
            })
            outStream.write("\n");
            match.close();
        }
        i++;
    });
    

Full Source File
// Include 51Degrees.
var fiftyonedegrees = require("fiftyonedegreescore");
// Inlcude file modules.
var fs = require("fs"),
    readline = require("readline");

// Set the config.
var config = {"dataFile" : require("fiftyonedegreeslitepattern"),
              "properties" : "IsMobile,PlatformName,PlatformVersion",
              "cacheSize" : 10000,
              "poolSize" : 4,
             };

var inputFile = __dirname + "/../../data/20000 User Agents.csv";
var outputFile = "offlineProcessingOutput.csv";

// Carries out match for first 20 User-Agents and prints results to
// output file.
var outputOfflineProcessing = function() {
    var inStream = fs.createReadStream(inputFile),
        rl = readline.createInterface(inStream, null),
        outStream = fs.createWriteStream(outputFile);
    inStream.on("close", function() {
        outStream.close();
        console.log("Output written to " + outputFile);
    })

    outStream.write("User-Agent");
    provider.availableProperties.forEach(function(property) {
        outStream.write("|" + property);
    })
    outStream.write("\n");

    var i = 0;
    rl.on('line', function (userAgent) {
        if (i < 20) {
            outStream.write(userAgent);
            var match = provider.getMatch(userAgent);
            provider.availableProperties.forEach(function(property) {
                outStream.write("|" + match[property]);
            })
            outStream.write("\n");
            match.close();
        }
        i++;
    });
}

console.log("Starting Offline Processing Example.\n");

/*
Initialises the device detection provider with settings from the config.
By default this will use the packaged Lite data file. For more info see:
<a href="https://51degrees.com/compare-data-options">compare data options
</a>
*/
var provider = new fiftyonedegrees.provider(config);
outputOfflineProcessing();

Full Source File

Summary

Offline device detection is frequently required for a variety of reasons such as generating reports. The example is based on an actual support request where several properties had to be added to the CSV file before it could be passed on for another department to use.

This tutorial covered how to use the detector offline to append the first 20 lines of a CSV file with Lite properties: IsMobile, PlatformName and PlatformVersion. Using a Premium or an Enterprise data file gives you access to a far greater number of properties including HardwareVendor, PriceBand, ScreenInchesWidth, IsCrawler and more. A full list of properties and the data file version they are present in can be viewed in the Property Dictionary.