docs: ✏️ update doc

Inist-CNRS · Sep 8, 2023 · 49c2150 · 49c2150
1 parent 838ba71
commit 49c2150
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/docs/plugin-analytics.md b/docs/plugin-analytics.md
@@ -497,6 +497,7 @@ Output:
 #### Parameters
 
 -   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `identifier` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to use to set value result field (if not set or not exists, 1 is use as a default value) (optional, default `false`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
@@ -1248,7 +1249,7 @@ Output:
 
 -   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path (optional, default `value`)
 -   `aggregate` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** aggregate all values for all paths (or not) (optional, default `true`)
--   `identifier` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** path to use to set value result field (if not set or not exists, 1 is use as a default value) (optional, default `false`)
+-   `identifier` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to use to set value result field (if not set or not exists, 1 is use as a default value) (optional, default `false`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 

diff --git a/packages/analytics/README.md b/packages/analytics/README.md
@@ -497,6 +497,7 @@ Output:
 #### Parameters
 
 -   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `identifier` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to use to set value result field (if not set or not exists, 1 is use as a default value) (optional, default `false`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
@@ -1248,7 +1249,7 @@ Output:
 
 -   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path (optional, default `value`)
 -   `aggregate` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** aggregate all values for all paths (or not) (optional, default `true`)
--   `identifier` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** path to use to set value result field (if not set or not exists, 1 is use as a default value) (optional, default `false`)
+-   `identifier` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to use to set value result field (if not set or not exists, 1 is use as a default value) (optional, default `false`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 

diff --git a/packages/analytics/src/graph.js b/packages/analytics/src/graph.js
@@ -38,6 +38,7 @@ import core from './core';
  *
  * @name graph
  * @param {String} path
+ * @param {String} [identifier=false] path to use to set value result field (if not set or not exists, 1 is use as a default value)
  * @returns {Object}
  */
 export default function graph(data, feed) {

diff --git a/packages/analytics/src/segment.js b/packages/analytics/src/segment.js
@@ -80,7 +80,7 @@ import core from './core';
  * @name segment
  * @param {String} [path=value] path
  * @param {Boolean} [aggregate=true] aggregate all values for all paths (or not)
- * @param {Boolean} [identifier=false] path to use to set value result field (if not set or not exists, 1 is use as a default value)
+ * @param {String} [identifier=false] path to use to set value result field (if not set or not exists, 1 is use as a default value)
  * @returns {Object}
  */
 export default function segment(data, feed) {