JSPM

fiftyone.devicedetection

4.5.0-alpha.36
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 315
  • Score
    100M100P100Q94566F
  • License EUPL-1.2

Parse HTTP headers to detect the device type, model, operating system, browser, and crawler information

Package Exports

  • fiftyone.devicedetection
  • fiftyone.devicedetection/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fiftyone.devicedetection) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

51Degrees Node Device Detection

Developer Documentation

Introduction

This project contains 51Degrees Device Detection engines that can be used with the Pipeline API.

The Pipeline is a generic web request intelligence and data processing solution with the ability to add a range of 51Degrees and/or custom plug ins (Engines)

This package - fiftyone.devicedetection

This package provides a generic DeviceDetectionPipelineBuilder which check the input arguments to determine the type of Device Detection engine to be used in the resulting pipeline. The engine can be either Cloud or On-Premise.

This package requires the following additional packages:

  • fiftyone.devicedetection.cloud - A Node.js engine which retrieves engine results by consuming data from the 51Degrees cloud service. A cloud builder is also included to build a pipeline for device detection cloud engine.
  • fiftyone.devicedetection.onpremise - A Node.js engine which retrieves engine results by consuming data from the 51Degrees data file. A on-premise builder is also included to build a pipeline for device detection on-premise engine.
  • fiftyone.devicedetection.shared - A Node.js module which contains shared functionality to build cloud and on-premise engines.

Installation

Using NPM call:

npm install fiftyone.devicedetection

Examples

For details of how to run the examples, please refer to run examples. The tables below describe the examples that are available.

Example Description
gettingStarted.js Getting started example of using the 51Degrees device detection 'Hash' algorithm to determine whether a given User-Agent corresponds to a mobile device or not.

Tests

In this repository, there are tests for the examples. You will need to install jest to run them:

npm install jest --global

You will also need to install any required packages for the examples in the Examples section.

You need to obtain a 51Degrees cloud resource key from the 51Degrees Cloud Configurator and assign it to the environment variable RESOURCE_KEY in your test environment.

To run the tests, navigate to the module directory and execute:

npm test