Liking cljdoc? Tell your friends :D

Supported nREPL operations

generated from a verbose 'describe' response (nREPL v0.6.0-SNAPSHOT)

Operations

:clone

Clones the current session, returning the ID of the newly-created session.

Required parameters

Optional parameters
  • :session The ID of the session to be cloned; if not provided, a new session with default bindings is created, and mapped to the returned session ID.

Returns
  • :new-session The ID of the new session.

:close

Closes the specified session.

Required parameters
  • :session The ID of the session to be closed.

Optional parameters

Returns

:describe

Produce a machine- and human-readable directory and documentation for the operations supported by an nREPL endpoint.

Required parameters

Optional parameters
  • :verbose? Include informational detail for each "op"eration in the return message.

Returns
  • :aux Map of auxilliary data contributed by all of the active nREPL middleware via :describe-fn functions in their descriptors.

  • :ops Map of "op"erations supported by this nREPL endpoint

  • :versions Map containing version maps (like *clojure-version*, e.g. major, minor, incremental, and qualifier keys) for values, component names as keys. Common keys include "nrepl" and "clojure".

:eval

Evaluates code. Note that unlike regular stream-based Clojure REPLs, nREPL’s :eval short-circuits on first read error and will not try to read and execute the remaining code in the message.

Required parameters
  • :code The code to be evaluated.

  • :session The ID of the session within which to evaluate the code.

Optional parameters
  • :column The column number in [file] at which [code] starts.

  • :eval A fully-qualified symbol naming a var whose function value will be used to evaluate [code], instead of clojure.core/eval (the default).

  • :file The path to the file containing [code]. clojure.core/*file* will be bound to this.

  • :id An opaque message ID that will be included in responses related to the evaluation, and which may be used to restrict the scope of a later "interrupt" operation.

  • :line The line number in [file] at which [code] starts.

  • :nrepl.middleware.caught/caught A fully-qualified symbol naming a var whose function to use to convey interactive errors. Must point to a function that takes a java.lang.Throwable as its sole argument.

  • :nrepl.middleware.caught/print? If logical true, the printed value of any interactive errors will be returned in the response (otherwise they will be elided). Delegates to nrepl.middleware.print to perform the printing. Defaults to false.

  • :nrepl.middleware.print/buffer-size The size of the buffer to use when streaming results. Defaults to 1024.

  • :nrepl.middleware.print/keys A seq of the keys in the response whose values should be printed.

  • :nrepl.middleware.print/options A map of options to pass to the printing function. Defaults to nil.

  • :nrepl.middleware.print/print A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].

  • :nrepl.middleware.print/quota A hard limit on the number of bytes printed for each value.

  • :nrepl.middleware.print/stream? If logical true, the result of printing each value will be streamed to the client over one or more messages.

Returns
  • :ex The type of exception thrown, if any. If present, then values will be absent.

  • :ns *ns*, after successful evaluation of code.

  • :root-ex The type of the root exception thrown, if any. If present, then values will be absent.

  • :values The result of evaluating code, often readable. This printing is provided by the print middleware. Superseded by ex and root-ex if an exception occurs during evaluation.

:interrupt

Attempts to interrupt some executing request. When interruption succeeds, the thread used for execution is killed, and a new thread spawned for the session. While the session middleware ensures that Clojure dynamic bindings are preserved, other ThreadLocals are not. Hence, when running code intimately tied to the current thread identity, it is best to avoid interruptions.

Required parameters
  • :session The ID of the session used to start the request to be interrupted.

Optional parameters
  • :interrupt-id The opaque message ID sent with the request to be interrupted.

Returns
  • :status 'interrupted' if a request was identified and interruption will be attempted 'session-idle' if the session is not currently executing any request 'interrupt-id-mismatch' if the session is currently executing a request sent using a different ID than specified by the "interrupt-id" value 'session-ephemeral' if the session is an ephemeral session

:load-file

Loads a body of code, using supplied path and filename info to set source file and line number metadata. Delegates to underlying "eval" middleware/handler.

Required parameters
  • :file Full contents of a file of code.

Optional parameters
  • :file-name Name of source file, e.g. io.clj

  • :file-path Source-path-relative path of the source file, e.g. clojure/java/io.clj

  • :nrepl.middleware.caught/caught A fully-qualified symbol naming a var whose function to use to convey interactive errors. Must point to a function that takes a java.lang.Throwable as its sole argument.

  • :nrepl.middleware.caught/print? If logical true, the printed value of any interactive errors will be returned in the response (otherwise they will be elided). Delegates to nrepl.middleware.print to perform the printing. Defaults to false.

  • :nrepl.middleware.print/buffer-size The size of the buffer to use when streaming results. Defaults to 1024.

  • :nrepl.middleware.print/keys A seq of the keys in the response whose values should be printed.

  • :nrepl.middleware.print/options A map of options to pass to the printing function. Defaults to nil.

  • :nrepl.middleware.print/print A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].

  • :nrepl.middleware.print/quota A hard limit on the number of bytes printed for each value.

  • :nrepl.middleware.print/stream? If logical true, the result of printing each value will be streamed to the client over one or more messages.

Returns
  • :ex The type of exception thrown, if any. If present, then values will be absent.

  • :ns *ns*, after successful evaluation of code.

  • :root-ex The type of the root exception thrown, if any. If present, then values will be absent.

  • :values The result of evaluating code, often readable. This printing is provided by the print middleware. Superseded by ex and root-ex if an exception occurs during evaluation.

:ls-sessions

Lists the IDs of all active sessions.

Required parameters

Optional parameters

Returns
  • :sessions A list of all available session IDs.

:stdin

Add content from the value of "stdin" to *in* in the current session.

Required parameters
  • :stdin Content to add to *in*.

Optional parameters

Returns
  • :status A status of "need-input" will be sent if a session’s *in* requires content in order to satisfy an attempted read operation.

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close