fiftyone.pipeline.core - npm Package Compare versions

Comparing version 4.4.92 to 4.4.93

examples/customFlowElements/clientSideEvidenceFlowElement.js

@@ -24,13 +24,13 @@ /* *********************************************************************
 /**
-@example clientSideEvidenceFlowElement.js
-
-This example demonstrates the creation of a custom flow element
-which takes the results of a client side form collecting
-date of birth, setting this as evidence on a flowData object
-to calculate a person's starsign.
-The flowElement also serves additional JavaScript which gets a
-user's geolocation and saves the latitude as a cookie.
-This latitude is also then passed in to the flowData to
-calculate if a person is in the northern or southern hemispheres.
-
+ * @example clientSideEvidenceFlowElement.js
+ *
+ * This example demonstrates the creation of a custom flow element
+ * which takes the results of a client side form collecting
+ * date of birth, setting this as evidence on a flowData object
+ * to calculate a person's starsign.
+ * The flowElement also serves additional JavaScript which gets a
+ * user's geolocation and saves the latitude as a cookie.
+ * This latitude is also then passed in to the flowData to
+ * calculate if a person is in the northern or southern hemispheres.
+ *
  */
@@ -37,0 +37,0 @@

examples/customFlowElements/simpleEvidenceFlowElement.js

@@ -24,8 +24,8 @@ /* *********************************************************************
 /**
-@example simpleEvidenceFlowElement.js
-
-This example demonstrates the creation of a custom flowElement
-which takes a birth date as evidence and uses it to check a
-lookup table for a starsign.
-
+ * @example simpleEvidenceFlowElement.js
+ *
+ * This example demonstrates the creation of a custom flowElement
+ * which takes a birth date as evidence and uses it to check a
+ * lookup table for a starsign.
+ *
  */
@@ -32,0 +32,0 @@

examples/pipelines.js

@@ -24,7 +24,7 @@ /* *********************************************************************
 /**
-@example pipelines.js
-
-This example demonstrates syncronous and asyncronous pipelines
-with multiple flowElements and other core features of the 51Degrees pipeline
-
+ * @example pipelines.js
+ *
+ * This example demonstrates syncronous and asyncronous pipelines
+ * with multiple flowElements and other core features of the 51Degrees pipeline
+ *
  */
@@ -31,0 +31,0 @@

flowElement.js

@@ -93,3 +93,3 @@ /* *********************************************************************
    *
-   * @returns {Promise}
+   * @returns {Promise} returns Promise
    * */
@@ -96,0 +96,0 @@ ready () {

helpers.js

@@ -27,7 +27,5 @@ /* *********************************************************************
    *
-   * @param response: The response to set the headers in.
-   * @param flowData: A processed FlowData instance to get the response header values
+   * @param {http.ServerResponse} response The response to set the headers in.
+   * @param {FlowData} flowData A processed FlowData instance to get the response header values
    * from.
-   * @param response
-   * @param flowData
    */
@@ -34,0 +32,0 @@ static setResponseHeaders (response, flowData) {

package.json

 {
   "name": "fiftyone.pipeline.core",
-  "version": "4.4.92",
+  "version": "4.4.93",
   "description": "Core library for the 51Degrees Pipeline API",
@@ -5,0 +5,0 @@ "keywords": [

pipeline.js

@@ -28,2 +28,3 @@ /* *********************************************************************
  * @typedef {import('./flowElement')} FlowElement
+ * @typedef {import('../fiftyone.pipeline.engines/dataFileUpdateService')} DataFileUpdateService
  */
@@ -44,3 +45,3 @@
    * will suppress exceptions added to FlowData.
-   * @param dataFileUpdateService
+   * @param {DataFileUpdateService} dataFileUpdateService Service that registers FlowElements
    */
@@ -223,4 +224,5 @@ constructor (flowElements = [], suppressProcessExceptions = false, dataFileUpdateService = null) {
   /**
+   *  Update pipeline's property database for FlowElement
    *
-   * @param {FlowElement} flowElement
+   * @param {FlowElement} flowElement FlowElement to update
    * @returns {void}
@@ -227,0 +229,0 @@ */

pipelineBuilder.js

@@ -52,5 +52,5 @@ /* *********************************************************************
    * HTTP headers from the client side. This is true by default.
-   * @param {typeof import('./javascriptbuilder').prototype.settings}
-   * settings.javascriptBuilderSettings The settings
-   * to pass to the JavaScriptBuilder. See JavaScriptBuilder class for details.
+   * @param {typeof import('./javascriptbuilder').prototype.settings} settings.javascriptBuilderSettings
+   * The settings to pass to the JavaScriptBuilder.
+   * See JavaScriptBuilder class for details.
    */
@@ -57,0 +57,0 @@ constructor (settings = {}) {

setHeadersElement.js

@@ -55,4 +55,3 @@ /* *********************************************************************
    *
-   * @param {string} propertyName: To get the header name from.
-   * @param propertyName
+   * @param {string} propertyName To get the header name from.
    * @returns {string} Header name.
@@ -85,4 +84,3 @@ */
    *
-   * @param {Pipeline} pipeline: The pipeline instance to get the properties from.
-   * @param pipeline
+   * @param {Pipeline} pipeline The pipeline instance to get the properties from.
    * @returns {object} Collection of headers which can be set in the response.
@@ -133,5 +131,4 @@ */
    *
-   * @param {FlowData} flowData: A processed FlowData instance to get the response header values
+   * @param {FlowData} flowData A processed FlowData instance to get the response header values
    * from.
-   * @param flowData
    * @returns {object} A dictionary of response header names with their values if they are not
@@ -143,3 +140,3 @@ * null
     for (const [, header] of Object.entries(this.headers)) {
-      var headerValue = new Set();
+      const headerValue = new Set();
       header.properties.forEach(property => {
@@ -167,8 +164,5 @@ const keys = property.split('.');
    *
-   * @param {FlowData} flowData: A processed FlowData instance to get the value from.
-   * @param {string} elementKey: Key for the element data to get the value from.
-   * @param {string} propertyKey: Name of the property to get the value for.
-   * @param flowData
-   * @param elementKey
-   * @param propertyKey
+   * @param {FlowData} flowData A processed FlowData instance to get the value from.
+   * @param {string} elementKey Key for the element data to get the value from.
+   * @param {string} propertyKey Name of the property to get the value for.
    * @returns {string | undefined} value string or undefined.
@@ -175,0 +169,0 @@ */

tests/jsoutput.js

@@ -80,6 +80,6 @@ /* *********************************************************************
 
-  // Delete a cookie.
   /**
+   * Delete a cookie.
    *
-   * @param name
+   * @param {string} name Name of a cookie
    */
@@ -202,3 +202,3 @@ function deleteCookie (name) { // eslint-disable-line
       for (const i in data[key]) {
-        var obj = self[key];
+        const obj = self[key];
         (function (i) {
@@ -205,0 +205,0 @@ Object.defineProperty(obj, i, {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 2 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

214390

increased by0.01%

No dependency changes