clojure/clojure.repl-api.html at gh-pages · clojure/clojure

409 lines (346 loc) · 20.1 KB
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>clojure.repl - Clojure v1.12.4 API documentation</title>
    <link rel="icon" href="static/favicon.png" />
    <link rel="shortcut icon" href="static/favicon.png" />
    <link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
    <link rel="stylesheet" href="static/wiki.css" type="text/css" media="all" />
    <link rel="stylesheet" href="static/internal.css" type="text/css" media="all" />
    <style>.menuWrapper{height: 36px;}</style>
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
    <div id="AllContentContainer">
      <div id="Header">
	<a href="index.html" id="Logo"><img src="static/clojure-icon.gif" width="100" height="100" alt="Clojure" /></a>
	<h1><a href="index.html" id="page-header" title="page header title">Clojure Core API Reference</a></h1>
      </div>
      <div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
  <div class="WikiCustomNav WikiElement wiki">
    <span class="toc-header"><span id="project-name">Clojure</span> <span id="version">v1.12.4</span> API</span><br />
      <li><a href="index.html" class="wiki_link">Overview</a></li>
      <li><a href="api-index.html" class="wiki_link">API Index</a></li>
    <div class="NamespaceTOC">
      <span class="toc-header">Namespaces</span>
      <ul id="left-sidebar-list">
        <li><a class="wiki_link" href="clojure.core-api.html">clojure.core</a></li><li><a class="wiki_link" href="clojure.data-api.html">clojure.data</a></li><li><a class="wiki_link" href="clojure.datafy-api.html">clojure.datafy</a></li><li><a class="wiki_link" href="clojure.edn-api.html">clojure.edn</a></li><li><a class="wiki_link" href="clojure.inspector-api.html">clojure.inspector</a></li><li><a class="wiki_link" href="clojure.instant-api.html">clojure.instant</a></li><li><a class="wiki_link" href="clojure.java.basis-api.html">clojure.java.basis</a></li><li><a class="wiki_link" href="clojure.java.browse-api.html">clojure.java.browse</a></li><li><a class="wiki_link" href="clojure.java.io-api.html">clojure.java.io</a></li><li><a class="wiki_link" href="clojure.java.javadoc-api.html">clojure.java.javadoc</a></li><li><a class="wiki_link" href="clojure.java.process-api.html">clojure.java.process</a></li><li><a class="wiki_link" href="clojure.java.shell-api.html">clojure.java.shell</a></li><li><a class="wiki_link" href="clojure.main-api.html">clojure.main</a></li><li><a class="wiki_link" href="clojure.math-api.html">clojure.math</a></li><li><a class="wiki_link" href="clojure.pprint-api.html">clojure.pprint</a></li><li><a class="wiki_link" href="clojure.reflect-api.html">clojure.reflect</a></li><li><a class="wiki_link" href="clojure.repl-api.html">clojure.repl</a></li><li><a class="wiki_link" href="clojure.set-api.html">clojure.set</a></li><li><a class="wiki_link" href="clojure.stacktrace-api.html">clojure.stacktrace</a></li><li><a class="wiki_link" href="clojure.string-api.html">clojure.string</a></li><li><a class="wiki_link" href="clojure.template-api.html">clojure.template</a></li><li><a class="wiki_link" href="clojure.test-api.html">clojure.test</a></li><li><a class="wiki_link" href="clojure.tools.deps.interop-api.html">clojure.tools.deps.interop</a></li><li><a class="wiki_link" href="clojure.walk-api.html">clojure.walk</a></li><li><a class="wiki_link" href="clojure.xml-api.html">clojure.xml</a></li><li><a class="wiki_link" href="clojure.zip-api.html">clojure.zip</a></li>
      </ul>
    <div class="BranchTOC">
      <span class="toc-header">Other Versions</span>
      <ul id="left-sidebar-branch-list">
        <li><a class="wiki_link" href="index.html">v1.12.3 (stable)</a></li><li><a class="wiki_link" href="branch-master/index.html">v1.13 (in development)</a></li><li><a class="wiki_link" href="branch-clojure-1.11.4/index.html">v1.11.4 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.10.3/index.html">v1.10.3 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.9.0/index.html">v1.9 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.8.0/index.html">v1.8 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.7.0/index.html">v1.7 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.6.0/index.html">v1.6 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.5.0/index.html">v1.5 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.4.0/index.html">v1.4 (legacy)</a></li><li><a class="wiki_link" href="branch-1.3.x/index.html">v1.3 (legacy)</a></li><li><a class="wiki_link" href="branch-1.2.x/index.html">v1.2 (legacy)</a></li><li><a class="wiki_link" href="branch-1.1.x/index.html">v1.1 (legacy)</a></li>
      </ul>
    <a class="wiki_link" href="https://clojure.org">Clojure Home</a>
      <div id="rightcolumn">
	<div id="Content">
	  <div class="contentBox"><div class="innerContentBox">
              <div class="wiki wikiPage" id="content_view">
                <div id="right-sidebar"><div id="toc">
  <h1 class="nopad">Table of Contents</h1>
  <div class="toc-section" style="margin-left: 1em;">
    <a style="margin-top: 3px;" href="#toc0">Overview</a>
  </div><div class="toc-section" style="margin-left: 1em;">
    <a style="margin-top: 3px;" href="#"></a>
  </div><div class="toc-section" style="margin-left: 1em;">
    <a style="margin-top: 3px;" href="#"></a>
  </div><div class="toc-section" style="margin-left: 1em;">
    <a style="margin-top: 3px;" href="#var-section">Vars and Functions</a>
    <div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/apropos" class="toc-entry-anchor">apropos</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/demunge" class="toc-entry-anchor">demunge</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/dir" class="toc-entry-anchor">dir</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/dir-fn" class="toc-entry-anchor">dir-fn</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/doc" class="toc-entry-anchor">doc</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/find-doc" class="toc-entry-anchor">find-doc</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/pst" class="toc-entry-anchor">pst</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/root-cause" class="toc-entry-anchor">root-cause</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/set-break-handler!" class="toc-entry-anchor">set-break-handler!</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/source" class="toc-entry-anchor">source</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/source-fn" class="toc-entry-anchor">source-fn</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/stack-element-str" class="toc-entry-anchor">stack-element-str</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl/thread-stopper" class="toc-entry-anchor">thread-stopper</a>
  </div><div class="toc-section" style="margin-left: 1em;">
    <a style="margin-top: 3px;" href="#"></a>
  </div><div class="toc-section" style="margin-left: 1em;">
    <a style="margin-top: 3px;" href="#clojure.repl.deps">clojure.repl.deps</a>
    <div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl.deps/add-lib" class="toc-entry-anchor">add-lib</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl.deps/add-libs" class="toc-entry-anchor">add-libs</a>
    </div><div class="toc-entry" style="margin-left: 1em;">
      <a href="#clojure.repl.deps/sync-deps" class="toc-entry-anchor">sync-deps</a>
                <div id="content-tag"><h1 id="overview">API for <span id="clojure.repl">clojure.repl</span>
  - <span id="header-project">Clojure</span> <span id="header-version">v1.12.4</span><span id="header-status-block"> (<span id="header-status">stable</span>)</span>
<span id="author-line">by <span id="author-name">Chris Houser, Christophe Grand, Stephen Gilardi, Michel Salim</span><br /></span>
<br />Full namespace name: <span id="long-name">clojure.repl</span>
<h2>Overview</h2>
<pre id="namespace-docstr">Utilities meant to be used interactively at the REPL</pre>
<div id="var-section">
  <h2>Public Variables and Functions</h2>
  <div id="var-entry">
    <h2 id="clojure.repl/apropos">apropos</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (apropos str-or-pattern)
    <pre id="var-docstr">Given a regular expression or stringable thing, return a seq of all
public definitions in all currently-loaded namespaces that match the
str-or-pattern.</pre>
    <pre id="var-specs"></pre>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L181">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/demunge">demunge</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (demunge fn-name)
    <pre id="var-docstr">Given a string representation of a fn class,
as in a stack trace element, returns a readable version.</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L207">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/dir">dir</h2>
    <span id="var-type">macro</span><br />
    <pre id="var-usage">Usage: (dir nsname)
    <pre id="var-docstr">Prints a sorted directory of public vars in a namespace</pre>
    <pre id="var-specs"></pre>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L201">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/dir-fn">dir-fn</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (dir-fn ns)
    <pre id="var-docstr">Returns a sorted seq of symbols naming public vars in
a namespace or namespace alias. Looks for aliases in *ns*</pre>
    <pre id="var-specs"></pre>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L195">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/doc">doc</h2>
    <span id="var-type">macro</span><br />
    <pre id="var-usage">Usage: (doc name)
    <pre id="var-docstr">Prints documentation for a var or special form given its name,
or for a spec if given a keyword</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L131">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/find-doc">find-doc</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (find-doc re-string-or-pattern)
    <pre id="var-docstr">Prints documentation for any var whose documentation or name
contains a match for re-string-or-pattern</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L115">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/pst">pst</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (pst)
       (pst e-or-depth)
       (pst e depth)
    <pre id="var-docstr">Prints a stack trace of the exception, to the depth requested. If none supplied, uses the root cause of the
most recent repl exception (*e), and a depth of 12.</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L240">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/root-cause">root-cause</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (root-cause t)
    <pre id="var-docstr">Returns the initial cause of an exception or error by peeling off all of
its wrappers</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L214">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/set-break-handler!">set-break-handler!</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (set-break-handler!)
       (set-break-handler! f)
    <pre id="var-docstr">Register INT signal handler.  After calling this, Ctrl-C will cause
the given function f to be called with a single argument, the signal.
Uses thread-stopper if no function given.</pre>
    <pre id="var-specs"></pre>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L279">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/source">source</h2>
    <span id="var-type">macro</span><br />
    <pre id="var-usage">Usage: (source n)
    <pre id="var-docstr">Prints the source code for the given symbol, if it can find it.
This requires that the symbol resolve to a Var defined in a
namespace for which the .clj is in the classpath.
Example: (source filter)</pre>
    <pre id="var-specs"></pre>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L172">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/source-fn">source-fn</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (source-fn x)
    <pre id="var-docstr">Returns a string of the source code for the given symbol, if it can
find it.  This requires that the symbol resolve to a Var defined in
a namespace for which the .clj is in the classpath.  Returns nil if
it can't find the source.  For most REPL usage, 'source' is more
convenient.
Example: (source-fn 'filter)</pre>
    <pre id="var-specs"></pre>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L147">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/stack-element-str">stack-element-str</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (stack-element-str el)
    <pre id="var-docstr">Returns a (possibly unmunged) string representation of a StackTraceElement</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L227">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl/thread-stopper">thread-stopper</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (thread-stopper)
       (thread-stopper thread)
    <pre id="var-docstr">Returns a function that takes one arg and uses that as an exception message
to stop the given thread.  Defaults to the current thread</pre>
    <pre id="var-specs"></pre>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/3b6256e654bf250ddfd01cdaa4be9f39a74c2de6/src/clj/clojure/repl.clj#L273">Source</a>
<h2 id="clojure.repl.deps">clojure.repl.deps</h2>
<pre id="namespace-docstr">clojure.repl.deps provides facilities for dynamically modifying the available
libraries in the runtime when running at the REPL, without restarting</pre>
<div id="var-section">
  <h2>Public Variables and Functions</h2>
  <div id="var-entry">
    <h2 id="clojure.repl.deps/add-lib">add-lib</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (add-lib lib coord)
       (add-lib lib)
    <pre id="var-docstr">Given a lib that is not yet on the repl classpath, make it available by
downloading the library if necessary and adding it to the classloader.
Libs already on the classpath are not updated. Requires a valid parent
DynamicClassLoader.
 lib - symbol identifying a library, for Maven: groupId/artifactId
 coord - optional map of location information specific to the procurer,
         or latest if not supplied
Returns coll of libs loaded, including transitive (or nil if none).
For info on libs, coords, and versions, see:
 <a href="https://clojure.org/reference/deps_and_cli">https://clojure.org/reference/deps_and_cli</a></pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.12</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/be32516234961396581685b485ed8a88f8fe17e6/src/clj/clojure/repl/deps.clj#L59">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl.deps/add-libs">add-libs</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (add-libs lib-coords)
    <pre id="var-docstr">Given lib-coords, a map of lib to coord, will resolve all transitive deps for the libs
together and add them to the repl classpath, unlike separate calls to add-lib.</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.12</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/be32516234961396581685b485ed8a88f8fe17e6/src/clj/clojure/repl/deps.clj#L35">Source</a>
  </div><div id="var-entry">
    <h2 id="clojure.repl.deps/sync-deps">sync-deps</h2>
    <span id="var-type">function</span><br />
    <pre id="var-usage">Usage: (sync-deps &amp; {:as opts})
    <pre id="var-docstr">Calls add-libs with any libs present in deps.edn but not yet present on the classpath.
:aliases - coll of alias keywords to use during the sync</pre>
    <pre id="var-specs"></pre>
    <span class="var-added"><span id="content">Added in Clojure version 1.12</span><br /></span>
    <a id="var-source" href="https://github.com/clojure/clojure/blob/be32516234961396581685b485ed8a88f8fe17e6/src/clj/clojure/repl/deps.clj#L85">Source</a>
              </div>
            </div>
          </div>
	<div id="foot">
	  <div id="copyright" style="text-align: center;">Copyright 2007-2025 by Rich Hickey</div>
      </div>
      <div id="DesignedBy">Logo &amp; site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
      Clojure auto-documentation system by Tom Faulhaber.</div>
    <!-- /AllContentContainer -->
FilesExpand file tree

clojure.repl-api.html

Latest commit

History

clojure.repl-api.html

File metadata and controls
