Skip to content

Commit e89acfa

Browse files
Update middleware docs
1 parent 0ef5495 commit e89acfa

File tree

1 file changed

+22
-0
lines changed
  • doc/modules/ROOT/pages/nrepl-api

1 file changed

+22
-0
lines changed

doc/modules/ROOT/pages/nrepl-api/ops.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -686,6 +686,7 @@ Optional parameters::
686686
* `:max-coll-size` New max size of rendered collection
687687
* `:max-nested-depth` New max nested depth of rendered collection
688688
* `:page-size` New page size
689+
* `:view-mode` Mode of viewing the value - either ``:normal`` or ``:object``
689690

690691

691692
Returns::
@@ -829,6 +830,27 @@ Returns::
829830

830831

831832

833+
=== `inspect-toggle-view-mode`
834+
835+
Toggles the viewing mode of the inspector. This influences the way how inspector is rendering the current value. ``:normal`` is the default, when view mode is ``:object``, any value will be rendered as a Java object (fields shown as is).
836+
837+
Required parameters::
838+
* `:session` The current session
839+
840+
841+
Optional parameters::
842+
{blank}
843+
844+
Returns::
845+
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
846+
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
847+
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
848+
* `:path` Printed representation of current inspector path.
849+
* `:status` "done"
850+
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
851+
852+
853+
832854
=== `is-var-profiled`
833855

834856
Reports whether symbol is currently profiled.

0 commit comments

Comments
 (0)