Hookable

internal

Gives the ability to automatically generate and serve an HTTP API
from R functions using the annotations in the R documentation around your
functions.

Barret Schloerke

plumber

An API Generator for R

Jeff Allen

Bruno Tremblay

Frans van Dunné

Sebastiaan Vandewoude

Posit Software, PBC 

Hookable function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Hookable%24registerHook()?package=plumber&version=1.3.0" data-mini-rdoc="plumber::Hookable$registerHook()"><code>Hookable$registerHook()</code></a></p></li>
<li><p><a href="/link/Hookable%24registerHooks()?package=plumber&version=1.3.0" data-mini-rdoc="plumber::Hookable$registerHooks()"><code>Hookable$registerHooks()</code></a></p></li>
<li><p><a href="/link/Hookable%24clone()?package=plumber&version=1.3.0" data-mini-rdoc="plumber::Hookable$clone()"><code>Hookable$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Hookable-registerHook"></a></p><div class="section" id="method-registerhook-">
<h3>Method <code>registerHook()</code></h3>
<p>Register a hook on a router</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Hookable$registerHook(stage, handler)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>stage</code></dt>
<dd><p>a character string.</p></dd></dl></div></p><p>
<dt><code>handler</code></dt>
<dd><p>a hook function.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Hookable-registerHooks"></a></p><div class="section" id="method-registerhooks-">
<h3>Method <code>registerHooks()</code></h3>
<p>Register hooks on a router</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Hookable$registerHooks(handlers)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>handlers</code></dt>
<dd><p>a named list of hook functions.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Hookable-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Hookable$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Hookable — Hookable


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-Hookable-registerHook'><code>Hookable$registerHook()</code></a></p></li>
<li><p><a href='#method-Hookable-registerHooks'><code>Hookable$registerHooks()</code></a></p></li>
<li><p><a href='#method-Hookable-clone'><code>Hookable$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-Hookable-registerHook"></a></p><div class='section' id='method-registerhook-'>
<h3>Method <code>registerHook()</code></h3>
<p>Register a hook on a router</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Hookable$registerHook(stage, handler)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>stage</code></dt>
<dd><p>a character string.</p></dd>


<dt><code>handler</code></dt>
<dd><p>a hook function.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-Hookable-registerHooks"></a></p><div class='section' id='method-registerhooks-'>
<h3>Method <code>registerHooks()</code></h3>
<p>Register hooks on a router</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Hookable$registerHooks(handlers)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>handlers</code></dt>
<dd><p>a named list of hook functions.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-Hookable-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Hookable$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


Hookable: Hookable

Description

Arguments

Methods

Public methods

Method `registerHook()`

Usage

Arguments

Method `registerHooks()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Description

Arguments

Methods

Public methods

Method registerHook()

Usage

Arguments

Method registerHooks()

Usage

Arguments

Method clone()

Usage

Arguments

Method `registerHook()`

Method `registerHooks()`

Method `clone()`