psychojs/docs/module-data.Shelf.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Shelf</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: Shelf</h1>


<section>

<header>

        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="module-data.html">data</a>.</span>Shelf<span class="signature">(options)</span><span class="type-signature"></span></h2>


</header>

<article>
    <div class="container-overview">


    <h4 class="name" id="Shelf"><span class="type-signature"></span>new Shelf<span class="signature">(options)</span><span class="type-signature"></span></h4>


<div class="description">
    <p>Shelf handles persistent key/value pairs, or records, which are stored in the shelf collection on the
server, and be accessed and manipulated in a concurrent fashion.</p>

<p></p>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th>Attributes</th>


        <th>Default</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>psychoJS</code></td>


            <td class="type">


<span class="param-type"><a href="module-core.PsychoJS.html">module:core.PsychoJS</a></span>


            </td>


                <td class="attributes">


                </td>


                <td class="default">

                </td>


            <td class="description last">the PsychoJS instance</td>
        </tr>


        <tr>

                <td class="name"><code>autoLog</code></td>


            <td class="type">


<span class="param-type">boolean</span>


            </td>


                <td class="attributes">

                    &lt;optional><br>


                </td>


                <td class="default">

                    false

                </td>


            <td class="description last">whether to log</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line17">line 17</a>
    </li></ul></dd>


</dl>


    </div>


        <h3 class="subsection-title">Extends</h3>


    <ul>
        <li>PsychObject</li>
    </ul>


        <h3 class="subsection-title">Members</h3>


<h4 class="name" id=".MAX_KEY_LENGTH"><span class="type-signature">(static) </span>MAX_KEY_LENGTH<span class="type-signature"> :number</span></h4>


<div class="description">
    Maximum number of components in a key
</div>


    <h5>Type:</h5>
    <ul>
        <li>

<span class="param-type">number</span>


        </li>
    </ul>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line32">line 32</a>
    </li></ul></dd>


</dl>


<h4 class="name" id=".Type"><span class="type-signature">(static, readonly) </span>Type<span class="type-signature"> :Symbol</span></h4>


<div class="description">
    Shelf record types.
</div>


    <h5>Type:</h5>
    <ul>
        <li>

<span class="param-type">Symbol</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>


<table class="props">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>INTEGER</code></td>


            <td class="type">


<span class="param-type">Symbol</span>


            </td>


            <td class="description last"></td>
        </tr>


        <tr>

                <td class="name"><code>TEXT</code></td>


            <td class="type">


<span class="param-type">Symbol</span>


            </td>


            <td class="description last"></td>
        </tr>


        <tr>

                <td class="name"><code>DICTIONARY</code></td>


            <td class="type">


<span class="param-type">Symbol</span>


            </td>


            <td class="description last"></td>
        </tr>


        <tr>

                <td class="name"><code>BOOLEAN</code></td>


            <td class="type">


<span class="param-type">Symbol</span>


            </td>


            <td class="description last"></td>
        </tr>


        <tr>

                <td class="name"><code>LIST</code></td>


            <td class="type">


<span class="param-type">Symbol</span>


            </td>


            <td class="description last"></td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line902">line 902</a>
    </li></ul></dd>


</dl>


<h4 class="name" id="Status"><span class="type-signature">(readonly) </span>Status<span class="type-signature"> :Symbol</span></h4>


<div class="description">
    Shelf status
</div>


    <h5>Type:</h5>
    <ul>
        <li>

<span class="param-type">Symbol</span>


        </li>
    </ul>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line870">line 870</a>
    </li></ul></dd>


</dl>


        <h3 class="subsection-title">Methods</h3>


    <h4 class="name" id="_checkAvailability"><span class="type-signature"></span>_checkAvailability<span class="signature">(methodName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>


<div class="description">
    Check whether it is possible to run a given shelf command.

<p>Since all Shelf methods call _checkAvailability, we also use it as a means to throttle those calls.</p>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th>Attributes</th>


        <th>Default</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>methodName</code></td>


            <td class="type">


<span class="param-type">string</span>


            </td>


                <td class="attributes">

                    &lt;optional><br>


                </td>


                <td class="default">

                    ""

                </td>


            <td class="description last">name of the method requiring a check</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line788">line 788</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if it is not possible to run the given shelf command
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


    <h4 class="name" id="_checkKey"><span class="type-signature"></span>_checkKey<span class="signature">(key)</span><span class="type-signature"></span></h4>


<div class="description">
    Check the validity of the key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">object</span>


            </td>


            <td class="description last">key whose validity is to be checked</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line843">line 843</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if the key is invalid
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


    <h4 class="name" id="_getValue"><span class="type-signature">(protected) </span>_getValue<span class="signature">(key, type, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>


<div class="description">
    Get the value associated with the given key.

<p>This is a generic method, typically called from the Shelf helper methods, e.g. getBinaryValue.</p>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th>Attributes</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


                <td class="attributes">


                </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>type</code></td>


            <td class="type">


<span class="param-type">Shelf.Type</span>


            </td>


                <td class="attributes">


                </td>


            <td class="description last">the type of the record associated with the given key</td>
        </tr>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


                <td class="attributes">

                    &lt;optional><br>


                </td>


            <td class="description last">the options, e.g. the default value returned if no record with the
given key exists on the shelf</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line710">line 710</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is a record associated with the given key but it is not of
	the given type
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;any></span>


    </dd>
</dl>


    <h4 class="name" id="_updateValue"><span class="type-signature">(protected) </span>_updateValue<span class="signature">(key, type, update)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>


<div class="description">
    Update the value associated with the given key.

<p>This is a generic method, typically called from the Shelf helper methods, e.g. setBinaryValue.</p>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>type</code></td>


            <td class="type">


<span class="param-type">Shelf.Type</span>


            </td>


            <td class="description last">the type of the record associated with the given key</td>
        </tr>


        <tr>

                <td class="name"><code>update</code></td>


            <td class="type">


<span class="param-type">*</span>


            </td>


            <td class="description last">the desired update</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line642">line 642</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record associated with the given key or if there is one
	but it is not of the given type
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the updated value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;any></span>


    </dd>
</dl>


    <h4 class="name" id="addIntegerValue"><span class="type-signature"></span>addIntegerValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;number>}</span></h4>


<div class="description">
    Add a delta to  the value of a record of type INTEGER associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>delta</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last">the delta, positive or negative, to add to the value</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line181">line 181</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if delta is not an integer, or if there is no record with the given
	key, or if there is a record but it is locked or it is not of type INTEGER
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;number></span>


    </dd>
</dl>


    <h4 class="name" id="appendListValue"><span class="type-signature"></span>appendListValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;*>>}</span></h4>


<div class="description">
    Append an element, or a list of elements, to the value of a record of type LIST associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>elements</code></td>


            <td class="type">


<span class="param-type">*</span>


            </td>


            <td class="description last">the element or list of elements to be appended</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line318">line 318</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key, or if there is a record
	but it is locked or it is not of type LIST
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Array.&lt;*>></span>


    </dd>
</dl>


    <h4 class="name" id="clearListValue"><span class="type-signature"></span>clearListValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;*>>}</span></h4>


<div class="description">
    Empty the value of a record of type LIST associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line365">line 365</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key, or if there is a record
	but it is locked or it is not of type LIST
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new, empty value, i.e. []
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Array.&lt;*>></span>


    </dd>
</dl>


    <h4 class="name" id="counterBalanceSelect"><span class="type-signature"></span>counterBalanceSelect<span class="signature">(key, groups, groupSizes)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>


<div class="description">
    Get the name of a group, using a counterbalanced design.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>groups</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">the names of the groups</td>
        </tr>


        <tr>

                <td class="name"><code>groupSizes</code></td>


            <td class="type">


<span class="param-type">Array.&lt;number></span>


            </td>


            <td class="description last">the size of the groups</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line576">line 576</a>
    </li></ul></dd>


</dl>


<h5>Returns:</h5>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;any></span>


    </dd>
</dl>


    <h4 class="name" id="flipBooleanValue"><span class="type-signature"></span>flipBooleanValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span></h4>


<div class="description">
    Flip the value of a record of type BOOLEAN associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line108">line 108</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key, or
	if there is a record but it is not of type BOOLEAN
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new, flipped, value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;boolean></span>


    </dd>
</dl>


    <h4 class="name" id="getBooleanValue"><span class="type-signature"></span>getBooleanValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span></h4>


<div class="description">
    Get the value of a record of type BOOLEAN associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>defaultValue</code></td>


            <td class="type">


<span class="param-type">boolean</span>


            </td>


            <td class="description last">the default value returned if no record with the given key exists
	on the shelf</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line56">line 56</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is a record associated with the given key
	but it is not of type BOOLEAN
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the value associated with the key
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;boolean></span>


    </dd>
</dl>


    <h4 class="name" id="getDictionaryFieldNames"><span class="type-signature"></span>getDictionaryFieldNames<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;string>>}</span></h4>


<div class="description">
    Get the names of the fields in the dictionary record associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line408">line 408</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key, or if there is a record
	but it is locked or it is not of type DICTIONARY
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the list of field names
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Array.&lt;string>></span>


    </dd>
</dl>


    <h4 class="name" id="getDictionaryFieldValue"><span class="type-signature"></span>getDictionaryFieldValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>


<div class="description">
    Get the value of a given field in the dictionary record associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>fieldName</code></td>


            <td class="type">


<span class="param-type">string</span>


            </td>


            <td class="description last">the name of the field</td>
        </tr>


        <tr>

                <td class="name"><code>defaultValue</code></td>


            <td class="type">


<span class="param-type">boolean</span>


            </td>


            <td class="description last">the default value returned if no record with the given key exists on
	the shelf, or if is a record of type DICTIONARY with the given key but it has no such field</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line425">line 425</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key,
	or if there is a record but it is locked or it is not of type DICTIONARY
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the value of that field
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;*></span>


    </dd>
</dl>


    <h4 class="name" id="getDictionaryValue"><span class="type-signature"></span>getDictionaryValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Object.&lt;string, *>>}</span></h4>


<div class="description">
    Get the value of a record of type DICTIONARY associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>defaultValue</code></td>


            <td class="type">


<span class="param-type">Object.&lt;string, *></span>


            </td>


            <td class="description last">the default value returned if no record with the given key
	exists on the shelf</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line470">line 470</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key,
	or if there is a record but it is locked or it is not of type DICTIONARY
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the value associated with the key
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Object.&lt;string, *>></span>


    </dd>
</dl>


    <h4 class="name" id="getIntegerValue"><span class="type-signature"></span>getIntegerValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;number>}</span></h4>


<div class="description">
    Get the value of a record of type INTEGER associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>defaultValue</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last">the default value returned if no record with the given key
	exists on the shelf</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line129">line 129</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key,
	or if there is a record but it is locked or it is not of type BOOLEAN
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the value associated with the key
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;number></span>


    </dd>
</dl>


    <h4 class="name" id="getListValue"><span class="type-signature"></span>getListValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;*>>}</span></h4>


<div class="description">
    Get the value of a record of type LIST associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>defaultValue</code></td>


            <td class="type">


<span class="param-type">Array.&lt;*></span>


            </td>


            <td class="description last">the default value returned if no record with the given key exists on
	the shelf</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line266">line 266</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key, or if there is a record
	but it is locked or it is not of type LIST
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the value associated with the key
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Array.&lt;*>></span>


    </dd>
</dl>


    <h4 class="name" id="getTextValue"><span class="type-signature"></span>getTextValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>


<div class="description">
    Get the value of a record of type TEXT associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>defaultValue</code></td>


            <td class="type">


<span class="param-type">string</span>


            </td>


            <td class="description last">the default value returned if no record with the given key exists on
	the shelf</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line214">line 214</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is a record associated with the given key but it is
	not of type TEXT
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the value associated with the key
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;string></span>


    </dd>
</dl>


    <h4 class="name" id="incrementComponent"><span class="type-signature"></span>incrementComponent<span class="signature">(key, increment, callback)</span><span class="type-signature"> &rarr; {function}</span></h4>


<div class="description">
    Schedulable component that will block the experiment until the counter associated with the given key
has been incremented by the given amount.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">

            </td>


            <td class="description last"></td>
        </tr>


        <tr>

                <td class="name"><code>increment</code></td>


            <td class="type">

            </td>


            <td class="description last"></td>
        </tr>


        <tr>

                <td class="name"><code>callback</code></td>


            <td class="type">

            </td>


            <td class="description last"></td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line522">line 522</a>
    </li></ul></dd>


</dl>


<h5>Returns:</h5>


<div class="param-desc">
    a component that can be scheduled
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">function</span>


    </dd>
</dl>


    <h5>Example</h5>

    <pre class="prettyprint"><code>const flowScheduler = new Scheduler(psychoJS);
var experimentCounter = '&lt;>';
flowScheduler.add(psychoJS.shelf.incrementComponent(['counter'], 1, (value) => experimentCounter = value));</code></pre>


    <h4 class="name" id="popListValue"><span class="type-signature"></span>popListValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>


<div class="description">
    Pop an element, at the given index, from the value of a record of type LIST associated
with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th>Attributes</th>


        <th>Default</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


                <td class="attributes">


                </td>


                <td class="default">

                </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>index</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


                <td class="attributes">

                    &lt;optional><br>


                </td>


                <td class="default">

                    -1

                </td>


            <td class="description last">the index of the element to be popped</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line341">line 341</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key, or if there is a record
	but it is locked or it is not of type LIST
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the popped element
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;*></span>


    </dd>
</dl>


    <h4 class="name" id="setBooleanValue"><span class="type-signature"></span>setBooleanValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span></h4>


<div class="description">
    Set the value of a record of type BOOLEAN associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">


<span class="param-type">boolean</span>


            </td>


            <td class="description last">the new value</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line75">line 75</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if value is not a boolean, or if there is no record with the given
	key, or if there is a record but it is locked or it is not of type BOOLEAN
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;boolean></span>


    </dd>
</dl>


    <h4 class="name" id="setDictionaryFieldValue"><span class="type-signature"></span>setDictionaryFieldValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Object.&lt;string, *>>}</span></h4>


<div class="description">
    Set a field in the dictionary record associated to the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>fieldName</code></td>


            <td class="type">


<span class="param-type">string</span>


            </td>


            <td class="description last">the name of the field</td>
        </tr>


        <tr>

                <td class="name"><code>fieldValue</code></td>


            <td class="type">


<span class="param-type">*</span>


            </td>


            <td class="description last">the value of the field</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line445">line 445</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key,
	or if there is a record but it is locked or it is not of type DICTIONARY
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the updated dictionary
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Object.&lt;string, *>></span>


    </dd>
</dl>


    <h4 class="name" id="setDictionaryValue"><span class="type-signature"></span>setDictionaryValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Object.&lt;string, *>>}</span></h4>


<div class="description">
    Set the value of a record of type DICTIONARY associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">


<span class="param-type">Object.&lt;string, *></span>


            </td>


            <td class="description last">the new value</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line489">line 489</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if value is not an object, or or if there is no record
	with the given key, or if there is a record but it is locked or it is not of type DICTIONARY
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Object.&lt;string, *>></span>


    </dd>
</dl>


    <h4 class="name" id="setIntegerValue"><span class="type-signature"></span>setIntegerValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;number>}</span></h4>


<div class="description">
    Set the value of a record of type INTEGER associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last">the new value</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line148">line 148</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if value is not an integer, or or if there is no record
	with the given key, or if there is a record but it is locked or it is not of type INTEGER
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;number></span>


    </dd>
</dl>


    <h4 class="name" id="setListValue"><span class="type-signature"></span>setListValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;*>>}</span></h4>


<div class="description">
    Set the value of a record of type LIST associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">


<span class="param-type">Array.&lt;*></span>


            </td>


            <td class="description last">the new value</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line285">line 285</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if value is not an array or if there is no record with the given key,
	or if there is a record but it is locked or it is not of type LIST
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Array.&lt;*>></span>


    </dd>
</dl>


    <h4 class="name" id="setTextValue"><span class="type-signature"></span>setTextValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>


<div class="description">
    Set the value of a record of type TEXT associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


        <tr>

                <td class="name"><code>value</code></td>


            <td class="type">


<span class="param-type">string</span>


            </td>


            <td class="description last">the new value</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line233">line 233</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if value is not a string, or if there is a record associated
	with the given key but it is not of type TEXT
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;string></span>


    </dd>
</dl>


    <h4 class="name" id="shuffleListValue"><span class="type-signature"></span>shuffleListValue<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;*>>}</span></h4>


<div class="description">
    Shuffle the elements of the value of a record of type LIST associated with the given key.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>options</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last">
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>key</code></td>


            <td class="type">


<span class="param-type">Array.&lt;string></span>


            </td>


            <td class="description last">key as an array of key components</td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="data_Shelf.js.html">data/Shelf.js</a>, <a href="data_Shelf.js.html#line386">line 386</a>
    </li></ul></dd>


</dl>


<h5>Throws:</h5>


<dl>
    <dt>
        <div class="param-desc">
        exception if there is no record with the given key, or if there is a record
	but it is locked or it is not of type LIST
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>

<span class="param-type">Object.&lt;string, *></span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>


<div class="param-desc">
    the new, shuffled value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Array.&lt;*>></span>


    </dd>
</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-core.html">core</a></li><li><a href="module-data.html">data</a></li><li><a href="module-sound.html">sound</a></li><li><a href="module-util.html">util</a></li><li><a href="module-visual.html">visual</a></li></ul><h3>Classes</h3><ul><li><a href="FaceDetector_FaceDetector.html">FaceDetector</a></li><li><a href="module.data.MultiStairHandler.html">MultiStairHandler</a></li><li><a href="module.data.QuestHandler.html">QuestHandler</a></li><li><a href="module-core.BuilderKeyResponse.html">BuilderKeyResponse</a></li><li><a href="module-core.EventManager.html">EventManager</a></li><li><a href="module-core.GUI.html">GUI</a></li><li><a href="module-core.Keyboard.html">Keyboard</a></li><li><a href="module-core.KeyPress.html">KeyPress</a></li><li><a href="module-core.Logger.html">Logger</a></li><li><a href="module-core.MinimalStim.html">MinimalStim</a></li><li><a href="module-core.Mouse.html">Mouse</a></li><li><a href="module-core.PsychoJS.html">PsychoJS</a></li><li><a href="module-core.ServerManager.html">ServerManager</a></li><li><a href="module-core.Window.html">Window</a></li><li><a href="module-data.ExperimentHandler.html">ExperimentHandler</a></li><li><a href="module-data.MultiStairHandler.html">MultiStairHandler</a></li><li><a href="module-data.QuestHandler.html">QuestHandler</a></li><li><a href="module-data.Shelf.html">Shelf</a></li><li><a href="module-data.TrialHandler.html">TrialHandler</a></li><li><a href="module-hardware.Camera.html">Camera</a></li><li><a href="module-sound.AudioClip.html">AudioClip</a></li><li><a href="module-sound.AudioClipPlayer.html">AudioClipPlayer</a></li><li><a href="module-sound.Microphone.html">Microphone</a></li><li><a href="module-sound.Sound.html">Sound</a></li><li><a href="module-sound.TonePlayer.html">TonePlayer</a></li><li><a href="module-sound.TrackPlayer.html">TrackPlayer</a></li><li><a href="module-sound.Transcriber.html">Transcriber</a></li><li><a href="module-sound.Transcript.html">Transcript</a></li><li><a href="module-util.Clock.html">Clock</a></li><li><a href="module-util.Color.html">Color</a></li><li><a href="module-util.CountdownTimer.html">CountdownTimer</a></li><li><a href="module-util.EventEmitter.html">EventEmitter</a></li><li><a href="module-util.MixinBuilder.html">MixinBuilder</a></li><li><a href="module-util.MonotonicClock.html">MonotonicClock</a></li><li><a href="module-util.PsychObject.html">PsychObject</a></li><li><a href="module-util.Scheduler.html">Scheduler</a></li><li><a href="module-visual.ButtonStim.html">ButtonStim</a></li><li><a href="module-visual.FaceDetector.html">FaceDetector</a></li><li><a href="module-visual.Form.html">Form</a></li><li><a href="module-visual.GratingStim.html">GratingStim</a></li><li><a href="module-visual.ImageStim.html">ImageStim</a></li><li><a href="module-visual.MovieStim.html">MovieStim</a></li><li><a href="module-visual.Polygon.html">Polygon</a></li><li><a href="module-visual.Rect.html">Rect</a></li><li><a href="module-visual.ShapeStim.html">ShapeStim</a></li><li><a href="module-visual.Slider.html">Slider</a></li><li><a href="module-visual.TextBox.html">TextBox</a></li><li><a href="module-visual.TextStim.html">TextStim</a></li><li><a href="module-visual.VisualStim.html">VisualStim</a></li></ul><h3>Interfaces</h3><ul><li><a href="module-sound.SoundPlayer.html">SoundPlayer</a></li></ul><h3>Mixins</h3><ul><li><a href="module-core.WindowMixin.html">WindowMixin</a></li><li><a href="module-util.ColorMixin.html">ColorMixin</a></li></ul><h3>Global</h3><ul><li><a href="global.html#pad">pad</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>