diff --git a/docs/plugin-analytics.md b/docs/plugin-analytics.md index 8cd9ea14..d29c6552 100644 --- a/docs/plugin-analytics.md +++ b/docs/plugin-analytics.md @@ -1051,9 +1051,9 @@ meta = total #### Parameters - `indent` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** - (optional, default `false`) + (optional, default `false`) - `meta` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** - + Returns **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** @@ -1105,7 +1105,7 @@ path = arrival - `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`) - `null` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - + Returns **{id: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>, value: `1`}** @@ -1166,7 +1166,7 @@ path = year #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1216,9 +1216,9 @@ plugin = analytics #### Parameters - `id` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>}** @@ -1315,11 +1315,11 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (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`) + (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` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `false`) + (optional, default `false`) Returns **{id: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>, value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1385,9 +1385,9 @@ plugin = analytics #### Parameters - `start` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** - (optional, default `1`) + (optional, default `1`) - `size` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** - (optional, default `10`) + (optional, default `10`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -1447,9 +1447,9 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `reverse` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** - (optional, default `false`) + (optional, default `false`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -1559,9 +1559,9 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) - `target` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `_statistics`) + (optional, default `_statistics`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -1623,9 +1623,9 @@ plugin = analytics #### Parameters - `id` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1693,15 +1693,15 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `method` **(`"natural"` \| `"levenshtein"` \| `"numerical"`)** - - - - - - - (optional, default `natural`) + + + ul> + + + + (optional, default `natural`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1805,6 +1805,6 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) 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 index 8cd9ea14..d29c6552 100644 --- a/packages/analytics/README.md +++ b/packages/analytics/README.md @@ -1051,9 +1051,9 @@ meta = total #### Parameters - `indent` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** - (optional, default `false`) + (optional, default `false`) - `meta` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** - + Returns **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** @@ -1105,7 +1105,7 @@ path = arrival - `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`) - `null` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - + Returns **{id: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>, value: `1`}** @@ -1166,7 +1166,7 @@ path = year #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1216,9 +1216,9 @@ plugin = analytics #### Parameters - `id` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>}** @@ -1315,11 +1315,11 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (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`) + (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` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `false`) + (optional, default `false`) Returns **{id: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>, value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1385,9 +1385,9 @@ plugin = analytics #### Parameters - `start` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** - (optional, default `1`) + (optional, default `1`) - `size` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** - (optional, default `10`) + (optional, default `10`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -1447,9 +1447,9 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `reverse` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** - (optional, default `false`) + (optional, default `false`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -1559,9 +1559,9 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) - `target` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `_statistics`) + (optional, default `_statistics`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -1623,9 +1623,9 @@ plugin = analytics #### Parameters - `id` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1693,15 +1693,15 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `id`) + (optional, default `id`) - `method` **(`"natural"` \| `"levenshtein"` \| `"numerical"`)** - - - - - - - (optional, default `natural`) + + + ul> + + + + (optional, default `natural`) Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** @@ -1805,6 +1805,6 @@ plugin = analytics #### Parameters - `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** - (optional, default `value`) + (optional, default `value`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** diff --git a/packages/analytics/src/output.js b/packages/analytics/src/output.js index 2e3de1ce..5f3eadd86 100644 --- a/packages/analytics/src/output.js +++ b/packages/analytics/src/output.js @@ -100,11 +100,11 @@ const output = (data, feed, ctx) => { * * @name output * @param {Boolean} [indent=false] - * - * + * + * * @param {String} [meta] - * - * + * + * * @returns {String} */ export default { diff --git a/packages/analytics/src/pair.js b/packages/analytics/src/pair.js index 9b5b0c14..37f59577 100644 --- a/packages/analytics/src/pair.js +++ b/packages/analytics/src/pair.js @@ -83,8 +83,8 @@ const pair = (data, feed, ctx) => { * @name pair * @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) * @param {String} - * - * + * + * * @returns {{ * id: Array, * value: 1 diff --git a/packages/analytics/src/pluck.js b/packages/analytics/src/pluck.js index 19884614..a4a633ec 100644 --- a/packages/analytics/src/pluck.js +++ b/packages/analytics/src/pluck.js @@ -85,8 +85,8 @@ const pluck = (data, feed, ctx) => { * * @name pluck * @param {String} [path=id] - * - * + * + * * @returns {{ * id: String, * value: Object diff --git a/packages/analytics/src/reducing.js b/packages/analytics/src/reducing.js index d18728cb..ae0db5f9 100644 --- a/packages/analytics/src/reducing.js +++ b/packages/analytics/src/reducing.js @@ -74,11 +74,11 @@ const reducing = async (data, feed, ctx) => { * * @name reducing * @param {String} [id=id] - * - * + * + * * @param {String} [value=value] - * - * + * + * * @returns {{ * id: String, * value: Array diff --git a/packages/analytics/src/segment.js b/packages/analytics/src/segment.js index c04f413c..b5d161e8 100644 --- a/packages/analytics/src/segment.js +++ b/packages/analytics/src/segment.js @@ -138,14 +138,14 @@ const segment = (data, feed, ctx) => { * * @name segment * @param {String} [path=value] - * - * + * + * * @param {Boolean} [aggregate=true] aggregate all values for all paths (or not) - * - * + * + * * @param {String} [identifier=false] - * - * + * + * * @returns {{ * id: Array, * value: Object, diff --git a/packages/analytics/src/slice.js b/packages/analytics/src/slice.js index da387b33..3b0de5ed 100644 --- a/packages/analytics/src/slice.js +++ b/packages/analytics/src/slice.js @@ -88,11 +88,11 @@ const slice = (data, feed, ctx) => { * * @name slice * @param {Number} [start=1] - *
  • the beginning index of the specified portion of the stream
- *
  • l'indice de début de la partie spécifiée du flux
+ *
  • the beginning index of the specified portion of the stream
+ *
  • l'indice de début de la partie spécifiée du flux
* @param {Number} [size=10] - *
  • the size of the specified portion of the stream
- *
  • la taille de début de la partie spécifiée du flux
+ *
  • the size of the specified portion of the stream
+ *
  • la taille de début de la partie spécifiée du flux
* @returns {Object} */ export default slice; diff --git a/packages/analytics/src/sort.js b/packages/analytics/src/sort.js index 4580e95b..5c706809 100644 --- a/packages/analytics/src/sort.js +++ b/packages/analytics/src/sort.js @@ -113,11 +113,11 @@ const sort = async (data, feed, ctx) => { * * @name sort * @param {String} [path=id] - *
  • path of the element used to as reference for the sort
- *
  • chemin de l'élément utilisé comme référence pour le tri
+ *
  • path of the element used to as reference for the sort
+ *
  • chemin de l'élément utilisé comme référence pour le tri
* @param {boolean} [reverse=false] - *
  • sort in ascending or descending order
- *
  • trier par ordre croissant ou décroissant
+ *
  • sort in ascending or descending order
+ *
  • trier par ordre croissant ou décroissant
* @returns {Object} */ export default sort; diff --git a/packages/analytics/src/statistics.js b/packages/analytics/src/statistics.js index 6e2e589b..15103e37 100644 --- a/packages/analytics/src/statistics.js +++ b/packages/analytics/src/statistics.js @@ -221,11 +221,11 @@ const statistics = async (data, feed, ctx) => { * * @name statistics * @param {String} [path=value] - *
  • path of the element used to create the statistics
- *
  • chemin de l'élément utilisé pour créer les statistiques
+ *
  • path of the element used to create the statistics
+ *
  • chemin de l'élément utilisé pour créer les statistiques
* @param {String} [target=_statistics] - *
  • path of the statistics in the returned object
- *
  • chemin des stastistiques dans l'objet retourné
+ *
  • path of the statistics in the returned object
+ *
  • chemin des stastistiques dans l'objet retourné
* @returns {Object} */ export default statistics; \ No newline at end of file diff --git a/packages/analytics/src/summing.js b/packages/analytics/src/summing.js index 9fca015c..30445ce8 100644 --- a/packages/analytics/src/summing.js +++ b/packages/analytics/src/summing.js @@ -84,11 +84,11 @@ const summing = (data, feed, ctx) => { * * @name summing * @param {String} [id=id] - *
  • path of the element used to create the new identifier
- *
  • chemin de l'élément utilisé pour créer le nouvel identifiant
+ *
  • path of the element used to create the new identifier
+ *
  • chemin de l'élément utilisé pour créer le nouvel identifiant
* @param {String} [value=value] - *
  • path of the element to be summed
- *
  • chemin de l'élément qui doit être sommé
+ *
  • path of the element to be summed
+ *
  • chemin de l'élément qui doit être sommé
* @returns {{ * id: String, * value: Object diff --git a/packages/analytics/src/tune.js b/packages/analytics/src/tune.js index 3c687676..6009e9d9 100644 --- a/packages/analytics/src/tune.js +++ b/packages/analytics/src/tune.js @@ -148,17 +148,17 @@ const tune = (data, feed, ctx) => { * * @name tune * @param {String} [path=id] - *
  • path of the element used to create the unified identifier
- *
  • chemin de l'élément utilisé pour créer l'identifiant unifié
+ *
  • path of the element used to create the unified identifier
+ *
  • chemin de l'élément utilisé pour créer l'identifiant unifié
* @param {'natural' | 'levenshtein' | 'numerical'} [method=natural] - *
  • method used to create the unified identifier
- *
    • natural - Create a normalised identifier that is set to a fixed length
- *
    • levenshtein - Create an identifier based on the Levenshtein algorithm
- *
    • numerical - Create an identifier based on a numeric value
- *
  • méthode utilisée pour créer l'identifiant unifié
- *
    • natural - Crée un identifiant normalisé de longueur fixe
- *
    • levenshtein - Crée un identifiant basé sur l'algorithme de Levenshtein
- *
    • numerical - Crée un identifiant basé sur une valeur numérique
+ *
  • method used to create the unified identifier
+ *
    • natural - Create a normalised identifier that is set to a fixed length
+ *
    • levenshtein - Create an identifier based on the Levenshtein algorithm
+ * ul>
  • numerical - Create an identifier based on a numeric value
+ *
  • méthode utilisée pour créer l'identifiant unifié
+ *
    • natural - Crée un identifiant normalisé de longueur fixe
+ *
    • levenshtein - Crée un identifiant basé sur l'algorithme de Levenshtein
+ *
    • numerical - Crée un identifiant basé sur une valeur numérique
* @returns {{ * id: String, * value: Object diff --git a/packages/analytics/src/value.js b/packages/analytics/src/value.js index 44ac843b..1e8bd4ef 100644 --- a/packages/analytics/src/value.js +++ b/packages/analytics/src/value.js @@ -124,8 +124,8 @@ const value = (data, feed, ctx) => { * * @name value * @param {String} [path=value] - *
  • path of the element used to create the new object
- *
  • chemin de l'élément utilisé pour créer le nouvel objet
+ *
  • path of the element used to create the new object
+ *
  • chemin de l'élément utilisé pour créer le nouvel objet
* @returns {Object} */ export default value;