global.html

<!DOCTYPE html>
<html lang="en">
<head>
    
    <meta charset="utf-8">
    <title>Global - Documentation</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.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
    <script src="scripts/nav.js" defer></script>
    
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav >
    
    <input type="text" id="nav-search" placeholder="Search" />
    
    
    <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/toolbox-team/reddit-moderator-toolbox" target="_blank" class="menu-item" >Github</a></h2><h2><a href="https://www.reddit.com/r/toolbox" target="_blank" class="menu-item" >Subreddit</a></h2><h3>Classes</h3><ul><li><a href="Module.html">Module</a><ul class='methods'><li data-type='method'><a href="Module.html#get">get</a></li><li data-type='method'><a href="Module.html#getEnabled">getEnabled</a></li><li data-type='method'><a href="Module.html#init">init</a></li><li data-type='method'><a href="Module.html#set">set</a></li><li data-type='method'><a href="Module.html#setEnabled">setEnabled</a></li></ul></li><li><a href="TBListener.html">TBListener</a><ul class='methods'><li data-type='method'><a href="TBListener.html#clear">clear</a></li><li data-type='method'><a href="TBListener.html#on">on</a></li><li data-type='method'><a href="TBListener.html#start">start</a></li><li data-type='method'><a href="TBListener.html#stop">stop</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#DISPLAY_BOTTOM">DISPLAY_BOTTOM</a></li><li><a href="global.html#DISPLAY_CENTER">DISPLAY_CENTER</a></li><li><a href="global.html#FEEDBACK_NEGATIVE">FEEDBACK_NEGATIVE</a></li><li><a href="global.html#FEEDBACK_NEUTRAL">FEEDBACK_NEUTRAL</a></li><li><a href="global.html#FEEDBACK_POSITIVE">FEEDBACK_POSITIVE</a></li><li><a href="global.html#ModNotesBadge">ModNotesBadge</a></li><li><a href="global.html#ModNotesPager">ModNotesPager</a></li><li><a href="global.html#ModNotesPopup">ModNotesPopup</a></li><li><a href="global.html#NoteTableRow">NoteTableRow</a></li><li><a href="global.html#RandomFeedback">RandomFeedback</a></li><li><a href="global.html#RandomQuote">RandomQuote</a></li><li><a href="global.html#TBsettingsObject">TBsettingsObject</a></li><li><a href="global.html#actionButton">actionButton</a></li><li><a href="global.html#addModSubsToSidebar">addModSubsToSidebar</a></li><li><a href="global.html#addToSiteTable">addToSiteTable</a></li><li><a href="global.html#addTrophiesToSidebar">addTrophiesToSidebar</a></li><li><a href="global.html#alert">alert</a></li><li><a href="global.html#baseDomain">baseDomain</a></li><li><a href="global.html#browserName">browserName</a></li><li><a href="global.html#buildSha">buildSha</a></li><li><a href="global.html#buildType">buildType</a></li><li><a href="global.html#button">button</a></li><li><a href="global.html#checkForActions">checkForActions</a></li><li><a href="global.html#cleanSubredditName">cleanSubredditName</a></li><li><a href="global.html#clearCache">clearCache</a></li><li><a href="global.html#colorNameToHex">colorNameToHex</a></li><li><a href="global.html#contextTrigger">contextTrigger</a></li><li><a href="global.html#createDeferredProcessQueue">createDeferredProcessQueue</a></li><li><a href="global.html#daysToMilliseconds">daysToMilliseconds</a></li><li><a href="global.html#debounce">debounce</a></li><li><a href="global.html#debugInformation">debugInformation</a></li><li><a href="global.html#defaultNoteLabelValueToLabelType">defaultNoteLabelValueToLabelType</a></li><li><a href="global.html#delay">delay</a></li><li><a href="global.html#displayNotes">displayNotes</a></li><li><a href="global.html#domain">domain</a></li><li><a href="global.html#escapeHTML">escapeHTML</a></li><li><a href="global.html#fetchModSubs">fetchModSubs</a></li><li><a href="global.html#fetchNewsNotes">fetchNewsNotes</a></li><li><a href="global.html#figureOutMulti">figureOutMulti</a></li><li><a href="global.html#filterModdable">filterModdable</a></li><li><a href="global.html#getActions">getActions</a></li><li><a href="global.html#getAllModNotes">getAllModNotes</a></li><li><a href="global.html#getAnonymizedSettings">getAnonymizedSettings</a></li><li><a href="global.html#getCache">getCache</a></li><li><a href="global.html#getContextURL">getContextURL</a></li><li><a href="global.html#getLastVersion">getLastVersion</a></li><li><a href="global.html#getLatestModNote">getLatestModNote</a></li><li><a href="global.html#getModSubs">getModSubs</a></li><li><a href="global.html#getModlog">getModlog</a></li><li><a href="global.html#getRandomNumber">getRandomNumber</a></li><li><a href="global.html#getSetting">getSetting</a></li><li><a href="global.html#getSettingAsync">getSettingAsync</a></li><li><a href="global.html#getSettings">getSettings</a></li><li><a href="global.html#getSubmissionFullname">getSubmissionFullname</a></li><li><a href="global.html#getSubredditColors">getSubredditColors</a></li><li><a href="global.html#getTime">getTime</a></li><li><a href="global.html#getToolboxDevs">getToolboxDevs</a></li><li><a href="global.html#handleMessage">handleMessage</a></li><li><a href="global.html#handleTBThings">handleTBThings</a></li><li><a href="global.html#handleThing">handleThing</a></li><li><a href="global.html#hideModActionsThings">hideModActionsThings</a></li><li><a href="global.html#htmlDecode">htmlDecode</a></li><li><a href="global.html#htmlEncode">htmlEncode</a></li><li><a href="global.html#humaniseDays">humaniseDays</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#initialLoadPromise">initialLoadPromise</a></li><li><a href="global.html#isConfigValidVersion">isConfigValidVersion</a></li><li><a href="global.html#isEquivalent">isEquivalent</a></li><li><a href="global.html#isModSub">isModSub</a></li><li><a href="global.html#isNewModmail">isNewModmail</a></li><li><a href="global.html#isOldReddit">isOldReddit</a></li><li><a href="global.html#labelColors">labelColors</a></li><li><a href="global.html#labelNames">labelNames</a></li><li><a href="global.html#link">link</a></li><li><a href="global.html#listenerAliases">listenerAliases</a></li><li><a href="global.html#literalRegExp">literalRegExp</a></li><li><a href="global.html#makeCommentThread">makeCommentThread</a></li><li><a href="global.html#makeQueueOverlay">makeQueueOverlay</a></li><li><a href="global.html#makeSingleComment">makeSingleComment</a></li><li><a href="global.html#makeSubmissionEntry">makeSubmissionEntry</a></li><li><a href="global.html#makeUserSidebar">makeUserSidebar</a></li><li><a href="global.html#messageHandlers">messageHandlers</a></li><li><a href="global.html#millisecondsToDays">millisecondsToDays</a></li><li><a href="global.html#minutesToMilliseconds">minutesToMilliseconds</a></li><li><a href="global.html#modbarExists">modbarExists</a></li><li><a href="global.html#moveArrayItem">moveArrayItem</a></li><li><a href="global.html#newModmailSidebar">newModmailSidebar</a></li><li><a href="global.html#niceDateDiff">niceDateDiff</a></li><li><a href="global.html#notification">notification</a></li><li><a href="global.html#overlay">overlay</a></li><li><a href="global.html#pager">pager</a></li><li><a href="global.html#pagerForItems">pagerForItems</a></li><li><a href="global.html#parseComments">parseComments</a></li><li><a href="global.html#parser">parser</a></li><li><a href="global.html#popup">popup</a></li><li><a href="global.html#progressivePager">progressivePager</a></li><li><a href="global.html#purify">purify</a></li><li><a href="global.html#purifyObject">purifyObject</a></li><li><a href="global.html#regExpEscape">regExpEscape</a></li><li><a href="global.html#relativeTime">relativeTime</a></li><li><a href="global.html#reloadIframe">reloadIframe</a></li><li><a href="global.html#reloadToolbox">reloadToolbox</a></li><li><a href="global.html#remove">remove</a></li><li><a href="global.html#removeLastDirectoryPartOf">removeLastDirectoryPartOf</a></li><li><a href="global.html#removeQuotes">removeQuotes</a></li><li><a href="global.html#replaceAll">replaceAll</a></li><li><a href="global.html#replaceTokens">replaceTokens</a></li><li><a href="global.html#saneSort">saneSort</a></li><li><a href="global.html#saneSortAs">saneSortAs</a></li><li><a href="global.html#saveSettingsToBrowser">saveSettingsToBrowser</a></li><li><a href="global.html#searchProfile">searchProfile</a></li><li><a href="global.html#setCache">setCache</a></li><li><a href="global.html#setSetting">setSetting</a></li><li><a href="global.html#setSettingAsync">setSettingAsync</a></li><li><a href="global.html#settings">settings</a></li><li><a href="global.html#settingsToObject">settingsToObject</a></li><li><a href="global.html#shortVersion">shortVersion</a></li><li><a href="global.html#showNote">showNote</a></li><li><a href="global.html#sortBy">sortBy</a></li><li><a href="global.html#standardColors">standardColors</a></li><li><a href="global.html#stringToColor">stringToColor</a></li><li><a href="global.html#submissionFullnamesCache">submissionFullnamesCache</a></li><li><a href="global.html#tbRedditEvent">tbRedditEvent</a></li><li><a href="global.html#textFeedback">textFeedback</a></li><li><a href="global.html#timeConverterRead">timeConverterRead</a></li><li><a href="global.html#title_to_url">title_to_url</a></li><li><a href="global.html#toolboxVersion">toolboxVersion</a></li><li><a href="global.html#toolboxVersionName">toolboxVersionName</a></li><li><a href="global.html#typeNames">typeNames</a></li><li><a href="global.html#unescapeHTML">unescapeHTML</a></li><li><a href="global.html#unescapeJSON">unescapeJSON</a></li><li><a href="global.html#verifiedSettingsSave">verifiedSettingsSave</a></li><li><a href="global.html#watchForURLChanges">watchForURLChanges</a></li><li><a href="global.html#wrapWithLastValue">wrapWithLastValue</a></li><li><a href="global.html#zlibDeflate">zlibDeflate</a></li><li><a href="global.html#zlibInflate">zlibInflate</a></li></ul>
    
</nav>

<div id="main">
    
    <h1 class="page-title">Global</h1>
    

<section>

<header>
    
        <h2>
        
            
        </h2>
        
    
</header>

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

</dl>


        </div>
    

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

        
<h4 class="name" id="DISPLAY_BOTTOM"><span class="type-signature type-signature-constant">(constant) </span>DISPLAY_BOTTOM<span class="type-signature"></span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line89">line 89</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use <code>TextFeedbackLocation.BOTTOM</code></li></ul></dd>
    

</dl>


<h4 class="name" id="DISPLAY_CENTER"><span class="type-signature type-signature-constant">(constant) </span>DISPLAY_CENTER<span class="type-signature"></span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line87">line 87</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use <code>TextFeedbackLocation.CENTER</code></li></ul></dd>
    

</dl>


<h4 class="name" id="FEEDBACK_NEGATIVE"><span class="type-signature type-signature-constant">(constant) </span>FEEDBACK_NEGATIVE<span class="type-signature"></span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line84">line 84</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use <code>TextFeedbackKind.NEGATIVE</code></li></ul></dd>
    

</dl>


<h4 class="name" id="FEEDBACK_NEUTRAL"><span class="type-signature type-signature-constant">(constant) </span>FEEDBACK_NEUTRAL<span class="type-signature"></span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line80">line 80</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use <code>TextFeedbackKind.NEUTRAL</code></li></ul></dd>
    

</dl>


<h4 class="name" id="FEEDBACK_POSITIVE"><span class="type-signature type-signature-constant">(constant) </span>FEEDBACK_POSITIVE<span class="type-signature"></span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line82">line 82</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use <code>TextFeedbackKind.POSITIVE</code></li></ul></dd>
    

</dl>


<h4 class="name" id="RandomFeedback"><span class="type-signature type-signature-constant">(constant) </span>RandomFeedback<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>A random text message for long loading tasks, determined at page load.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line491">line 491</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>A random text message for long loading tasks, determined at page load.</p>
</div>


<h4 class="name" id="RandomQuote"><span class="type-signature type-signature-constant">(constant) </span>RandomQuote<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>A random quote for the about page, determined at page load.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line459">line 459</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>A random quote for the about page, determined at page load.</p>
</div>


<h4 class="name" id="TBsettingsObject"><span class="type-signature"></span>TBsettingsObject<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>An object mapping setting keys to their currently loaded values.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line26">line 26</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>An object mapping setting keys to their currently loaded values.</p>
</div>


<h4 class="name" id="actionButton"><span class="type-signature type-signature-constant">(constant) </span>actionButton<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Generates HTML for an action button.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line107">line 107</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Generates HTML for an action button.</p>
</div>


<h4 class="name" id="baseDomain"><span class="type-signature type-signature-constant">(constant) </span>baseDomain<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>The base domain to use for links to content on Reddit. If we are on new
modmail we use www.reddit.com; wnywhere else we use whatever is the current
domain.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line258">line 258</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>The base domain to use for links to content on Reddit. If we are on new
modmail we use www.reddit.com; wnywhere else we use whatever is the current
domain.</p>
</div>


<h4 class="name" id="browserName"><span class="type-signature type-signature-constant">(constant) </span>browserName<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>The name of the current browser.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line302">line 302</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>The name of the current browser.</p>
</div>


<h4 class="name" id="buildSha"><span class="type-signature type-signature-constant">(constant) </span>buildSha<span class="type-signature"> :string|null</span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line19">line 19</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

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


        </li>
    </ul>


<h4 class="name" id="buildType"><span class="type-signature type-signature-constant">(constant) </span>buildType<span class="type-signature"> :'stable'|'beta'|'dev'</span></h4>


<dl class="details">
    

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

</dl>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">'stable'</span>
|

<span class="param-type">'beta'</span>
|

<span class="param-type">'dev'</span>


        </li>
    </ul>


<h4 class="name" id="button"><span class="type-signature type-signature-constant">(constant) </span>button<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Generates HTML for a general button.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line97">line 97</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Generates HTML for a general button.</p>
</div>


<h4 class="name" id="defaultNoteLabelValueToLabelType"><span class="type-signature type-signature-constant">(constant) </span>defaultNoteLabelValueToLabelType<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Mapping of possible values of the <code>defaultNoteLabelValue</code> setting to actual
label type strings used by the API (or in the case of &quot;none&quot;, <code>undefined</code>)</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line84">line 84</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Mapping of possible values of the <code>defaultNoteLabelValue</code> setting to actual
label type strings used by the API (or in the case of &quot;none&quot;, <code>undefined</code>)</p>
</div>


<h4 class="name" id="delay"><span class="type-signature type-signature-constant">(constant) </span>delay<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Returns a promise that resolves after the given time.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line10">line 10</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Returns a promise that resolves after the given time.</p>
</div>


<h4 class="name" id="domain"><span class="type-signature type-signature-constant">(constant) </span>domain<span class="type-signature"> :string</span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>The current subdomain (NOT full domain).</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line13">line 13</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>The current subdomain (NOT full domain).</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


<h4 class="name" id="getAnonymizedSettings"><span class="type-signature type-signature-constant">(constant) </span>getAnonymizedSettings<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Generates an anonymized version of the settings object, with some sensitive
settings omitted and other settings represented differently.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line87">line 87</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Generates an anonymized version of the settings object, with some sensitive
settings omitted and other settings represented differently.</p>
</div>


<h4 class="name" id="getSettings"><span class="type-signature type-signature-constant">(constant) </span>getSettings<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Promises a copy of the current settings object, containing all setting keys
and their values.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line351">line 351</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Promises a copy of the current settings object, containing all setting keys
and their values.</p>
</div>


<h4 class="name" id="initialLoadPromise"><span class="type-signature type-signature-constant">(constant) </span>initialLoadPromise<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>A promise which will fulfill once the current settings are fetched from
extension storage. Once this promise fulfills, it's safe to assume
<code>TBsettingsObject</code> contains our settings. Settings reads are delayed until
then - either by awaiting this promise, or by waiting for the
<code>TBStorageLoaded</code> window event, which is emitted at the same time.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line35">line 35</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>A promise which will fulfill once the current settings are fetched from
extension storage. Once this promise fulfills, it's safe to assume
<code>TBsettingsObject</code> contains our settings. Settings reads are delayed until
then - either by awaiting this promise, or by waiting for the
<code>TBStorageLoaded</code> window event, which is emitted at the same time.</p>
</div>


<h4 class="name" id="isNewModmail"><span class="type-signature type-signature-constant">(constant) </span>isNewModmail<span class="type-signature"></span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line87">line 87</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Check <code>currentPlatform</code> directly instead.</li></ul></dd>
    

</dl>


<h4 class="name" id="isOldReddit"><span class="type-signature type-signature-constant">(constant) </span>isOldReddit<span class="type-signature"></span></h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line85">line 85</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Check <code>currentPlatform</code> directly instead.</li></ul></dd>
    

</dl>


<h4 class="name" id="labelColors"><span class="type-signature type-signature-constant">(constant) </span>labelColors<span class="type-signature"> :object</span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>An object mapping modnote labels to display colors. All colors are from
the default Toolbox usernote type colors, except the HELPFUL_USER label
which doesn't have an analogue in Toolbox usernotes.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line54">line 54</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>An object mapping modnote labels to display colors. All colors are from
the default Toolbox usernote type colors, except the HELPFUL_USER label
which doesn't have an analogue in Toolbox usernotes.</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


<h4 class="name" id="labelNames"><span class="type-signature type-signature-constant">(constant) </span>labelNames<span class="type-signature"> :object</span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>An object mapping modnote lavels to human-friendly display names.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line69">line 69</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>An object mapping modnote lavels to human-friendly display names.</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


<h4 class="name" id="listenerAliases"><span class="type-signature type-signature-constant">(constant) </span>listenerAliases<span class="type-signature"> :Object.&lt;string, Array.&lt;string>></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Event listener aliases. Allows you to listen for <code>author</code> and get <code>postAuthor</code> and <code>commentAuthor</code> events,
for example.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tblistener.js.html">tblistener.js</a>, <a href="tblistener.js.html#line13">line 13</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Event listener aliases. Allows you to listen for <code>author</code> and get <code>postAuthor</code> and <code>commentAuthor</code> events,
for example.</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object.&lt;string, Array.&lt;string>></span>


        </li>
    </ul>


<h4 class="name" id="literalRegExp"><span class="type-signature type-signature-constant">(constant) </span>literalRegExp<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Generates a regular expression that will match only a given string.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line478">line 478</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Generates a regular expression that will match only a given string.</p>
</div>


<h4 class="name" id="messageHandlers"><span class="type-signature"></span>messageHandlers<span class="type-signature"> :Map.&lt;string, function()></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>A map storing handlers for the
various toolbox-defined message types</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="background_messageHandling.js.html">background/messageHandling.js</a>, <a href="background_messageHandling.js.html#line3">line 3</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>A map storing handlers for the
various toolbox-defined message types</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Map.&lt;string, function()></span>


        </li>
    </ul>


<h4 class="name" id="modbarExists"><span class="type-signature type-signature-constant">(constant) </span>modbarExists<span class="type-signature"> :Promise.&lt;void></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>A promise which resolves when the modbar is added to the page.</p></li></ul></dd>
    

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

</dl>


<div class="description usertext">
    <p>A promise which resolves when the modbar is added to the page.</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Promise.&lt;void></span>


        </li>
    </ul>


<h4 class="name" id="parser"><span class="type-signature type-signature-constant">(constant) </span>parser<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Provides an initialized SnuOwnd parser.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line798">line 798</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Provides an initialized SnuOwnd parser.</p>
</div>


<h4 class="name" id="removeQuotes"><span class="type-signature type-signature-constant">(constant) </span>removeQuotes<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Removes ASCII single and double quotes from a string.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line722">line 722</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Removes ASCII single and double quotes from a string.</p>
</div>


<h4 class="name" id="settings"><span class="type-signature type-signature-constant">(constant) </span>settings<span class="type-signature"> :Array.&lt;string></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>A list of all currently loaded settings keys.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line20">line 20</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>A list of all currently loaded settings keys.</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;string></span>


        </li>
    </ul>


<h4 class="name" id="shortVersion"><span class="type-signature type-signature-constant">(constant) </span>shortVersion<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Numeric representation of basic version information; compare
major/minor/patch/build instead when possible</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line79">line 79</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Numeric representation of basic version information; compare
major/minor/patch/build instead when possible</p>
</div>


    <h5 class="h5-examples">Example</h5>
    
    <pre class="prettyprint"><code>60113</code></pre>


<h4 class="name" id="standardColors"><span class="type-signature type-signature-constant">(constant) </span>standardColors<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Map of commonly used color names to CSS color values.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line66">line 66</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Map of commonly used color names to CSS color values.</p>
</div>


<h4 class="name" id="submissionFullnamesCache"><span class="type-signature type-signature-constant">(constant) </span>submissionFullnamesCache<span class="type-signature"> :Record.&lt;string, Promise.&lt;string>></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>In-page cache of comment fullnames to the fullnames of their submissions.
Values of this object are promises which resolve to fullnames, rather than
bare strings - we keep the promises around after they're resolved, and always
deal with this cache asynchronously.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line219">line 219</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>In-page cache of comment fullnames to the fullnames of their submissions.
Values of this object are promises which resolve to fullnames, rather than
bare strings - we keep the promises around after they're resolved, and always
deal with this cache asynchronously.</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Record.&lt;string, Promise.&lt;string>></span>


        </li>
    </ul>


<h4 class="name" id="toolboxVersion"><span class="type-signature type-signature-constant">(constant) </span>toolboxVersion<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Concise version string which includes all possibly relevant information.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line62">line 62</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>Concise version string which includes all possibly relevant information.</p>
</div>


    <h5 class="h5-examples">Examples</h5>
    
    <pre class="prettyprint"><code>'6.1.13.0 stable 5546015'</code></pre>

    <pre class="prettyprint"><code>'7.0.0.2 beta 893745b'</code></pre>


<h4 class="name" id="toolboxVersionName"><span class="type-signature type-signature-constant">(constant) </span>toolboxVersionName<span class="type-signature"></span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>User-friendly version string; stable releases exclude build and commit</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line68">line 68</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>User-friendly version string; stable releases exclude build and commit</p>
</div>


    <h5 class="h5-examples">Examples</h5>
    
    <pre class="prettyprint"><code>'6.1.13 "Delaying Donkey"'</code></pre>

    <pre class="prettyprint"><code>'7.0.0 "Rewriting Rattlesnake" (build 2 from 893745b)'</code></pre>


<h4 class="name" id="typeNames"><span class="type-signature type-signature-constant">(constant) </span>typeNames<span class="type-signature"> :object</span></h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>An object mapping modnote types to human-friendly display names.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line36">line 36</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    <p>An object mapping modnote types to human-friendly display names.</p>
</div>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


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

        
    <h4 class="name" id="ModNotesBadge"><span class="type-signature"></span>ModNotesBadge<span class="signature">(data)</span><span class="type-signature"> &rarr; {jQuery}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a mod note badge for the given information.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line284">line 284</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>data</code></td>
            

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


            </td>

            
            <td class="description last"><p>Data associated with the badge</p>
                <h6>Properties</h6>
                

<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>user</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Name of the relevant user</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>subreddit</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Name of the relevant subreddit</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>label</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Text shown in the badge if there are no notes</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>note</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>The most recent mod note left on the user</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>The created badge</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">jQuery</span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Returns a pager for mod notes on the user in the subreddit matching the filter.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line314">line 314</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="ModNotesPopup"><span class="type-signature"></span>ModNotesPopup<span class="signature">(data)</span><span class="type-signature"> &rarr; {jQuery}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a mod note popup for the given information.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line376">line 376</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>data</code></td>
            

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


            </td>

            
            <td class="description last"><p>Data associated with the popup</p>
                <h6>Properties</h6>
                

<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>user</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Name of the relevant user</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>subreddit</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Name of the relevant subreddit</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>contextID</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>Fullname of the item the popup was opened from, used to write note context</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>onClose</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Close handler for the popup</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>The created popup</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">jQuery</span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>A row of the notes table displaying details about the given note.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line482">line 482</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>props.note</code></td>
            

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


            </td>

            
            <td class="description last"><p>A note object</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="addModSubsToSidebar"><span class="type-signature"></span>addModSubsToSidebar<span class="signature">(user, $sidebar)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Adds the user's moderated subs to the given sidebar element.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_profile.js.html">modules/profile.js</a>, <a href="modules_profile.js.html#line248">line 248</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>user</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit username</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>$sidebar</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>jquery sidebar element to which the subreddits need to be added</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="addToSiteTable"><span class="type-signature"></span>addToSiteTable<span class="signature">(data, $siteTable, after, callback)</span><span class="type-signature"> &rarr; {callback}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Adds items to the toolbox profile overlay siteTable element</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_profile.js.html">modules/profile.js</a>, <a href="modules_profile.js.html#line132">line 132</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            </td>

            
            <td class="description last"><p>array of reddit things to be added in reddit API format</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>$siteTable</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>jquery object representing the siteTable</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>after</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit thing ID representing the start of the next page. If present will add a &quot;load more&quot; at the end of the siteTable</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">callback</span>


            </td>

            
            <td class="description last"><p>callback function</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>returned when done</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">callback</span>


    </dd>
</dl>

    
    <h4 class="name" id="addTrophiesToSidebar"><span class="type-signature"></span>addTrophiesToSidebar<span class="signature">(user, $sidebar)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Adds the user's trophies to the given sidebar element.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_profile.js.html">modules/profile.js</a>, <a href="modules_profile.js.html#line200">line 200</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>user</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit username</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>$sidebar</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>jquery sidebar element to which the trophies need to be added</p></td>
        </tr>

    
    </tbody>
</table>


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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Opens the toolbox &quot;nag&quot; alert everyone loves so much. USE SPARINGLY.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line506">line 506</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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"><p>The options for the alert</p>
                <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>message</code></td>
            

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


            </td>

            
            <td class="description last"><p>The text of the alert</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>noteID</code></td>
            

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


            </td>

            
            <td class="description last"><p>The ID of the note we're displaying</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>showClose</code></td>
            

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


            </td>

            
            <td class="description last"><p>Whether to show a close button</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Resolves when the alert is closed. Value
will be <code>true</code> if the alert was clicked, <code>false</code> if the close button
was clicked or if it was closed for another reason.</p>
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="checkForActions"><span class="type-signature"></span>checkForActions<span class="signature">(subreddit, fullName)</span><span class="type-signature"> &rarr; {false|object}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Checks modLogCache for actions on the given fullName and subreddit.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queuetools.js.html">modules/queuetools.js</a>, <a href="modules_queuetools.js.html#line1342">line 1342</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>The subreddit the fullName thing belongs to.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fullName</code></td>
            

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


            </td>

            
            <td class="description last"><p>Thing (post/comment) fullName</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Either false or an object with actions</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">false</span>
|

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


    </dd>
</dl>

    
    <h4 class="name" id="cleanSubredditName"><span class="type-signature"></span>cleanSubredditName<span class="signature">(dirtySub)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Because there are a ton of ways how subreddits are written down and sometimes we just want the name.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line679">line 679</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>dirtySub</code></td>
            

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


            </td>

            
            <td class="description last"><p>dirty dirty sub.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>shiny sub!</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Clears all cache keys.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line163">line 163</a>
    </li></ul></dd>
    

</dl>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;void></span>


    </dd>
</dl>

    
    <h4 class="name" id="colorNameToHex"><span class="type-signature"></span>colorNameToHex<span class="signature">(color)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will compare the input color to a list of known color names and return the HEX value</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line496">line 496</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>color</code></td>
            

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


            </td>

            
            <td class="description last"><p>input color</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>if a match is found the HEX color, otherwise the input string.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="contextTrigger"><span class="type-signature"></span>contextTrigger<span class="signature">(triggerId, options)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Add or remove a menu element to the context aware menu. Makes the menu
shows if it was empty before adding, hides menu if it is empty after removing.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line716">line 716</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>triggerId</code></td>
            

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


            </td>

            
            <td class="description last"><p>This will be part of the id given to the element.</p></td>
        </tr>

    
        <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>addTrigger</code></td>
            

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


            </td>

            
            <td class="description last"><p>Indicates of the menu item needs to
be added or removed.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>triggerText</code></td>
            

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


            </td>

            
            <td class="description last"><p>Text displayed in menu. Not needed
when addTrigger is false.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>triggerIcon</code></td>
            

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


            </td>

            
            <td class="description last"><p>The material icon that needs to be
displayed before the menu item. Defaults to 'label'</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>title</code></td>
            

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


            </td>

            
            <td class="description last"><p>Title to be used in title attribute. If no
title is given the triggerText will be used.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>dataAttributes</code></td>
            

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


            </td>

            
            <td class="description last"><p>Any data attribute that might be
needed. Object keys will be used as the attribute name and value as value.</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="createDeferredProcessQueue"><span class="type-signature"></span>createDeferredProcessQueue<span class="signature">(bulkProcess, delayTime<span class="signature-attributes">opt</span>, queueLimit<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a processing queue that allows items to be added one at a time, and
defers processing of those items until a specified delay between item
additions happens, or a maximum length is reached. Returns an insert function
to add items to the queue. Additionally, each invocation of the insert
function returns a promise that can be awaited on to receive the processed
result of the specific item added.</p>
<p>Creating the queue requires giving it a processing function, which must take
an input array of items, and return a promise that resolves to an array of
corresponding results.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line53">line 53</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>bulkProcess</code></td>
            

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

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

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

    
        <tr>
            
                <td class="name"><code>delayTime</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>100</code>
                
                </td>
            

            <td class="description last"><p>This many milliseconds must pass without an
item being queued before the queue is flushed</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>queueLimit</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>Infinity</code>
                
                </td>
            

            <td class="description last"><p>When the queue reaches this size, it is
flushed immediately without waiting for the <code>delayTime</code> to elapse</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
    <h4 class="name" id="daysToMilliseconds"><span class="type-signature"></span>daysToMilliseconds<span class="signature">(days)</span><span class="type-signature"> &rarr; {integer}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Convert days to milliseconds</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line208">line 208</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>days</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Milliseconds</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">integer</span>


    </dd>
</dl>

    
    <h4 class="name" id="debounce"><span class="type-signature"></span>debounce<span class="signature">(func, debounceTime)</span><span class="type-signature"> &rarr; {function}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Debounces a given function based on a given timeout.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line19">line 19</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>func</code></td>
            

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


            </td>

            
            <td class="description last"><p>input function</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>debounceTime</code></td>
            

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


            </td>

            
            <td class="description last"><p>the amount of time used to wait in ms.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>the executed function</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">function</span>


    </dd>
</dl>

    
    <h4 class="name" id="debugInformation"><span class="type-signature"></span>debugInformation<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#DebugObject">DebugObject</a>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Puts important debug information in a object so we can easily include
it in /r/toolbox posts and comments when people need support.</p></li></ul></dd>
    

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

</dl>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Object with debug information</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#DebugObject">DebugObject</a></span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Fetch and display all news notes.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line633">line 633</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="escapeHTML"><span class="type-signature"></span>escapeHTML<span class="signature">(html)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Escape html entities</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line133">line 133</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>html</code></td>
            

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


            </td>

            
            <td class="description last"><p>input html</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>HTML string with escaped entities</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="fetchModSubs"><span class="type-signature type-signature-async">(async) </span>fetchModSubs<span class="signature">(after<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;object>>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Gets a list of all subreddits the current user moderates from the API.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line1307">line 1307</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>after</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>Pagination parameter used for recursion</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;Array.&lt;object>></span>


    </dd>
</dl>

    
    <h4 class="name" id="fetchNewsNotes"><span class="type-signature type-signature-async">(async) </span>fetchNewsNotes<span class="signature">(sub)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;object>>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Fetches notes for the given subreddit (from /r/sub/w/tbnotes).</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line623">line 623</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>sub</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the subreddit to fetch notes from</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;Array.&lt;object>></span>


    </dd>
</dl>

    
    <h4 class="name" id="figureOutMulti"><span class="type-signature"></span>figureOutMulti<span class="signature">($tbQueueUrl, type)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Figures out what listing path to use and adds the multireddit representation to the input field on the respective tab.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queue_overlay.js.html">modules/queue_overlay.js</a>, <a href="modules_queue_overlay.js.html#line71">line 71</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>$tbQueueUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>input element which will hold the multireddit representation</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>the listing type</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>the listing path to be used in overlays</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="filterModdable"><span class="type-signature"></span>filterModdable<span class="signature">(hide)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will hide or reveal items in the profile overlay that can't be modded.</p></li></ul></dd>
    

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

</dl>


    <h5 class="h5-parameters">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>hide</code></td>
            

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


            </td>

            
            <td class="description last"><p>determines if items should be shown or hidden.</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="getActions"><span class="type-signature"></span>getActions<span class="signature">(subreddit, fullName, callback)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Checks for mod actions on the given fullName thing and subreddit through a caching mechanism.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queuetools.js.html">modules/queuetools.js</a>, <a href="modules_queuetools.js.html#line1365">line 1365</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>the subreddit for which the modlog needs to be fetched</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fullName</code></td>
            

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


            </td>

            
            <td class="description last"><p>thing (post/comment) fullName</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="global.html#getActionsCallback">getActionsCallback</a></span>


            </td>

            
            <td class="description last"><p>callback that handles further modlog interactions</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="getAllModNotes"><span class="type-signature type-signature-async, generator">(async, generator) </span>getAllModNotes<span class="signature">(subreddit, user, filter)</span><span class="type-signature"> &rarr; {AsyncGenerator.&lt;any, void>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a generator which lazily fetches all mod notes for a user in a
subreddit that match the given filter.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line185">line 185</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the subreddit</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>user</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the user</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>filter</code></td>
            

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


            </td>

            
            <td class="description last"><p>Criteria for filtering notes</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">AsyncGenerator.&lt;any, void></span>


    </dd>
</dl>

    
    <h4 class="name" id="getCache"><span class="type-signature"></span>getCache<span class="signature">(module, setting, defaultVal<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Gets a value in the cache.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line468">line 468</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>module</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>The module that owns the cache key</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>setting</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>The name of the cache key</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>defaultVal</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>The value returned if there is no cached value</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

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


    </dd>
</dl>

    
    <h4 class="name" id="getContextURL"><span class="type-signature type-signature-async">(async) </span>getContextURL<span class="signature">(note)</span><span class="type-signature"> &rarr; {Promise.&lt;(string|null)>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Gets a link to the context item of a note.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line249">line 249</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>note</code></td>
            

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


            </td>

            
            <td class="description last"><p>A mod note object</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Resolves to a URL that points to the note's
context item, or <code>null</code> if there is none</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;(string|null)></span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Gets the version of Toolbox that was used last time the Toolbox content
script was started. Used to tell if the extension was just updated.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line246">line 246</a>
    </li></ul></dd>
    

</dl>


<h5 class="h5-returns">Returns:</h5>

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


    </dd>
</dl>

    
    <h4 class="name" id="getLatestModNote"><span class="type-signature"></span>getLatestModNote<span class="signature">(subreddit, user)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Fetches the most recent mod note on the given user in the given subreddit.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line111">line 111</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the subreddit</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>user</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the user</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Resolves to a note object or <code>null</code>, or rejects an error</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="getModSubs"><span class="type-signature"></span>getModSubs<span class="signature">(data)</span><span class="type-signature"> &rarr; {Promise.&lt;array>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Returns a Promise that returns the subreddits a user mods as
an array with just the names or array with details per subreddit.
First tries to read their values from cache, and falls back to
fetching the list of moderated subs from the API.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line164">line 164</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>data</code></td>
            

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


            </td>

            
            <td class="description last"><p>If true will return detailed subreddit data.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>array with subreddit names or subreddit objects with details.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;array></span>


    </dd>
</dl>

    
    <h4 class="name" id="getModlog"><span class="type-signature"></span>getModlog<span class="signature">(subreddit, callback)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Fetches the modlog for a subreddit and updates modlogCache.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queuetools.js.html">modules/queuetools.js</a>, <a href="modules_queuetools.js.html#line1316">line 1316</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>the subreddit for which the modlog needs to be fetched</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="global.html#getModlogCallback">getModlogCallback</a></span>


            </td>

            
            <td class="description last"><p>callback that handles further modlog interactions</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="getRandomNumber"><span class="type-signature"></span>getRandomNumber<span class="signature">(maxInt)</span><span class="type-signature"> &rarr; {integer}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Give a random number</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line180">line 180</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>maxInt</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

            
            <td class="description last"><p>Max integer</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>random number</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">integer</span>


    </dd>
</dl>

    
    <h4 class="name" id="getSetting"><span class="type-signature"></span>getSetting<span class="signature">(module, setting, defaultVal)</span><span class="type-signature"> &rarr; {any}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Returns the value of a setting.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line371">line 371</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use `getSettingAsync` instead</li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>module</code></td>
            

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


            </td>

            
            <td class="description last"><p>The ID of the module the setting belongs to</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>setting</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the setting</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>defaultVal</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last"><p>The value returned if the setting is not set</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">any</span>


    </dd>
</dl>

    
    <h4 class="name" id="getSettingAsync"><span class="type-signature"></span>getSettingAsync<span class="signature">(module, setting, defaultVal)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Returns the value of a setting.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line405">line 405</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>module</code></td>
            

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


            </td>

            
            <td class="description last"><p>The ID of the module the setting belongs to</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>setting</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the setting</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>defaultVal</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last"><p>The value returned if the setting is not set</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

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


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Gets the fullname of a comment's corresponding submission.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_modnotes.jsx.html">modules/modnotes.jsx</a>, <a href="modules_modnotes.jsx.html#line226">line 226</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>commentFullname</code></td>
            

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


            </td>

            
            <td class="description last"><p>Fullname of a comment</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Fullname of the comment's submission</p>
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="getSubredditColors"><span class="type-signature type-signature-async">(async) </span>getSubredditColors<span class="signature">(subreddit)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Gets the usernote types to use for the given subreddit.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_usernotes.js.html">modules/usernotes.js</a>, <a href="modules_usernotes.js.html#line1546">line 1546</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>The subreddit to fetch colors for</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Resolves with the usernote types as an object</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="getTime"><span class="type-signature"></span>getTime<span class="signature">()</span><span class="type-signature"> &rarr; {integer}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Give the nummeric value in milliseconds of the current date and time.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line170">line 170</a>
    </li></ul></dd>
    

</dl>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>time value in milliseconds</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">integer</span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Fetches the list of Toolbox developers from the /r/toolbox mod list. May
return a cached list or a static fallback if the API request fails.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line1340">line 1340</a>
    </li></ul></dd>
    

</dl>


<h5 class="h5-returns">Returns:</h5>

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


    </dd>
</dl>

    
    <h4 class="name" id="handleMessage"><span class="type-signature"></span>handleMessage<span class="signature">(request, sender)</span><span class="type-signature"> &rarr; {Promise.&lt;any>|void}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Handles a message</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="background_messageHandling.js.html">background/messageHandling.js</a>, <a href="background_messageHandling.js.html#line15">line 15</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>request</code></td>
            

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


            </td>

            
            <td class="description last"><p>The data sent to the background page</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>sender</code></td>
            

            <td class="type">
            
                
<span class="param-type">runtime.MessageSender</span>


            </td>

            
            <td class="description last"><p>The sender of the message</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;any></span>
|

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


    </dd>
</dl>

    
    <h4 class="name" id="handleTBThings"><span class="type-signature"></span>handleTBThings<span class="signature">(entries, observer)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Handles toolbox generated <code>thing</code> items as they become visible in the viewport.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line822">line 822</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>entries</code></td>
            

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


            </td>

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

    
        <tr>
            
                <td class="name"><code>observer</code></td>
            

            <td class="type">
            
                
<span class="param-type">IntersectionObserver</span>


            </td>

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

    
    </tbody>
</table>


    <h4 class="name" id="handleThing"><span class="type-signature"></span>handleThing<span class="signature">(entries, observer)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Handles <code>thing</code> items as they become visible in the viewport.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_oldreddit.js.html">modules/oldreddit.js</a>, <a href="modules_oldreddit.js.html#line64">line 64</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>entries</code></td>
            

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


            </td>

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

    
        <tr>
            
                <td class="name"><code>observer</code></td>
            

            <td class="type">
            
                
<span class="param-type">IntersectionObserver</span>


            </td>

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

    
    </tbody>
</table>


    <h4 class="name" id="hideModActionsThings"><span class="type-signature"></span>hideModActionsThings<span class="signature">(hide)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will hide or reveal mod actions in the toolbox profile overlay.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_profile.js.html">modules/profile.js</a>, <a href="modules_profile.js.html#line82">line 82</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>hide</code></td>
            

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


            </td>

            
            <td class="description last"><p>determines if actions should be shown or hidden.</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="htmlDecode"><span class="type-signature"></span>htmlDecode<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Gets the text content of an HTML string.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line763">line 763</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>value</code></td>
            

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


            </td>

            
            <td class="description last"><p>The HTML to read</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="htmlEncode"><span class="type-signature"></span>htmlEncode<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Escapes text for HTML.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line752">line 752</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>value</code></td>
            

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


            </td>

            
            <td class="description last"><p>The text to escape</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="humaniseDays"><span class="type-signature"></span>humaniseDays<span class="signature">(days)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Converts a given amount of days in a &quot;humanized version&quot; of weeks, months and years.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line400">line 400</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>days</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>x year x months x weeks x day</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="init"><span class="type-signature type-signature-async">(async) </span>init<span class="signature">()</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Initiate the module</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_historybutton.js.html">modules/historybutton.js</a>, <a href="modules_historybutton.js.html#line120">line 120</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="isConfigValidVersion"><span class="type-signature"></span>isConfigValidVersion<span class="signature">(config, subreddit)</span><span class="type-signature"> &rarr; {booleean}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Checks if a given subreddit config version is valid with this version of toolbox</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line38">line 38</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>config</code></td>
            

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


            </td>

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

    
        <tr>
            
                <td class="name"><code>subreddit</code></td>
            

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


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>valid</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">booleean</span>


    </dd>
</dl>

    
    <h4 class="name" id="isEquivalent"><span class="type-signature"></span>isEquivalent<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {boolean}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Checks whether two objects are deeply equivalent by recursively comparing
their property values. Does not check reference equality.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line519">line 519</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>a</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

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

    
        <tr>
            
                <td class="name"><code>b</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Returns a Promise that returns if the logged in user is a mod of a given subreddit.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line217">line 217</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>Subreddit to check.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

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


    </dd>
</dl>

    
    <h4 class="name" id="link"><span class="type-signature"></span>link<span class="signature">(l)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Takes an absolute path for a link and prepends the www.reddit.com
domain if we're in new modmail (mod.reddit.com). Makes absolute path
links work everywhere.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line270">line 270</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>l</code></td>
            

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


            </td>

            
            <td class="description last"><p>The link path, starting with &quot;/&quot;</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="makeCommentThread"><span class="type-signature"></span>makeCommentThread<span class="signature">(jsonInput, commentOptions)</span><span class="type-signature"> &rarr; {object}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will build a comment given a reddit API comment object.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line1733">line 1733</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>jsonInput</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit API comments object.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>commentOptions</code></td>
            

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


            </td>

            
            <td class="description last"><p>object denoting what needs to included.
Object can contain 'parentLink', 'contextLink' and 'fullCommentsLink' as
boolean.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>jquery object with the build comment thread.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates the queue overlay or adds data to it if it is already open.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queue_overlay.js.html">modules/queue_overlay.js</a>, <a href="modules_queue_overlay.js.html#line115">line 115</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>type</code></td>
            

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


            </td>

            
            <td class="description last"><p>listing type</p></td>
        </tr>

    
        <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>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>optional, when not given the user's toolbox settings for the listing will be used.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>overwrite</code></td>
            

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


            </td>

            
            <td class="description last"><p>when true will set the base over the overlay to the given subreddit and will reload the tab with this data.</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="makeSingleComment"><span class="type-signature"></span>makeSingleComment<span class="signature">(comment, commentOptions)</span><span class="type-signature"> &rarr; {object}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will build a comment given a reddit API comment object.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line1319">line 1319</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>comment</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit API comment object.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>commentOptions</code></td>
            

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


            </td>

            
            <td class="description last"><p>object denoting what needs to be included.
Object can contain 'parentLink', 'contextLink' and 'fullCommentsLink' as boolean.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>jquery object with the build comment.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    
    <h4 class="name" id="makeSubmissionEntry"><span class="type-signature"></span>makeSubmissionEntry<span class="signature">(submission, submissionOptions)</span><span class="type-signature"> &rarr; {object}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will build a submission entry given a reddit API submission object.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line968">line 968</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>submission</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit API submission object.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>submissionOptions</code></td>
            

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


            </td>

            
            <td class="description last"><p>object denoting what needs to be included.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>jquery object with the build submission.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    
    <h4 class="name" id="makeUserSidebar"><span class="type-signature"></span>makeUserSidebar<span class="signature">(user, $overlay)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a user sidebar element for the given overlay</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_profile.js.html">modules/profile.js</a>, <a href="modules_profile.js.html#line330">line 330</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>user</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit username</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>$overlay</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>jquery overlay element to which the sidebar needs to be added</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="millisecondsToDays"><span class="type-signature"></span>millisecondsToDays<span class="signature">(milliseconds)</span><span class="type-signature"> &rarr; {integer}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Convert milliseconds to days</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line218">line 218</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>milliseconds</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Days</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">integer</span>


    </dd>
</dl>

    
    <h4 class="name" id="minutesToMilliseconds"><span class="type-signature"></span>minutesToMilliseconds<span class="signature">(mins)</span><span class="type-signature"> &rarr; {integer}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Convert minutes to milliseconds</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line190">line 190</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>mins</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Milliseconds</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">integer</span>


    </dd>
</dl>

    
    <h4 class="name" id="moveArrayItem"><span class="type-signature"></span>moveArrayItem<span class="signature">(array, old_index, new_index)</span><span class="type-signature"> &rarr; {array}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Moves an item in an array from one index to another
https://github.com/brownieboy/array.prototype.move/blob/master/src/array-prototype-move.js</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line107">line 107</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>array</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            </td>

            
            <td class="description last"><p>input array</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>old_index</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

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

    
        <tr>
            
                <td class="name"><code>new_index</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>New array with moved items</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">array</span>


    </dd>
</dl>

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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Makes sure to fire a jsAPI <code>TBuserHovercard</code> event for new modmail sidebar instances.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_oldreddit.js.html">modules/oldreddit.js</a>, <a href="modules_oldreddit.js.html#line242">line 242</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="niceDateDiff"><span class="type-signature"></span>niceDateDiff<span class="signature">(origdate, newdate)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Returns the difference between days in nice format like &quot;1 year&quot;</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line229">line 229</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>origdate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Date</span>


            </td>

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

    
        <tr>
            
                <td class="name"><code>newdate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Date</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Formatted date difference</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="notification"><span class="type-signature"></span>notification<span class="signature">(title, body, path, markreadid<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Shows a notification, uses native browser notifications if the user
allows it or falls back on html notifications.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line547">line 547</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>title</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Notification title</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>body</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Body text</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>path</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Absolute path to be opend when clicking the
notification</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>markreadid</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last"><p>The ID of a conversation to mark as read
when the notification is clicked</p></td>
        </tr>

    
    </tbody>
</table>


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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Generates an overlay containing a single large window.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line303">line 303</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>title</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The title of the window</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>tabs</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>An array of tab objects</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>buttons</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"><p>Additional buttons to add to the window's
header as an HTML string</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>footer</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"><p>If provided, a single footer to use for all
tabs rather than relying on the footer data from each provided tab object</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>details</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>An object of metadata attached to the
overlay, where each key:val of the object is mapped to a <code>data-key=&quot;val&quot;</code>
attribute</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>tabOrientation</code></td>
            

            <td class="type">
            
                
<span class="param-type">'vertical'</span>
|

<span class="param-type">'horizontal'</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>'vertical'</code>
                
                </td>
            

            <td class="description last"><p>Orientation of the tab bar</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="pager"><span class="type-signature"></span>pager<span class="signature">(options, contentFunction)</span><span class="type-signature"> &rarr; {jQuery}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a jQuery element that dynamically displays paginated content.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line1991">line 1991</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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"><p>Options for the pager</p>
                <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>pageCount</code></td>
            

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


            </td>

            
            <td class="description last"><p>The number of pages to present</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>controlPosition</code></td>
            

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


            </td>

            
            <td class="description last"><p>Where to display the pager's
controls, either 'top' or 'bottom'</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
        <tr>
            
                <td class="name"><code>contentFunction</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="TBui.html#~pagerCallback">TBui~pagerCallback</a></span>


            </td>

            
            <td class="description last"><p>A function which generates
content for a given page</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">jQuery</span>


    </dd>
</dl>

    
    <h4 class="name" id="pagerForItems"><span class="type-signature"></span>pagerForItems<span class="signature">(options, items, perPage, displayItem, controlPosition, wrapper<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {jQuery}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a pager over a dataset.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line2023">line 2023</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>options</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

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

    
        <tr>
            
                <td class="name"><code>items</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The items to display in the pager</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>perPage</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The number of items to display on each page</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>displayItem</code></td>
            

            <td class="type">
            
                
<span class="param-type">TBui~pagerForItemsCallback</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>A function that generates
content for each individual item in the dataset</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>controlPosition</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>Where to display the pager's controls,
either 'top' or 'bottom'</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>wrapper</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>'&lt;div>'</code>
                
                </td>
            

            <td class="description last"><p>Used to provide custom wrapper markup for
each page of items</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">jQuery</span>


    </dd>
</dl>

    
    <h4 class="name" id="parseComments"><span class="type-signature"></span>parseComments<span class="signature">(object, postID, subreddit)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will given a reddit API comment object go through the chain and put all comments</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_nukecomments.js.html">modules/nukecomments.js</a>, <a href="modules_nukecomments.js.html#line219">line 219</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>object</code></td>
            

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


            </td>

            
            <td class="description last"><p>Comment chain object</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>postID</code></td>
            

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


            </td>

            
            <td class="description last"><p>Post id the comments belong to</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>subreddit</code></td>
            

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


            </td>

            
            <td class="description last"><p>Subreddit the comment chain belongs to.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="popup"><span class="type-signature"></span>popup<span class="signature">(options)</span><span class="type-signature"> &rarr; {jQuery}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Generate a popup.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line127">line 127</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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"><p>Options for the popup</p>
                <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>title</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The popup's title (raw HTML)</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>tabs</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The tabs for the popup</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>footer</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"><p>The popup footer (used for all tabs; if
provided, tab footers are ignored)</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>cssClass</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"><p>Extra CSS class to add to the popup</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>meta</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"><p>Raw HTML to add to a &quot;meta&quot; container</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>draggable</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>true</code>
                
                </td>
            

            <td class="description last"><p>Whether the user can move the
popup</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>defaultTabID</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"><p>If provided, the tab with this ID
will be displayed initially; otherwise, the first tab will be shown</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">jQuery</span>


    </dd>
</dl>

    
    <h4 class="name" id="progressivePager"><span class="type-signature"></span>progressivePager<span class="signature">(options)</span><span class="type-signature"> &rarr; {JQuery}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a jQuery element that displays paginated content provided by a
generator or other iterable, possibly asynchronous. Lazy loading is
supported.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line1780">line 1780</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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"><p>Options for the pager</p>
                <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>lazy</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>true</code>
                
                </td>
            

            <td class="description last"><p>If <code>false</code>, the page iterable will be
iterated to completion immediately, and controls for all pages will be
visible from the start. If <code>true</code>, the pager will display a &quot;next page&quot;
button which loads new pages from the iterable one at a time until it is
exhausted.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>preloadNext</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>true</code>
                
                </td>
            

            <td class="description last"><p>If <code>true</code>, the iterable will be
iterated one page ahead in order to determine whether the current page is the
last one without additional interaction</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>controlPosition</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>Where to display the pager's
controls, either 'top' or 'bottom'</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>emptyContent</code></td>
            

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

<span class="param-type">JQuery</span>
|

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>Content to display if there are
no pages to show</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

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

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

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">JQuery</span>


    </dd>
</dl>

    
    <h4 class="name" id="purify"><span class="type-signature"></span>purify<span class="signature">(input)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Uses DOMPurify to sanitize untrusted HTML strings.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line218">line 218</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>input</code></td>
            

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


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="purifyObject"><span class="type-signature"></span>purifyObject<span class="signature">(input)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Recursively sanitize an object's string values as untrusted HTML. String
values that can be interpreted as JSON objects are parsed, sanitized, and
re-stringified.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line242">line 242</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>input</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

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

    
    </tbody>
</table>


    <h4 class="name" id="regExpEscape"><span class="type-signature"></span>regExpEscape<span class="signature">(query)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Escapes a string so it is suitable to be inserted in to a regex match</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_profile.js.html">modules/profile.js</a>, <a href="modules_profile.js.html#line504">line 504</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>query</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit username</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>string escaped for regex use</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="relativeTime"><span class="type-signature"></span>relativeTime<span class="signature">(date)</span><span class="type-signature"> &rarr; {jQuery}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Creates a <code>&lt;time&gt;</code> element which displays the given date as a relative time
via <code>$.timeago()</code>.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line2050">line 2050</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>date</code></td>
            

            <td class="type">
            
                
<span class="param-type">Date</span>


            </td>

            
            <td class="description last"><p>Date and time to display</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">jQuery</span>


    </dd>
</dl>

    
    <h4 class="name" id="reloadIframe"><span class="type-signature"></span>reloadIframe<span class="signature">($reloadListing, $tbQueueUrl, $iframe, type)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Reload the iframe belonging to a queue listing based on latest data.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queue_overlay.js.html">modules/queue_overlay.js</a>, <a href="modules_queue_overlay.js.html#line94">line 94</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>$reloadListing</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>reload button on the listing tab.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>$tbQueueUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>input element which will hold the multireddit representation</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>$iframe</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>iframe element to be reloaded</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>listing type</p></td>
        </tr>

    
    </tbody>
</table>


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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Reloads the extension, then reloads the current window.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line2219">line 2219</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(array, item)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Remove an item from an Array.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tblistener.js.html">tblistener.js</a>, <a href="tblistener.js.html#line48">line 48</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>array</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>

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

    
        <tr>
            
                <td class="name"><code>item</code></td>
            

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


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="removeLastDirectoryPartOf"><span class="type-signature"></span>removeLastDirectoryPartOf<span class="signature">(url)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Strips the last directory part of an url. Example:  /this/is/url/with/part/ becomes /this/is/url/with/</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line665">line 665</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>url</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit API comment object.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>url without the last directory part</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="replaceAll"><span class="type-signature"></span>replaceAll<span class="signature">(find, replace, str)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Replace all instances of a certaing thing for another thing.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line488">line 488</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>find</code></td>
            

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


            </td>

            
            <td class="description last"><p>what to find</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>replace</code></td>
            

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


            </td>

            
            <td class="description last"><p>what to replace</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>str</code></td>
            

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


            </td>

            
            <td class="description last"><p>where to do it all with</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>shiny new string with replaced stuff</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="replaceTokens"><span class="type-signature"></span>replaceTokens<span class="signature">(info, content)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Replaces {tokens} for the respective value in given content</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line690">line 690</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>info</code></td>
            

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


            </td>

            
            <td class="description last"><p>object with token name keys and token content values.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>content</code></td>
            

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


            </td>

            
            <td class="description last"><p>dirty dirty sub.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>token replaced text!</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="saneSort"><span class="type-signature"></span>saneSort<span class="signature">(arr)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Because normal .sort() is case sensitive.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line443">line 443</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>arr</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            </td>

            
            <td class="description last"><p>input array</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="saneSortAs"><span class="type-signature"></span>saneSortAs<span class="signature">(arr)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Because normal .sort() is case sensitive and we also want to sort ascending from time to time.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line460">line 460</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>arr</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            </td>

            
            <td class="description last"><p>input array</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="saveSettingsToBrowser"><span class="type-signature type-signature-async">(async) </span>saveSettingsToBrowser<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Commits the current settings to extension storage.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line357">line 357</a>
    </li></ul></dd>
    

</dl>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;void></span>


    </dd>
</dl>

    
    <h4 class="name" id="searchProfile"><span class="type-signature"></span>searchProfile<span class="signature">(user, type, sortMethod, $siteTable, options, after, match, pageCount, callback)</span><span class="type-signature"> &rarr; {callback}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Searches a user profile for the given subreddit and/or string</p></li></ul></dd>
    

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

</dl>


    <h5 class="h5-parameters">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>user</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit username</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>the listing type that is to be searched</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>sortMethod</code></td>
            

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


            </td>

            
            <td class="description last"><p>the listing type that is to be searched</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>$siteTable</code></td>
            

            <td class="type">
            
                
<span class="param-type">jqueryObject</span>


            </td>

            
            <td class="description last"><p>jquery siteTable element to which the search results need to be added</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>search options</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>after</code></td>
            

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


            </td>

            
            <td class="description last"><p>reddit thing id indicating the next page</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>match</code></td>
            

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


            </td>

            
            <td class="description last"><p>indicates if there are previous</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pageCount</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

            
            <td class="description last"><p>what page we are on</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">callback</span>


            </td>

            
            <td class="description last"><p>callback function</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>returns true when results have been found, false when none are found</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">callback</span>


    </dd>
</dl>

    
    <h4 class="name" id="setCache"><span class="type-signature"></span>setCache<span class="signature">(module, setting, inputValue)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Sets a value in the cache.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line495">line 495</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>module</code></td>
            

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


            </td>

            
            <td class="description last"><p>The ID of the module that owns the cache key</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>setting</code></td>
            

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


            </td>

            
            <td class="description last"><p>The name of the cache key</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>inputValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last"><p>The new value of the cache key</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Promises the new value of the cache key</p>
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="setSetting"><span class="type-signature"></span>setSetting<span class="signature">(module, setting, value, syncSettings<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {any}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Sets a setting to a new value.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line420">line 420</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use `setSettingAsync` instead</li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>module</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The ID of the module the setting belongs to</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>setting</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The name of the setting</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The new value of the setting</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>syncSettings</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>true</code>
                
                </td>
            

            <td class="description last"><p>If false, settings will not be committed
to storage after performing this action</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>The new value of the setting</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">any</span>


    </dd>
</dl>

    
    <h4 class="name" id="setSettingAsync"><span class="type-signature"></span>setSettingAsync<span class="signature">(module, setting, value, syncSettings<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Sets a setting to a new value.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line456">line 456</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>module</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The ID of the module the setting belongs to</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>setting</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The name of the setting</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The new value of the setting</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>syncSettings</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>true</code>
                
                </td>
            

            <td class="description last"><p>If false, settings will not be committed
to storage after performing this action</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>The new value of the setting</p>
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="settingsToObject"><span class="type-signature"></span>settingsToObject<span class="signature">(callback)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Calls back with a copy of the current settings object, containing all setting
keys and their values.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line333">line 333</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>callback</code></td>
            

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

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

    
    </tbody>
</table>


    <h4 class="name" id="showNote"><span class="type-signature"></span>showNote<span class="signature">(note)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Displays an alert for the given note if its platform information matches and
the note hasn't been seen yet.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line580">line 580</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>note</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 class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>id</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>The ID of the note, used to tell if it's been seen</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>text</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>The text to display in the alert</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>link</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>A URI to open when the user clicks the alert</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>platform</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>If present, the note will only be shown on the given platform</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="sortBy"><span class="type-signature"></span>sortBy<span class="signature">(arr, prop)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Sorts an array of objects by property value of specific properties.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line426">line 426</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>arr</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            </td>

            
            <td class="description last"><p>input array</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>prop</code></td>
            

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


            </td>

            
            <td class="description last"><p>property name</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="stringToColor"><span class="type-signature"></span>stringToColor<span class="signature">(str)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Generates a color corresponding to a given string (used to assign colors
to subreddits for post borders in shared queues)</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line730">line 730</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>str</code></td>
            

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


            </td>

            
            <td class="description last"><p>The string to generate a color for</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="tbRedditEvent"><span class="type-signature"></span>tbRedditEvent<span class="signature">($elements)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Will send out events similar to the reddit jsAPI events for the elements given.
Only support 'comment' for now and will only send the commentAuthor event.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line953">line 953</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>$elements</code></td>
            

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


            </td>

            
            <td class="description last"><p>jquery object containing the elements for which jsAPI events need to be send.</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="textFeedback"><span class="type-signature"></span>textFeedback<span class="signature">(feedbackText, feedbackKind, displayDuration<span class="signature-attributes">opt</span>, displayLocation<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Displays a feedback message on the screen which disappears after a time. Only
one such message can be shown at a time, and calling this method will
overwrite any message currently being shown.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbui.js.html">tbui.js</a>, <a href="tbui.js.html#line583">line 583</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>feedbackText</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Message to display</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>feedbackKind</code></td>
            

            <td class="type">
            
                
<span class="param-type">TextFeedbackKind</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>Nature of the message (positive,
neutral, negative) to affect the color of the message window</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>displayDuration</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>How long the message should be displayed
before being hidden, in milliseconds. Defaults to 3000. Pass <code>Infinity</code> to
force the message to never disappear unless dismissed with a</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>displayLocation</code></td>
            

            <td class="type">
            
                
<span class="param-type">TextFeedbackLocation</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>The location on the screen
where the message should be shown - center screen is the default, but
long-lived messages can be moved to the bottom instead</p></td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="timeConverterRead"><span class="type-signature"></span>timeConverterRead<span class="signature">(UNIX_timestamp)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>convert unix epoch timestamps to readable format dd-mm-yyyy hh:mm:ss UTC</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line349">line 349</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>UNIX_timestamp</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Formatted date in dd-mm-yyyy hh:mm:ss UTC</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="title_to_url"><span class="type-signature"></span>title_to_url<span class="signature">(title)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>convert titles to a format usable in urls
from r2.lib.utils import title_to_url</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line367">line 367</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>title</code></td>
            

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


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>Formatted title</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="unescapeHTML"><span class="type-signature"></span>unescapeHTML<span class="signature">(html)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Unescape html entities</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line152">line 152</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>html</code></td>
            

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


            </td>

            
            <td class="description last"><p>input html</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>HTML string with unescaped entities</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="unescapeJSON"><span class="type-signature"></span>unescapeJSON<span class="signature">(info, content)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>reddit HTML encodes all of their JSON responses, we need to HTMLdecode them before parsing.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line706">line 706</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>info</code></td>
            

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


            </td>

            
            <td class="description last"><p>object with token name keys and token content values.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>content</code></td>
            

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


            </td>

            
            <td class="description last"><p>dirty dirty sub.</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<div class="param-desc">
    <p>token replaced text!</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="verifiedSettingsSave"><span class="type-signature"></span>verifiedSettingsSave<span class="signature">(callback)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Saves current settings, then verifies that they've been saved accurately. If
the save was successful, tells the background page to update the settings
state of other tabs. Calls back with whether or not the save was successful.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbstorage.js.html">tbstorage.js</a>, <a href="tbstorage.js.html#line185">line 185</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>callback</code></td>
            

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

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

    
    </tbody>
</table>


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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Begins emitting TBNewPage and TBHashParam events with metadata whenever the
background page detects that this tab's URL has changed.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line1617">line 1617</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="wrapWithLastValue"><span class="type-signature"></span>wrapWithLastValue<span class="signature">(iterable)</span><span class="type-signature"> &rarr; {AsyncGenerator.&lt;{item: T, last: boolean}, void>}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Wraps each of an iterable's values with an object that indicates which item
is the last one in the sequence by always reading one item ahead in the
iterator to check for <code>{done: true}</code> before yielding the current item.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line808">line 808</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>iterable</code></td>
            

            <td class="type">
            
                
<span class="param-type">MaybeAsyncIterable.&lt;T></span>


            </td>

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

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">AsyncGenerator.&lt;{item: T, last: boolean}, void></span>


    </dd>
</dl>

    
    <h4 class="name" id="zlibDeflate"><span class="type-signature"></span>zlibDeflate<span class="signature">(object)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Deflates some data into a base64-encoded zlib-compressed data string.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line786">line 786</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>object</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last"><p>The data to compress</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="zlibInflate"><span class="type-signature"></span>zlibInflate<span class="signature">(string)</span><span class="type-signature"> &rarr; {any}</span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Inflates a base64-encoded zlib-compressed data string into data.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbhelpers.js.html">tbhelpers.js</a>, <a href="tbhelpers.js.html#line772">line 772</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>string</code></td>
            

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


            </td>

            
            <td class="description last"><p>The compressed string</p></td>
        </tr>

    
    </tbody>
</table>


<h5 class="h5-returns">Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">any</span>


    </dd>
</dl>

    
        <h3 class="subsection-title">Type Definitions</h3>

        
<h4 class="name" id="DebugObject">DebugObject</h4>


<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbcore.js.html">tbcore.js</a>, <a href="tbcore.js.html#line412">line 412</a>
    </li></ul></dd>
    

</dl>


    <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>toolboxVersion</code></td>
            

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


            </td>

            
            <td class="description last"><p>The toolbox version</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>browser</code></td>
            

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


            </td>

            
            <td class="description last"><p>Browser used (Firefox, Chrome, etc)</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>browserVersion</code></td>
            

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


            </td>

            
            <td class="description last"><p>The version of the browser</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>platformInformation</code></td>
            

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


            </td>

            
            <td class="description last"><p>Other platform information</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>debugMode</code></td>
            

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


            </td>

            
            <td class="description last"><p>toolbox debugMode enabled</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>compactMode</code></td>
            

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


            </td>

            
            <td class="description last"><p>toolbox compactmode enabled</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>advancedSettings</code></td>
            

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


            </td>

            
            <td class="description last"><p>toolbox advanced settings enabled</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>cookiesEnabled</code></td>
            

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


            </td>

            
            <td class="description last"><p>Browser cookies enabled</p></td>
        </tr>

    
    </tbody>
</table>


    <h5 class="h5-types">Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


<h4 class="name" id="SettingDefinition">SettingDefinition</h4>


<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>An object representing a single setting. Additional properties may be used
for settings of different <code>type</code>s.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="tbmodule.jsx.html">tbmodule.jsx</a>, <a href="tbmodule.jsx.html#line1074">line 1074</a>
    </li></ul></dd>
    

</dl>


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

    
<table class="props">
    <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>id</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The setting ID, used to get and set the setting's value</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>description</code></td>
            

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


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>A human-readable description</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>default</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>The default value of the setting, or a function (possibly
async) that returns a default value</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>storageKey</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"><p>The storage key associated with the setting</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>beta</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>false</code>
                
                </td>
            

            <td class="description last"><p>If true, the setting will only show up when beta
mode is enabled</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>debug</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>false</code>
                
                </td>
            

            <td class="description last"><p>If true, the setting will only show up when
debug mode is enabled</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>advanced</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>false</code>
                
                </td>
            

            <td class="description last"><p>If true, the setting will only show up when
advanced mode is enabled</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>hidden</code></td>
            

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>false</code>
                
                </td>
            

            <td class="description last"><p>If true, the setting will not be configurable
or visible to users (can be used for module-specific persistent storage)</p></td>
        </tr>

    
    </tbody>
</table>


<div class="description usertext">
    <p>An object representing a single setting. Additional properties may be used
for settings of different <code>type</code>s.</p>
</div>


    <h4 class="name" id="getActionsCallback"><span class="type-signature"></span>getActionsCallback<span class="signature">(result)</span><span class="type-signature"></span></h4>

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Callback for further handling the modlog.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queuetools.js.html">modules/queuetools.js</a>, <a href="modules_queuetools.js.html#line1358">line 1358</a>
    </li></ul></dd>
    

</dl>


    <h5 class="h5-parameters">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>result</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>
|

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


            </td>

            
            <td class="description last"><p>Either false or an object with actions</p></td>
        </tr>

    
    </tbody>
</table>


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

    
<dl class="details">
    
    <dt class="tag-description">Description:</dt>
    <dd class="tag-description"><ul class="dummy"><li><p>Callback for further handling the modlog.</p></li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="modules_queuetools.js.html">modules/queuetools.js</a>, <a href="modules_queuetools.js.html#line1310">line 1310</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Dec 16 2024 21:12:15 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

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

<script src="scripts/search.js" defer></script>


</body>
</html>