fiftyone.pipeline.core 4.4.97 → 4.4.99
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 +14 -10
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,17 +11,17 @@ This package definds the essential components of the Pipeline API such as `flow
|
|
|
11
11
|
|
|
12
12
|
It can be used on its own or with the following additional packages.
|
|
13
13
|
|
|
14
|
-
- **fiftyone.pipeline.engines** - Adds a specialized type of flow element called an engine which allows for additional features including an auto-updating data file for properties, a service called when a requested property is missing and a caching system.
|
|
14
|
+
- [**fiftyone.pipeline.engines**](/fiftyone.pipeline.engines#readme.md) - Adds a specialized type of flow element called an engine which allows for additional features including an auto-updating data file for properties, a service called when a requested property is missing and a caching system.
|
|
15
15
|
|
|
16
16
|
Engines created by 51Degrees including:
|
|
17
17
|
|
|
18
|
-
- **fiftyone.devicedetection** - A device detection engine
|
|
19
|
-
- **fiftyone.location
|
|
18
|
+
- [**fiftyone.devicedetection**](https://github.com/51Degrees/device-detection-node#readme) - A device detection engine
|
|
19
|
+
- [**fiftyone.geolocation**](https://github.com/51Degrees/location-node#readme) - A geolocation lookup engine
|
|
20
20
|
|
|
21
21
|
Make use of the above along with the following additional packages:
|
|
22
22
|
|
|
23
|
-
- **fiftyone.pipeline.engines.fiftyone** - Functionality specific to 51Degrees engines.
|
|
24
|
-
- **fiftyone.pipeline.cloudrequestengine** - An engine used to make requests to the 51Degrees cloud service.
|
|
23
|
+
- [**fiftyone.pipeline.engines.fiftyone**](/fiftyone.pipeline.engines.fiftyone#readme.md) - Functionality specific to 51Degrees engines.
|
|
24
|
+
- [**fiftyone.pipeline.cloudrequestengine**](/fiftyone.pipeline.cloudrequestengine#readme.md) - An engine used to make requests to the 51Degrees cloud service.
|
|
25
25
|
|
|
26
26
|
## Installation
|
|
27
27
|
|
|
@@ -29,6 +29,15 @@ Make use of the above along with the following additional packages:
|
|
|
29
29
|
npm install fiftyone.pipeline.core
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
+
## Examples
|
|
33
|
+
|
|
34
|
+
Examples can be found in the `examples/` folder. See below for a list of examples.
|
|
35
|
+
|
|
36
|
+
| Example | Description |
|
|
37
|
+
|----------------------------------------|-------------|
|
|
38
|
+
| [simpleEvidenceFlowElement.js](/fiftyone.pipeline.core/examples/customFlowElements/simpleEvidenceFlowElement.js) | Demonstrates how to create a custom flow element that takes some evidence (birthdate) and returns something related to that evidence (star sign). |
|
|
39
|
+
| [clientSideEvidenceFlowElement.js](/fiftyone.pipeline.core/examples/customFlowElements/clientSideEvidenceFlowElement.js) | Demonstrates how to modify the flow element from the 'simple evidence' example to gather evidence from code running on the client device (i.e. JavaScript). |
|
|
40
|
+
|
|
32
41
|
## Tests
|
|
33
42
|
|
|
34
43
|
To run tests you will need to install the `jest` library.
|
|
@@ -42,8 +51,3 @@ Then, navigate to the module directory and execute:
|
|
|
42
51
|
```
|
|
43
52
|
npm test
|
|
44
53
|
```
|
|
45
|
-
|
|
46
|
-
## Examples
|
|
47
|
-
|
|
48
|
-
- **examples/customFlowElements/1-simpleEvidenceFlowElement.js** - Demonstrates how to create a custom flow element that takes some evidence (birthdate) and returns something related to that evidence (star sign)
|
|
49
|
-
- **examples/customFlowelements/3-clientSideEvidenceFlowElement.js** - Demonstrates how to modify the flow element from the 'simple evidence' example to gather evidence from code running on the client device (i.e. JavaScript).
|