docs: ✏️ update

Inist-CNRS · May 17, 2024 · 9f4f6c2 · 9f4f6c2
1 parent 7c3561a
commit 9f4f6c2
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 0 deletions.
diff --git a/docs/plugin-conditor.md b/docs/plugin-conditor.md
@@ -56,6 +56,7 @@ Sachant qu'on appauvrit (casse, accents, tiret, apostrophe) tous les champs.
 -   [compareRnsr](#comparernsr)
 -   [conditorScroll](#conditorscroll)
 -   [CORHALFetch](#corhalfetch)
+-   [CORHALFetch](#corhalfetch-1)
 -   [getRnsr](#getrnsr)
 -   [getRnsrInfo](#getrnsrinfo)
 -   [WOSFetch](#wosfetch)
@@ -226,6 +227,39 @@ Output:
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
+### CORHALFetch
+
+Take `String` as URL, throw each chunk from the result
+
+Input:
+
+```json
+[
+  { q: "toto" },
+]
+```
+
+Script:
+
+```ini
+[CORHALFetch]
+url = https://corhal-api.inist.fr
+```
+
+Output:
+
+```json
+[{...}, {"a": "b"}, {"a": "c" }]
+```
+
+#### Parameters
+
+-   `url` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** corhal api url
+-   `timeout` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Timeout in milliseconds (optional, default `1000`)
+-   `retries` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** The maximum amount of times to retry the connection (optional, default `5`)
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
 ### getRnsr
 
 Find the RNSR identifier(s) matching the `address` and the publication `year`

diff --git a/packages/conditor/README.md b/packages/conditor/README.md
@@ -56,6 +56,7 @@ Sachant qu'on appauvrit (casse, accents, tiret, apostrophe) tous les champs.
 -   [compareRnsr](#comparernsr)
 -   [conditorScroll](#conditorscroll)
 -   [CORHALFetch](#corhalfetch)
+-   [CORHALFetch](#corhalfetch-1)
 -   [getRnsr](#getrnsr)
 -   [getRnsrInfo](#getrnsrinfo)
 -   [WOSFetch](#wosfetch)
@@ -226,6 +227,39 @@ Output:
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
+### CORHALFetch
+
+Take `String` as URL, throw each chunk from the result
+
+Input:
+
+```json
+[
+  { q: "toto" },
+]
+```
+
+Script:
+
+```ini
+[CORHALFetch]
+url = https://corhal-api.inist.fr
+```
+
+Output:
+
+```json
+[{...}, {"a": "b"}, {"a": "c" }]
+```
+
+#### Parameters
+
+-   `url` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** corhal api url
+-   `timeout` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Timeout in milliseconds (optional, default `1000`)
+-   `retries` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** The maximum amount of times to retry the connection (optional, default `5`)
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
 ### getRnsr
 
 Find the RNSR identifier(s) matching the `address` and the publication `year`