From 59bc7f5a9de9568e299354af1c4fadb668add584 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Parmentier?= Date: Fri, 23 Jul 2021 11:26:20 +0200 Subject: [PATCH] docs(transformers): Slightly improve JSDoc --- docs/plugin-transformers.md | 170 ++++++++++++------ packages/transformers/README.md | 170 ++++++++++++------ packages/transformers/src/dollar-array.js | 25 ++- packages/transformers/src/dollar-boolean.js | 35 +++- packages/transformers/src/dollar-column.js | 5 +- .../transformers/src/dollar-concat-uri.js | 9 +- packages/transformers/src/dollar-concat.js | 4 +- packages/transformers/src/dollar-default.js | 4 +- packages/transformers/src/dollar-format.js | 4 +- packages/transformers/src/dollar-get.js | 6 +- packages/transformers/src/dollar-join.js | 4 +- packages/transformers/src/dollar-lowercase.js | 2 +- packages/transformers/src/dollar-mapping.js | 6 +- packages/transformers/src/dollar-mask.js | 4 +- packages/transformers/src/dollar-number.js | 4 +- packages/transformers/src/dollar-parse.js | 2 +- packages/transformers/src/dollar-prefix.js | 4 +- packages/transformers/src/dollar-remove.js | 4 +- .../transformers/src/dollar-replace-regex.js | 7 +- packages/transformers/src/dollar-replace.js | 7 +- packages/transformers/src/dollar-select.js | 9 +- packages/transformers/src/dollar-shift.js | 4 +- packages/transformers/src/dollar-split.js | 5 +- packages/transformers/src/dollar-string.js | 2 +- packages/transformers/src/dollar-suffix.js | 4 +- packages/transformers/src/dollar-trim.js | 2 +- .../transformers/src/dollar-truncate-words.js | 2 +- packages/transformers/src/dollar-truncate.js | 5 +- packages/transformers/src/dollar-uniq.js | 2 +- packages/transformers/src/dollar-uppercase.js | 2 +- packages/transformers/src/dollar-urlencode.js | 2 +- packages/transformers/src/dollar-value.js | 4 +- 32 files changed, 342 insertions(+), 177 deletions(-) diff --git a/docs/plugin-transformers.md b/docs/plugin-transformers.md index 4a0cd07f..af8a1142 100644 --- a/docs/plugin-transformers.md +++ b/docs/plugin-transformers.md @@ -123,13 +123,36 @@ Exemple : ```ini [$ARRAY] field = keywords + +[exchange] +value = omit('$origin') +``` + +Entrée: + +```json +[{ + "keywords": "un" +}, { + "keywords": "deux" +}] +``` + +Sortie: + +```json +[{ + "keywords": ["un"] +}, { + "keywords": ["deux"] +}] ``` #### Parameters - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -142,13 +165,46 @@ Exemple : ```ini [$BOOLEAN] field = haveMoney + +[exchange] +value = omit('$origin') +``` + +Entrée: + +```json +[{ + "name": "Chuck", + "haveMoney": 10000 +}, { + "name": "Charlot", + "haveMoney": "yes" +}, { + "name": "Alan", + "haveMoney": 1 +}] +``` + +Sortie: + +```json +[{ + "name": "Chuck", + "haveMoney": false +}, { + "name": "Charlot", + "haveMoney": true +}, { + "name": "Alan", + "haveMoney": true +}] ``` #### Parameters - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -187,8 +243,8 @@ column = oldTitle - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use during the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use during the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -209,14 +265,14 @@ columns = part2 - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the transformation -- `columns` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get value +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the transformation +- `columns` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get value Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $CONCAT_URI -compoer un identifiant avec plusieurs champs +composer un identifiant avec plusieurs champs Exemple : @@ -232,9 +288,9 @@ separator = - - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the transformation -- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get data -- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** glue between each column +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the transformation +- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get data +- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** glue between each column Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -254,8 +310,8 @@ alternative = not available - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `alternative` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use if field does not exist +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `alternative` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use if field does not exist Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -273,14 +329,14 @@ with = (%s:%s) - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get data source (must be an array) -- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** template string like sprintf +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get data source (must be an array) +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** template string like sprintf Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $GET -Récupére toutes les valeurs correspondant à un chemin (dot path) +Récupère toutes les valeurs correspondant à un chemin (dot path) Exemple : @@ -294,8 +350,8 @@ path = input - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the transformation -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get value +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the transformation +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get value Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -315,8 +371,8 @@ path = input - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation (must be an array) -- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** glue between each field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation (must be an array) +- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** glue between each field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -335,14 +391,14 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $MAPPING Opération permettant le remplacement à partir d'une table -(équivalent à l'enchaînement de plusieurs opération REPLACE) +(équivalent à l'enchaînement de plusieurs opérations [$REPLACE](#replace)) Exemple : @@ -356,8 +412,8 @@ list = "hello":"bonjour", "hi":"salut" - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `list` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** the mapping list +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `list` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the mapping list Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -377,8 +433,8 @@ with = ^[a-z]+$ - `data` - `feed` -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the control -- `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use during the transformation +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the control +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** regular expression to check Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -397,7 +453,7 @@ field = counter - `data` - `feed` -- `feild` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -416,7 +472,7 @@ field = json - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -436,8 +492,8 @@ with = # - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `vith` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to add at the begining of the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to add at the begining of the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -457,8 +513,8 @@ the = . - `data` - `feed` -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `the` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value todrop in the field +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `the` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to drop in the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -479,9 +535,9 @@ replaceValue = un - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to search -- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to replace with +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to search +- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to replace with Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -502,30 +558,30 @@ replaceValue = bonjour - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** regex to search -- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to replace with +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** regex to search +- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to replace with Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $SELECT -Prendre une valeir dans un objet à partir de son chemin (dot path) +Prendre une valeur dans un objet à partir de son chemin (dot path) Exemple : ```ini [$SELECT] field = title -path +path = en ``` #### Parameters - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the selection -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get value +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the selection +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get value Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -545,8 +601,8 @@ gap = 2 - `data` - `feed` -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** how many item or characters to drop +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** how many items or characters to drop Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -566,8 +622,8 @@ separator = | - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use to split the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use to split the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -586,7 +642,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -606,8 +662,8 @@ with = ! - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to add at the end of the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to add at the end of the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -626,7 +682,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -646,15 +702,15 @@ gap = 25 - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** how many items or characters to keep +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** how many items or characters to keep Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $TRUNCATE_WORDS Opération permettant la troncature par nombre de mots -et non pas par nombre de caractères comme pour opération TRUNCATE +et non pas par nombre de caractères comme pour l'opération [$TRUNCATE](#truncate) Exemple : @@ -688,7 +744,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation (must be an aarray) +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation (must be an aarray) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -707,7 +763,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -726,7 +782,7 @@ field = url - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -746,7 +802,7 @@ value = Hello world - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** new field path -- `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use to set the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** new field path +- `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use to set the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** diff --git a/packages/transformers/README.md b/packages/transformers/README.md index 4a0cd07f..af8a1142 100644 --- a/packages/transformers/README.md +++ b/packages/transformers/README.md @@ -123,13 +123,36 @@ Exemple : ```ini [$ARRAY] field = keywords + +[exchange] +value = omit('$origin') +``` + +Entrée: + +```json +[{ + "keywords": "un" +}, { + "keywords": "deux" +}] +``` + +Sortie: + +```json +[{ + "keywords": ["un"] +}, { + "keywords": ["deux"] +}] ``` #### Parameters - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -142,13 +165,46 @@ Exemple : ```ini [$BOOLEAN] field = haveMoney + +[exchange] +value = omit('$origin') +``` + +Entrée: + +```json +[{ + "name": "Chuck", + "haveMoney": 10000 +}, { + "name": "Charlot", + "haveMoney": "yes" +}, { + "name": "Alan", + "haveMoney": 1 +}] +``` + +Sortie: + +```json +[{ + "name": "Chuck", + "haveMoney": false +}, { + "name": "Charlot", + "haveMoney": true +}, { + "name": "Alan", + "haveMoney": true +}] ``` #### Parameters - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -187,8 +243,8 @@ column = oldTitle - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use during the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use during the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -209,14 +265,14 @@ columns = part2 - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the transformation -- `columns` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get value +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the transformation +- `columns` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get value Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $CONCAT_URI -compoer un identifiant avec plusieurs champs +composer un identifiant avec plusieurs champs Exemple : @@ -232,9 +288,9 @@ separator = - - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the transformation -- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get data -- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** glue between each column +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the transformation +- `column` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get data +- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** glue between each column Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -254,8 +310,8 @@ alternative = not available - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `alternative` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use if field does not exist +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `alternative` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use if field does not exist Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -273,14 +329,14 @@ with = (%s:%s) - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get data source (must be an array) -- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** template string like sprintf +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get data source (must be an array) +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** template string like sprintf Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $GET -Récupére toutes les valeurs correspondant à un chemin (dot path) +Récupère toutes les valeurs correspondant à un chemin (dot path) Exemple : @@ -294,8 +350,8 @@ path = input - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the transformation -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get value +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the transformation +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get value Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -315,8 +371,8 @@ path = input - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation (must be an array) -- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** glue between each field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation (must be an array) +- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** glue between each field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -335,14 +391,14 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $MAPPING Opération permettant le remplacement à partir d'une table -(équivalent à l'enchaînement de plusieurs opération REPLACE) +(équivalent à l'enchaînement de plusieurs opérations [$REPLACE](#replace)) Exemple : @@ -356,8 +412,8 @@ list = "hello":"bonjour", "hi":"salut" - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `list` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** the mapping list +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `list` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the mapping list Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -377,8 +433,8 @@ with = ^[a-z]+$ - `data` - `feed` -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the control -- `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use during the transformation +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the control +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** regular expression to check Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -397,7 +453,7 @@ field = counter - `data` - `feed` -- `feild` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -416,7 +472,7 @@ field = json - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -436,8 +492,8 @@ with = # - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `vith` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to add at the begining of the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to add at the begining of the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -457,8 +513,8 @@ the = . - `data` - `feed` -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `the` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value todrop in the field +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `the` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to drop in the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -479,9 +535,9 @@ replaceValue = un - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to search -- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to replace with +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to search +- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to replace with Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -502,30 +558,30 @@ replaceValue = bonjour - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** regex to search -- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to replace with +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `searchValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** regex to search +- `replaceValue` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to replace with Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $SELECT -Prendre une valeir dans un objet à partir de son chemin (dot path) +Prendre une valeur dans un objet à partir de son chemin (dot path) Exemple : ```ini [$SELECT] field = title -path +path = en ``` #### Parameters - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get the result of the selection -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to get value +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get the result of the selection +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to get value Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -545,8 +601,8 @@ gap = 2 - `data` - `feed` -- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** how many item or characters to drop +- `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** how many items or characters to drop Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -566,8 +622,8 @@ separator = | - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use to split the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `separator` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use to split the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -586,7 +642,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -606,8 +662,8 @@ with = ! - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to add at the end of the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `with` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to add at the end of the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -626,7 +682,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -646,15 +702,15 @@ gap = 25 - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation -- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** how many items or characters to keep +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation +- `gap` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** how many items or characters to keep Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### $TRUNCATE_WORDS Opération permettant la troncature par nombre de mots -et non pas par nombre de caractères comme pour opération TRUNCATE +et non pas par nombre de caractères comme pour l'opération [$TRUNCATE](#truncate) Exemple : @@ -688,7 +744,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation (must be an aarray) +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation (must be an aarray) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -707,7 +763,7 @@ field = title - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -726,7 +782,7 @@ field = url - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** field path to apply the transformation +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** field path to apply the transformation Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** @@ -746,7 +802,7 @@ value = Hello world - `data` - `feed` -- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** new field path -- `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** value to use to set the field +- `field` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** new field path +- `value` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** value to use to set the field Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** diff --git a/packages/transformers/src/dollar-array.js b/packages/transformers/src/dollar-array.js index 68432c1d..ecbb0f6a 100644 --- a/packages/transformers/src/dollar-array.js +++ b/packages/transformers/src/dollar-array.js @@ -9,9 +9,32 @@ import dollar from './dollar'; * ```ini * [$ARRAY] * field = keywords + * + * [exchange] + * value = omit('$origin') + * ``` + * + * Entrée: + * + * ```json + * [{ + * "keywords": "un" + * }, { + * "keywords": "deux" + * }] + * ``` + * + * Sortie: + * + * ```json + * [{ + * "keywords": ["un"] + * }, { + * "keywords": ["deux"] + * }] * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $ARRAY(data, feed) { diff --git a/packages/transformers/src/dollar-boolean.js b/packages/transformers/src/dollar-boolean.js index 42e5d3f0..3f20c09a 100644 --- a/packages/transformers/src/dollar-boolean.js +++ b/packages/transformers/src/dollar-boolean.js @@ -9,9 +9,42 @@ import dollar from './dollar'; * ```ini * [$BOOLEAN] * field = haveMoney + * + * [exchange] + * value = omit('$origin') + * ``` + * + * Entrée: + * + * ```json + * [{ + * "name": "Chuck", + * "haveMoney": 10000 + * }, { + * "name": "Charlot", + * "haveMoney": "yes" + * }, { + * "name": "Alan", + * "haveMoney": 1 + * }] + * ``` + * + * Sortie: + * + * ```json + * [{ + * "name": "Chuck", + * "haveMoney": false + * }, { + * "name": "Charlot", + * "haveMoney": true + * }, { + * "name": "Alan", + * "haveMoney": true + * }] * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $BOOLEAN(data, feed) { diff --git a/packages/transformers/src/dollar-column.js b/packages/transformers/src/dollar-column.js index afdbac9f..050c0b30 100644 --- a/packages/transformers/src/dollar-column.js +++ b/packages/transformers/src/dollar-column.js @@ -11,8 +11,9 @@ import dollar from './dollar'; * field = newTitle * column = oldTitle * ``` - * @param {String} [field] field path to apply the transformation - * @param {String} [column] value to use during the transformation + * + * @param {String} field field path to apply the transformation + * @param {String} column value to use during the transformation * @returns {Object} */ export default function $COLUMN(data, feed) { diff --git a/packages/transformers/src/dollar-concat-uri.js b/packages/transformers/src/dollar-concat-uri.js index 80e94539..cc7b7684 100644 --- a/packages/transformers/src/dollar-concat-uri.js +++ b/packages/transformers/src/dollar-concat-uri.js @@ -2,7 +2,7 @@ import transformer from './operations/CONCAT_URI'; import dollar from './dollar'; /** - * compoer un identifiant avec plusieurs champs + * composer un identifiant avec plusieurs champs * * Exemple : * @@ -13,9 +13,10 @@ import dollar from './dollar'; * column = prenom * separator = - * ``` - * @param {String} [field] field path to get the result of the transformation - * @param {String} [column] field path to get data - * @param {String} [separator] glue between each column + * + * @param {String} field field path to get the result of the transformation + * @param {String} column field path to get data + * @param {String} separator glue between each column * @returns {Object} */ export default function $CONCAT_URI(data, feed) { diff --git a/packages/transformers/src/dollar-concat.js b/packages/transformers/src/dollar-concat.js index 2b1cf37c..b200b94a 100644 --- a/packages/transformers/src/dollar-concat.js +++ b/packages/transformers/src/dollar-concat.js @@ -13,8 +13,8 @@ import dollar from './dollar'; * columns = part2 * ``` * - * @param {String} [field] field path to get the result of the transformation - * @param {String} [columns] field path to get value + * @param {String} field field path to get the result of the transformation + * @param {String} columns field path to get value * @returns {Object} */ export default function $CONCAT(data, feed) { diff --git a/packages/transformers/src/dollar-default.js b/packages/transformers/src/dollar-default.js index dc180e31..9e6599e5 100644 --- a/packages/transformers/src/dollar-default.js +++ b/packages/transformers/src/dollar-default.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * alternative = not available * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [alternative] value to use if field does not exist + * @param {String} field field path to apply the transformation + * @param {String} alternative value to use if field does not exist * @returns {Object} */ export default function $DEFAULT(data, feed) { diff --git a/packages/transformers/src/dollar-format.js b/packages/transformers/src/dollar-format.js index 6074b318..0fd5c42c 100644 --- a/packages/transformers/src/dollar-format.js +++ b/packages/transformers/src/dollar-format.js @@ -10,8 +10,8 @@ import dollar from './dollar'; * with = (%s:%s) * ``` * - * @param {String} [field] field path to get data source (must be an array) - * @param {String} [with] template string like sprintf + * @param {String} field field path to get data source (must be an array) + * @param {String} with template string like sprintf * @returns {Object} */ export default function $FORMAT(data, feed) { diff --git a/packages/transformers/src/dollar-get.js b/packages/transformers/src/dollar-get.js index 70f536d2..957722f2 100644 --- a/packages/transformers/src/dollar-get.js +++ b/packages/transformers/src/dollar-get.js @@ -2,7 +2,7 @@ import transformer from './operations/GET'; import dollar from './dollar'; /** - * Récupére toutes les valeurs correspondant à un chemin (dot path) + * Récupère toutes les valeurs correspondant à un chemin (dot path) * * Exemple : * @@ -12,8 +12,8 @@ import dollar from './dollar'; * path = input * ``` * - * @param {String} [field] field path to get the result of the transformation - * @param {String} [path] field path to get value + * @param {String} field field path to get the result of the transformation + * @param {String} path field path to get value * @returns {Object} */ export default function $GET(data, feed) { diff --git a/packages/transformers/src/dollar-join.js b/packages/transformers/src/dollar-join.js index 6041178f..e3e4f9ce 100644 --- a/packages/transformers/src/dollar-join.js +++ b/packages/transformers/src/dollar-join.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * path = input * ``` * - * @param {String} [field] field path to apply the transformation (must be an array) - * @param {String} [separator] glue between each field + * @param {String} field field path to apply the transformation (must be an array) + * @param {String} separator glue between each field * @returns {Object} */ export default function $JOIN(data, feed) { diff --git a/packages/transformers/src/dollar-lowercase.js b/packages/transformers/src/dollar-lowercase.js index f186418b..fbe18d66 100644 --- a/packages/transformers/src/dollar-lowercase.js +++ b/packages/transformers/src/dollar-lowercase.js @@ -11,7 +11,7 @@ import dollar from './dollar'; * field = title * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $LOWERCASE(data, feed) { diff --git a/packages/transformers/src/dollar-mapping.js b/packages/transformers/src/dollar-mapping.js index f5350213..23eed735 100644 --- a/packages/transformers/src/dollar-mapping.js +++ b/packages/transformers/src/dollar-mapping.js @@ -3,7 +3,7 @@ import dollar from './dollar'; /** * Opération permettant le remplacement à partir d'une table - * (équivalent à l'enchaînement de plusieurs opération REPLACE) + * (équivalent à l'enchaînement de plusieurs opérations {@link $REPLACE}) * * Exemple : * @@ -13,8 +13,8 @@ import dollar from './dollar'; * list = "hello":"bonjour", "hi":"salut" * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [list] the mapping list + * @param {String} field field path to apply the transformation + * @param {String} list the mapping list * @returns {Object} */ export default function $MAPPING(data, feed) { diff --git a/packages/transformers/src/dollar-mask.js b/packages/transformers/src/dollar-mask.js index 5f86ce81..ae175336 100644 --- a/packages/transformers/src/dollar-mask.js +++ b/packages/transformers/src/dollar-mask.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * with = ^[a-z]+$ * ``` * - * @param {String} [path] field path to apply the control - * @param {String} [value] value to use during the transformation + * @param {String} path field path to apply the control + * @param {String} with regular expression to check * @returns {Object} */ export default function $MASK(data, feed) { diff --git a/packages/transformers/src/dollar-number.js b/packages/transformers/src/dollar-number.js index 0eef0476..88fd6736 100644 --- a/packages/transformers/src/dollar-number.js +++ b/packages/transformers/src/dollar-number.js @@ -10,8 +10,8 @@ import dollar from './dollar'; * [$NUMBER] * field = counter * ``` - * - * @param {String} [feild] field path to apply the transformation + * + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $NUMBER(data, feed) { diff --git a/packages/transformers/src/dollar-parse.js b/packages/transformers/src/dollar-parse.js index 4f8ee3ab..225d458a 100644 --- a/packages/transformers/src/dollar-parse.js +++ b/packages/transformers/src/dollar-parse.js @@ -11,7 +11,7 @@ import dollar from './dollar'; * field = json * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $PARSE(data, feed) { diff --git a/packages/transformers/src/dollar-prefix.js b/packages/transformers/src/dollar-prefix.js index 4acd71a6..575c2ae3 100644 --- a/packages/transformers/src/dollar-prefix.js +++ b/packages/transformers/src/dollar-prefix.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * with = # * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [vith] value to add at the begining of the field + * @param {String} field field path to apply the transformation + * @param {String} with value to add at the begining of the field * @returns {Object} */ export default function $PREFIX(data, feed) { diff --git a/packages/transformers/src/dollar-remove.js b/packages/transformers/src/dollar-remove.js index 7ead09e2..5ebd8f45 100644 --- a/packages/transformers/src/dollar-remove.js +++ b/packages/transformers/src/dollar-remove.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * the = . * ``` * - * @param {String} [path] field path to apply the transformation - * @param {String} [the] value todrop in the field + * @param {String} path field path to apply the transformation + * @param {String} the value to drop in the field * @returns {Object} */ export default function $REMOVE(data, feed) { diff --git a/packages/transformers/src/dollar-replace-regex.js b/packages/transformers/src/dollar-replace-regex.js index f5815947..4ba0dbbf 100644 --- a/packages/transformers/src/dollar-replace-regex.js +++ b/packages/transformers/src/dollar-replace-regex.js @@ -11,12 +11,11 @@ import dollar from './dollar'; * field = title * searchValue = $hel\w+ * replaceValue = bonjour - * * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [searchValue] regex to search - * @param {String} [replaceValue] value to replace with + * @param {String} field field path to apply the transformation + * @param {String} searchValue regex to search + * @param {String} replaceValue value to replace with * @returns {Object} */ export default function $REPLACE_REGEX(data, feed) { diff --git a/packages/transformers/src/dollar-replace.js b/packages/transformers/src/dollar-replace.js index 80bccbde..1f33d3ee 100644 --- a/packages/transformers/src/dollar-replace.js +++ b/packages/transformers/src/dollar-replace.js @@ -11,12 +11,11 @@ import dollar from './dollar'; * field = title * searchValue = 1 * replaceValue = un - * * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [searchValue] value to search - * @param {String} [replaceValue] value to replace with + * @param {String} field field path to apply the transformation + * @param {String} searchValue value to search + * @param {String} replaceValue value to replace with * @returns {Object} */ export default function $REPLACE(data, feed) { diff --git a/packages/transformers/src/dollar-select.js b/packages/transformers/src/dollar-select.js index 9ec824b0..7816d8b0 100644 --- a/packages/transformers/src/dollar-select.js +++ b/packages/transformers/src/dollar-select.js @@ -2,19 +2,18 @@ import transformer from './operations/SELECT'; import dollar from './dollar'; /** - * Prendre une valeir dans un objet à partir de son chemin (dot path) + * Prendre une valeur dans un objet à partir de son chemin (dot path) * * Exemple : * * ```ini * [$SELECT] * field = title - * path - * + * path = en * ``` * - * @param {String} [field] field path to get the result of the selection - * @param {String} [path] field path to get value + * @param {String} field field path to get the result of the selection + * @param {String} path field path to get value * @returns {Object} */ export default function $SELECT(data, feed) { diff --git a/packages/transformers/src/dollar-shift.js b/packages/transformers/src/dollar-shift.js index 564ecfcc..fb8382e5 100644 --- a/packages/transformers/src/dollar-shift.js +++ b/packages/transformers/src/dollar-shift.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * gap = 2 * ``` * - * @param {String} [path] field path to apply the transformation - * @param {String} [gap] how many item or characters to drop + * @param {String} path field path to apply the transformation + * @param {String} gap how many items or characters to drop * @returns {Object} */ export default function $SHIFT(data, feed) { diff --git a/packages/transformers/src/dollar-split.js b/packages/transformers/src/dollar-split.js index b8b1fd6e..eccce74e 100644 --- a/packages/transformers/src/dollar-split.js +++ b/packages/transformers/src/dollar-split.js @@ -10,11 +10,10 @@ import dollar from './dollar'; * [$SPLIT] * field = title * separator = | - * * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [separator] value to use to split the field + * @param {String} field field path to apply the transformation + * @param {String} separator value to use to split the field * @returns {Object} */ export default function $SPLIT(data, feed) { diff --git a/packages/transformers/src/dollar-string.js b/packages/transformers/src/dollar-string.js index 4a0333d9..50ea6d78 100644 --- a/packages/transformers/src/dollar-string.js +++ b/packages/transformers/src/dollar-string.js @@ -11,7 +11,7 @@ import dollar from './dollar'; * field = title * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $STRING(data, feed) { diff --git a/packages/transformers/src/dollar-suffix.js b/packages/transformers/src/dollar-suffix.js index 5c42b7fa..a231ec98 100644 --- a/packages/transformers/src/dollar-suffix.js +++ b/packages/transformers/src/dollar-suffix.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * with = ! * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [with] value to add at the end of the field + * @param {String} field field path to apply the transformation + * @param {String} with value to add at the end of the field * @returns {Object} */ export default function $SUFFIX(data, feed) { diff --git a/packages/transformers/src/dollar-trim.js b/packages/transformers/src/dollar-trim.js index 0fb3e455..2d583222 100644 --- a/packages/transformers/src/dollar-trim.js +++ b/packages/transformers/src/dollar-trim.js @@ -11,7 +11,7 @@ import dollar from './dollar'; * field = title * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $TRIM(data, feed) { diff --git a/packages/transformers/src/dollar-truncate-words.js b/packages/transformers/src/dollar-truncate-words.js index 1c59b833..f66febea 100644 --- a/packages/transformers/src/dollar-truncate-words.js +++ b/packages/transformers/src/dollar-truncate-words.js @@ -3,7 +3,7 @@ import dollar from './dollar'; /** * Opération permettant la troncature par nombre de mots - * et non pas par nombre de caractères comme pour opération TRUNCATE + * et non pas par nombre de caractères comme pour l'opération {@link $TRUNCATE} * * Exemple : * diff --git a/packages/transformers/src/dollar-truncate.js b/packages/transformers/src/dollar-truncate.js index 4b20c033..0d6672ce 100644 --- a/packages/transformers/src/dollar-truncate.js +++ b/packages/transformers/src/dollar-truncate.js @@ -10,11 +10,10 @@ import dollar from './dollar'; * [$TRUNCATE] * field = title * gap = 25 - * * ``` * - * @param {String} [field] field path to apply the transformation - * @param {String} [gap] how many items or characters to keep + * @param {String} field field path to apply the transformation + * @param {String} gap how many items or characters to keep * @returns {Object} */ export default function $TRUNCATE(data, feed) { diff --git a/packages/transformers/src/dollar-uniq.js b/packages/transformers/src/dollar-uniq.js index d0698c70..727c07e3 100644 --- a/packages/transformers/src/dollar-uniq.js +++ b/packages/transformers/src/dollar-uniq.js @@ -11,7 +11,7 @@ import dollar from './dollar'; * field = title * ``` * - * @param {String} [field] field path to apply the transformation (must be an aarray) + * @param {String} field field path to apply the transformation (must be an aarray) * @returns {Object} */ export default function $UNIQ(data, feed) { diff --git a/packages/transformers/src/dollar-uppercase.js b/packages/transformers/src/dollar-uppercase.js index 74f19e5a..bfa23781 100644 --- a/packages/transformers/src/dollar-uppercase.js +++ b/packages/transformers/src/dollar-uppercase.js @@ -11,7 +11,7 @@ import dollar from './dollar'; * field = title * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $UPPERCASE(data, feed) { diff --git a/packages/transformers/src/dollar-urlencode.js b/packages/transformers/src/dollar-urlencode.js index 5315dfe6..d43c21e2 100644 --- a/packages/transformers/src/dollar-urlencode.js +++ b/packages/transformers/src/dollar-urlencode.js @@ -11,7 +11,7 @@ import dollar from './dollar'; * field = url * ``` * - * @param {String} [field] field path to apply the transformation + * @param {String} field field path to apply the transformation * @returns {Object} */ export default function $URLENCODE(data, feed) { diff --git a/packages/transformers/src/dollar-value.js b/packages/transformers/src/dollar-value.js index d9e3aef4..56c1a778 100644 --- a/packages/transformers/src/dollar-value.js +++ b/packages/transformers/src/dollar-value.js @@ -12,8 +12,8 @@ import dollar from './dollar'; * value = Hello world * ``` * - * @param {String} [field] new field path - * @param {String} [value] value to use to set the field + * @param {String} field new field path + * @param {String} value value to use to set the field * @returns {Object} */ export default function $VALUE(data, feed) {