fiftyone.pipeline.engines - npm Package Compare versions

Comparing version 4.4.98 to 4.4.99

package.json

 {
   "name": "fiftyone.pipeline.engines",
-  "version": "4.4.98",
+  "version": "4.4.99",
   "description": "Shared base functionality for implementing engines for the 51Degrees Pipeline API",
@@ -5,0 +5,0 @@ "keywords": [

readme.md

@@ -11,3 +11,3 @@ ![51Degrees](https://51degrees.com/img/logo.png?utm_source=github&utm_medium=repository&utm_content=readme_main&utm_campaign=node-open-source "Data rewards the curious") **51Degrees Pipeline Engines**
 
-This package extends the `flow element` class created by the `fiftyone.pipeline.core` pacakge into a specialized type of flow element called an engine. This allows for additional features including:
+This package extends the `flow element` class created by the [`fiftyone.pipeline.core`](/fiftyone.pipeline.core#readme.md) pacakge into a specialized type of flow element called an engine. This allows for additional features including:
 
@@ -20,9 +20,9 @@ * An auto-updating data file for properties
 
-- **fiftyone.devicedetection** - A device detection engine
-- **fiftyone.location** - A geolocation lookup engine
+- [**fiftyone.devicedetection**](https://github.com/51Degrees/device-detection-node#readme) - A device detection engine
+- [**fiftyone.geolocation**](https://github.com/51Degrees/location-node#readme) - A geolocation lookup engine
 
 Make use of this package along with the following additional packages:
 
-- **fiftyone.pipeline.engines.fiftyone** - Functionality specific to 51Degrees engines.
-- **fiftyone.pipeline.cloudrequestengine** - An engine used to make requests to the 51Degrees cloud service.
+- [**fiftyone.pipeline.engines.fiftyone**](/fiftyone.pipeline.engines.fiftyone#readme.md) - Functionality specific to 51Degrees engines.
+- [**fiftyone.pipeline.cloudrequestengine**](/fiftyone.pipeline.cloudrequestengine#readme.md) - An engine used to make requests to the 51Degrees cloud service.
 
@@ -35,2 +35,11 @@ ## Installation
 
+## Examples
+
+Examples can be found in the `examples/` folder. See below for a list of examples.
+
+| Example                                | Description |
+|----------------------------------------|-------------|
+| [onPremiseFlowElement.js](/fiftyone.pipeline.engines/examples/onPremiseFlowElement.js)                  |  Demonstrates the creation of an engine that uses an auto-updating datafile to populate properties. |
+| [caching.js](/fiftyone.pipeline.engines/examples/caching.js)                 | Demonstrates a custom cache that makes use of the result caching feature that engines provide. |
+
 ## Tests
@@ -49,6 +58,1 @@
 ```
-
-## Examples
-
-- **examples/onPremiseFlowElement.js** - Demonstrates the creation of an engine that uses an auto-updating datafile to populate properties
-- **examples/caching.js** - Demonstrates a custom cache that makes use of the result caching feature that engines provide.

types/index.d.ts

@@ -10,2 +10,2 @@ export const AspectData: typeof import("./aspectData");
 export const Tracker: typeof import("./tracker");
-export const DataFileUpdateService: typeof import("./dataFileUpdateService");
+// export const DataFileUpdateService: typeof import("./dataFileUpdateService");

No alert changes

Improved metrics

Total package byte prevSize

88749

increased by0.66%

Number of lines in readme file

55

increased by7.84%

No dependency changes