Update docs

AdguardTeam · Jun 18, 2024 · bdea52f · bdea52f
1 parent a17278d
commit bdea52f
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/src/scriptlets/trusted-replace-fetch-response.js b/src/scriptlets/trusted-replace-fetch-response.js
@@ -46,7 +46,7 @@ import {
  *         - `name` is [`init` option name](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#parameters)
  *         - `value` is string or regular expression for matching the value of the option passed to fetch call;
  *           invalid regular expression will cause any value matching
- * - `logContent` — optional, string to log original and modified text content of fetch responses.
+ * - `logContent` — optional, string, if set to 'logContent' will log original and modified text content of fetch responses.
  *
  * > Usage with no arguments will log fetch calls to browser console;
  * > it may be useful for debugging but it is not allowed for prod versions of filter lists.

diff --git a/src/scriptlets/trusted-replace-node-text.js b/src/scriptlets/trusted-replace-node-text.js
@@ -33,7 +33,7 @@ import {
  * If matched, the whole text will be removed. Case sensitive.
  * - `pattern` — required, string or regexp for matching contents of `node.textContent` that should be replaced.
  * - `replacement` — required, string to replace text content matched by `pattern`.
- * - `logContent` — optional, if present, logs original and modified text content.
+ * - `logContent` — optional, string, if set to 'logContent' will log original and modified text content.
  *
  * ### Examples
  *

diff --git a/src/scriptlets/trusted-replace-xhr-response.js b/src/scriptlets/trusted-replace-xhr-response.js
@@ -42,7 +42,7 @@ import {
  *         - `name` — string or regular expression for matching XMLHttpRequest property name
  *         - `value` — string or regular expression for matching the value of the option
  *           passed to `XMLHttpRequest.open()` call
- * - `logContent` — optional, string to log original and modified text content of XMLHttpRequests.
+ * - `logContent` — optional, string, if set to 'logContent' will log original and modified text content of XMLHttpRequests.
  *
  * > Usage with no arguments will log XMLHttpRequest objects to browser console;
  * > it may be useful for debugging but it is not allowed for prod versions of filter lists.

diff --git a/src/scriptlets/xml-prune.js b/src/scriptlets/xml-prune.js
@@ -35,7 +35,7 @@ import {
  * - `propsToMatch` — optional, XPath or selector of elements which will be removed from XML
  * - `optionalProp` — optional, selector of elements that must occur in XML document
  * - `urlToMatch` — optional, string or regular expression for matching the request's URL
- * - `logContent` — optional, string to log original and modified XML content.
+ * - `logContent` — optional, string, if set to 'logContent' will log original and modified XML content
  *
  * > Usage with no arguments will log response payload and URL to browser console;
  * > it may be useful for debugging but it is not allowed for prod versions of filter lists.