51Degrees Device Detection for Node.js

DeviceDetectionCloudPipelineBuilder Class Reference

Detailed Description

Extension of pipelineBuilder class that allows for the quick generation of a device detection cloud pipeline.

Adds share usage, caching.

Examples
cloud/metadata-console/metaData.js, and cloud/useragentclienthints-web/userAgentClientHintsWeb.js.

Inheritance diagram for DeviceDetectionCloudPipelineBuilder:

[legend]

Collaboration diagram for DeviceDetectionCloudPipelineBuilder:

[legend]

Public Member Functions

 constructor ({ licenceKeys=null, resourceKey=null, cacheSize=null, cloudEndPoint=null, cloudRequestOrigin=null })
 Constructor for DeviceDetectionCloudPipelineBuilder.

Member Function Documentation

◆ constructor()

DeviceDetectionCloudPipelineBuilder::constructor ( { licenceKeys=null, resourceKey=null, cacheSize=null, cloudEndPoint=null, cloudRequestOrigin=null })
inline

Constructor for DeviceDetectionCloudPipelineBuilder.

Parameters
{object}options the options for the pipeline builder
{string}options.licenceKeys license key(s) used by the data file update service. A key can be obtained from the 51Degrees website: /pricing?utm_source=code&utm_medium=comment&utm_campaign=device-detection-node&utm_content=fiftyone.devicedetection.cloud-devicedetectioncloudpipelinebuilder.js&utm_term=constructor. This parameter MUST be set when using a data file. If you do not wish to use a key then you can specify an empty string, but this will cause automatic updates to be disabled.
{string}options.resourceKey resourceKey
{number}options.cacheSize size of the default cache (includes cache if set).
{string}options.cloudEndPoint Choose a non default endpoint for the cloud request engine
{string}options.cloudRequestOrigin The value to set the Origin header to when making requests to the cloud service
{boolean}[options.suppressProcessExceptions] If false (the default) the first error thrown while processing is re-thrown from flowData.process(); if true, errors are stored on flowData.errors and emitted via the pipeline 'error' event instead, and process() resolves normally. Recommended true for web apps so a device-detection failure degrades gracefully instead of failing the request.