querymon - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

dist/querymon.cjs.js

@@ -68,3 +68,3 @@ 'use strict';
     * OPTIONAL @param {string} options.userId - The userId to log for all events to override the userId provided in the constructor
-    * OPTIONAL @param {string} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
+    * OPTIONAL @param {int} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
    */
@@ -115,6 +115,6 @@ _createClass(Querymon, [{
      * REQUIRED @param  {list}    results - The list of the results returned from the search engine
-     *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', url: 'url for result'}]
+     *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', description: 'short description of the result', url: 'url for result'}]
      * OPTIONAL @param  {object}  options - An object of optional parameters
       * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-      * OPTIONAL @param   {string}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
+      * OPTIONAL @param   {int}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
      */
@@ -161,7 +161,7 @@ }, {
      * REQUIRED @param  {string}  query   - The search query
-     * REQUIRED @param  {string}  resultRow - The row for the result that was clicked
+     * REQUIRED @param  {int}  resultRow - The row for the result that was clicked
      * REQUIRED @param  {string}  resultName - The name of the result that was clicked
      * OPTIONAL @param  {object}  options - An object of optional parameters
       * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-      * OPTIONAL @param   {string}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
+      * OPTIONAL @param   {int}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
      */
@@ -209,3 +209,3 @@ }, {
      * OPTIONAL @param   {string}  options.userId     - The userId to log for all events to override the userId provided in the constructor
-     * OPTIONAL @param   {string}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
+     * OPTIONAL @param   {int}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
      */
@@ -212,0 +212,0 @@ }, {

dist/querymon.esm.js

@@ -64,3 +64,3 @@ import { v4 } from 'uuid';
     * OPTIONAL @param {string} options.userId - The userId to log for all events to override the userId provided in the constructor
-    * OPTIONAL @param {string} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
+    * OPTIONAL @param {int} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
    */
@@ -111,6 +111,6 @@ _createClass(Querymon, [{
      * REQUIRED @param  {list}    results - The list of the results returned from the search engine
-     *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', url: 'url for result'}]
+     *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', description: 'short description of the result', url: 'url for result'}]
      * OPTIONAL @param  {object}  options - An object of optional parameters
       * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-      * OPTIONAL @param   {string}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
+      * OPTIONAL @param   {int}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
      */
@@ -157,7 +157,7 @@ }, {
      * REQUIRED @param  {string}  query   - The search query
-     * REQUIRED @param  {string}  resultRow - The row for the result that was clicked
+     * REQUIRED @param  {int}  resultRow - The row for the result that was clicked
      * REQUIRED @param  {string}  resultName - The name of the result that was clicked
      * OPTIONAL @param  {object}  options - An object of optional parameters
       * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-      * OPTIONAL @param   {string}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
+      * OPTIONAL @param   {int}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
      */
@@ -205,3 +205,3 @@ }, {
      * OPTIONAL @param   {string}  options.userId     - The userId to log for all events to override the userId provided in the constructor
-     * OPTIONAL @param   {string}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
+     * OPTIONAL @param   {int}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
      */
@@ -208,0 +208,0 @@ }, {

dist/querymon.umd.js

@@ -133,3 +133,3 @@ (function (global, factory) {
       * OPTIONAL @param {string} options.userId - The userId to log for all events to override the userId provided in the constructor
-      * OPTIONAL @param {string} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
+      * OPTIONAL @param {int} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
      */
@@ -180,6 +180,6 @@ _createClass(Querymon, [{
        * REQUIRED @param  {list}    results - The list of the results returned from the search engine
-       *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', url: 'url for result'}]
+       *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', description: 'short description of the result', url: 'url for result'}]
        * OPTIONAL @param  {object}  options - An object of optional parameters
         * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-        * OPTIONAL @param   {string}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
+        * OPTIONAL @param   {int}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
        */
@@ -226,7 +226,7 @@ }, {
        * REQUIRED @param  {string}  query   - The search query
-       * REQUIRED @param  {string}  resultRow - The row for the result that was clicked
+       * REQUIRED @param  {int}  resultRow - The row for the result that was clicked
        * REQUIRED @param  {string}  resultName - The name of the result that was clicked
        * OPTIONAL @param  {object}  options - An object of optional parameters
         * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-        * OPTIONAL @param   {string}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
+        * OPTIONAL @param   {int}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
        */
@@ -274,3 +274,3 @@ }, {
        * OPTIONAL @param   {string}  options.userId     - The userId to log for all events to override the userId provided in the constructor
-       * OPTIONAL @param   {string}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
+       * OPTIONAL @param   {int}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
        */
@@ -277,0 +277,0 @@ }, {

package.json

 {
   "name": "querymon",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Javascript library for logging events for Querymon (https://querymon.com) search product analytics.",
@@ -5,0 +5,0 @@ "author": "Querymon <[e-mail]>",

src/index.js

@@ -35,3 +35,3 @@ /* Querymon JS is a light wrapper around the Querymon API.
     * OPTIONAL @param {string} options.userId - The userId to log for all events to override the userId provided in the constructor
-    * OPTIONAL @param {string} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
+    * OPTIONAL @param {int} options.queryTime - The time the query began (ms since 1970), defaults to the time of method invocation
    */
@@ -77,6 +77,6 @@ logSearch(query, options) {
    * REQUIRED @param  {list}    results - The list of the results returned from the search engine
-   *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', url: 'url for result'}]
+   *                              Example format: [{index: row number integer, entityId: 'identifier for the result', name: 'name of result string', description: 'short description of the result', url: 'url for result'}]
    * OPTIONAL @param  {object}  options - An object of optional parameters
     * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-    * OPTIONAL @param   {string}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
+    * OPTIONAL @param   {int}  options.resultReturnTime - The time the results were returned (ms since 1970), defaults to the time of method invocation
    */
@@ -119,7 +119,7 @@ logResults(query, results, options) {
    * REQUIRED @param  {string}  query   - The search query
-   * REQUIRED @param  {string}  resultRow - The row for the result that was clicked
+   * REQUIRED @param  {int}  resultRow - The row for the result that was clicked
    * REQUIRED @param  {string}  resultName - The name of the result that was clicked
    * OPTIONAL @param  {object}  options - An object of optional parameters
     * OPTIONAL @param   {string}  options.userId           - The userId to log for all events to override the userId provided in the constructor
-    * OPTIONAL @param   {string}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
+    * OPTIONAL @param   {int}  options.interactionTime - The time the result was clicked (ms since 1970), defaults to the time of method invocation
    */
@@ -163,3 +163,3 @@ logClick(query, resultRow, resultName, options) {
    * OPTIONAL @param   {string}  options.userId     - The userId to log for all events to override the userId provided in the constructor
-   * OPTIONAL @param   {string}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
+   * OPTIONAL @param   {int}  options.eventTime  - The time the conversion event occurred (ms since 1970), defaults to the time of method invocation
    */
@@ -166,0 +166,0 @@ logConversion(eventName, options) {

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

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

Improved metrics

Total package byte prevSize

45621

increased by0.29%

No dependency changes