Hooks

<p>Helps define new hooks, hold hooks, and accessors to get and
use hooks.</p>

internal

Record test suite 'HTTP' requests and replays them during
future runs. A port of the Ruby gem of the same name
(<https://github.com/vcr/vcr/>). Works by hooking into the 'webmockr'
R package for matching 'HTTP' requests by various rules ('HTTP' method,
'URL', query parameters, headers, body, etc.), and then caching
real 'HTTP' responses on disk in 'cassettes'. Subsequent 'HTTP' requests
matching any previous requests in the same 'cassette' use a cached
'HTTP' response.

Scott Chamberlain

Record 'HTTP' Calls to Disk

Aaron Wolen

Maëlle Salmon

Daniel Possenriede

rOpenSci 

Hooks function

<p><div class="r6-fields"></div></p><dl>
<dt><code>hooks</code></dt>
<dd><p>intenal use</p></dd><p></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Hooks%24invoke_hook()?package=vcr&version=1.2.2" data-mini-rdoc="vcr::Hooks$invoke_hook()"><code>Hooks$invoke_hook()</code></a></p></li>
<li><p><a href="/link/Hooks%24clear_hooks()?package=vcr&version=1.2.2" data-mini-rdoc="vcr::Hooks$clear_hooks()"><code>Hooks$clear_hooks()</code></a></p></li>
<li><p><a href="/link/Hooks%24define_hook()?package=vcr&version=1.2.2" data-mini-rdoc="vcr::Hooks$define_hook()"><code>Hooks$define_hook()</code></a></p></li>
<li><p><a href="/link/Hooks%24clone()?package=vcr&version=1.2.2" data-mini-rdoc="vcr::Hooks$clone()"><code>Hooks$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Hooks-invoke_hook"></a></p><div class="section" id="method-invoke-hook-">
<h3>Method <code>invoke_hook()</code></h3>
<p>invoke a hook</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Hooks$invoke_hook(hook_type, args)</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>hook_type</code></dt>
<dd><p>(character) Hook name</p></dd></dl></div></p><p>
<dt><code>args</code></dt>
<dd><p>(named list) Args passed when invoking a hook</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>executes hook</p>
</div><p></p><p></p><p><hr>
<a id="method-Hooks-clear_hooks"></a></p><div class="section" id="method-clear-hooks-">
<h3>Method <code>clear_hooks()</code></h3>
<p>clear all hooks</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Hooks$clear_hooks()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>no return</p>
</div></p><p></p><p><hr>
<a id="method-Hooks-define_hook"></a></p><div class="section" id="method-define-hook-">
<h3>Method <code>define_hook()</code></h3>
<p>define a hook</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Hooks$define_hook(hook_type, fun, prepend = 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>hook_type</code></dt>
<dd><p>(character) Hook name</p></dd></dl></div></p><p>
<dt><code>fun</code></dt>
<dd><p>A function</p></dd></p><p>
<dt><code>prepend</code></dt>
<dd><p>(logical) Whether to prepend or add to the end
of the string. Default: <code>FALSE</code></p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>no return; defines hook internally</p>
</div><p></p><p></p><p><hr>
<a id="method-Hooks-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>Hooks$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

Hooks class — Hooks

<p><div class="r6-fields"></p><dl>
<dt><code>hooks</code></dt>
<dd><p>intenal use</p></dd>


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


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

<ul>
<li><p><a href='#method-Hooks-invoke_hook'><code>Hooks$invoke_hook()</code></a></p></li>
<li><p><a href='#method-Hooks-clear_hooks'><code>Hooks$clear_hooks()</code></a></p></li>
<li><p><a href='#method-Hooks-define_hook'><code>Hooks$define_hook()</code></a></p></li>
<li><p><a href='#method-Hooks-clone'><code>Hooks$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-Hooks-invoke_hook"></a></p><div class='section' id='method-invoke-hook-'>
<h3>Method <code>invoke_hook()</code></h3>
<p>invoke a hook</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Hooks$invoke_hook(hook_type, args)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>hook_type</code></dt>
<dd><p>(character) Hook name</p></dd>


<dt><code>args</code></dt>
<dd><p>(named list) Args passed when invoking a hook</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>executes hook</p>
</div>

</div><p><hr>
<a id="method-Hooks-clear_hooks"></a></p><div class='section' id='method-clear-hooks-'>
<h3>Method <code>clear_hooks()</code></h3>
<p>clear all hooks</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Hooks$clear_hooks()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>no return</p>
</div>

</div><p><hr>
<a id="method-Hooks-define_hook"></a></p><div class='section' id='method-define-hook-'>
<h3>Method <code>define_hook()</code></h3>
<p>define a hook</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Hooks$define_hook(hook_type, fun, prepend = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>hook_type</code></dt>
<dd><p>(character) Hook name</p></dd>


<dt><code>fun</code></dt>
<dd><p>A function</p></dd>


<dt><code>prepend</code></dt>
<dd><p>(logical) Whether to prepend or add to the end
of the string. Default: <code>FALSE</code></p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>no return; defines hook internally</p>
</div>

</div><p><hr>
<a id="method-Hooks-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>Hooks$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>


Hooks: Hooks class

Description

Arguments

Public fields

Methods

Public methods

Method `invoke_hook()`

Usage

Arguments

Returns

Method `clear_hooks()`

Usage

Returns

Method `define_hook()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Public fields

Methods

Public methods

Method invoke_hook()

Usage

Arguments

Returns

Method clear_hooks()

Usage

Returns

Method define_hook()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Details

Method `invoke_hook()`

Method `clear_hooks()`

Method `define_hook()`

Method `clone()`