summaryrefslogtreecommitdiff
path: root/docs/modules/api
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2024-01-25 17:22:54 -0700
committerDan Allen <dan.j.allen@gmail.com>2024-01-25 17:23:14 -0700
commit8bf7ce910fb8ad1b1b76006244e44c2cd554aabf (patch)
tree374694bc14ba5ee9bceeb618278c49cfad4ff5e9 /docs/modules/api
parent37628150a4256a5f4ead6c2e426699c455b46a66 (diff)
document the logger API option
Diffstat (limited to 'docs/modules/api')
-rw-r--r--docs/modules/api/pages/options.adoc7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/modules/api/pages/options.adoc b/docs/modules/api/pages/options.adoc
index 1b753e41..3e7bb62f 100644
--- a/docs/modules/api/pages/options.adoc
+++ b/docs/modules/api/pages/options.adoc
@@ -66,6 +66,13 @@ Instead of providing a Ruby block containing extensions to register, this option
|_not set_
|`Extensions::Registry` instance
+|`:logger`
+|Shorthand to assign a new value to the global `LoggerManager.logger`.
+This is persistent change, so you either have to reset the value afterwards or pass the option each time you call the API.
+If value is falsy, it assigns a null logger, effectively turning off logging.
+|_not set_
+|`Logger` instance
+
|`:parse_header_only`
|If `true`, the parser stops after reading the header.
|`false`