fiftyone.devicedetection 4.4.132 → 4.4.133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +18 -7
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -13,26 +13,35 @@ This package provides a generic `DeviceDetectionPipelineBuilder` which check the
|
|
|
13
13
|
|
|
14
14
|
This package requires the following additional packages:
|
|
15
15
|
|
|
16
|
-
- **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.
|
|
17
|
-
- **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.
|
|
18
|
-
- **fiftyone.devicedetection.shared** - A Node.js module which contains shared functionality to build cloud and on-premise engines.
|
|
16
|
+
- [**fiftyone.devicedetection.cloud**](/fiftyone.devicedetection.cloud#readme) - 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.
|
|
17
|
+
- [**fiftyone.devicedetection.onpremise**](/fiftyone.devicedetection.onpremise#readme) - 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.
|
|
18
|
+
- [**fiftyone.devicedetection.shared**](/fiftyone.devicedetection.shared#readme) - A Node.js module which contains shared functionality to build cloud and on-premise engines.
|
|
19
19
|
|
|
20
20
|
### Installation
|
|
21
21
|
|
|
22
22
|
Using NPM call:
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
```
|
|
25
|
+
npm install fiftyone.devicedetection
|
|
26
|
+
```
|
|
25
27
|
|
|
26
28
|
### Examples
|
|
27
29
|
|
|
28
|
-
|
|
30
|
+
For details of how to run the examples, please refer to [run examples](/run_examples.md).
|
|
31
|
+
The tables below describe the examples that are available.
|
|
32
|
+
|
|
33
|
+
| Example | Description |
|
|
34
|
+
|----------------------------------------|-------------|
|
|
35
|
+
| [gettingStarted.js](/fiftyone.devicedetection/examples/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.|
|
|
29
36
|
|
|
30
37
|
## Tests
|
|
31
38
|
|
|
32
39
|
In this repository, there are tests for the examples.
|
|
33
40
|
You will need to install jest to run them:
|
|
34
41
|
|
|
35
|
-
|
|
42
|
+
```
|
|
43
|
+
npm install jest --global
|
|
44
|
+
```
|
|
36
45
|
|
|
37
46
|
You will also need to install any required packages for the examples in the **Examples** section.
|
|
38
47
|
|
|
@@ -40,4 +49,6 @@ You need to obtain a 51Degrees cloud resource key from the [51Degrees Cloud Conf
|
|
|
40
49
|
|
|
41
50
|
To run the tests, navigate to the module directory and execute:
|
|
42
51
|
|
|
43
|
-
|
|
52
|
+
```
|
|
53
|
+
npm test
|
|
54
|
+
```
|