Deploying to gh-pages from @ d0c62c9 🚀

Kraigie · Aug 22, 2024 · 3550f0b · 3550f0b
1 parent b72a415
commit 3550f0b
Show file tree

Hide file tree

Showing 40 changed files with 663 additions and 663 deletions.
diff --git a/Nostrum.Api.Ratelimiter.html b/Nostrum.Api.Ratelimiter.html
@@ -164,9 +164,9 @@ <h1>
 <p>The ratelimiter is fully asynchronous internally. In theory, it also supports
 queueing requests in an asynchronous manner. However, support for this is
 currently not implemented in <a href="Nostrum.Api.html"><code class="inline">Nostrum.Api</code></a>.</p><p>If you want to make one or multiple asynchronous requests manually, you can
-use the following pattern:</p><pre><code class="makeup elixir" translate="no"><span class="n">req</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">send_request</span><span class="p" data-group-id="2138635357-1">(</span><span class="nc">Nostrum.Api.Ratelimiter</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2138635357-2">{</span><span class="ss">:queue</span><span class="p">,</span><span class="w"> </span><span class="n">request</span><span class="p" data-group-id="2138635357-2">}</span><span class="p" data-group-id="2138635357-1">)</span><span class="w">
+use the following pattern:</p><pre><code class="makeup elixir" translate="no"><span class="n">req</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">send_request</span><span class="p" data-group-id="7481496280-1">(</span><span class="nc">Nostrum.Api.Ratelimiter</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7481496280-2">{</span><span class="ss">:queue</span><span class="p">,</span><span class="w"> </span><span class="n">request</span><span class="p" data-group-id="7481496280-2">}</span><span class="p" data-group-id="7481496280-1">)</span><span class="w">
 </span><span class="c1"># ...</span><span class="w">
-</span><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">receive_response</span><span class="p" data-group-id="2138635357-3">(</span><span class="n">req</span><span class="p">,</span><span class="w"> </span><span class="n">timeout</span><span class="p" data-group-id="2138635357-3">)</span></code></pre><p>where <code class="inline">request</code> is a map describing the request to run - see <a href="Nostrum.Api.html"><code class="inline">Nostrum.Api</code></a>
+</span><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">receive_response</span><span class="p" data-group-id="7481496280-3">(</span><span class="n">req</span><span class="p">,</span><span class="w"> </span><span class="n">timeout</span><span class="p" data-group-id="7481496280-3">)</span></code></pre><p>where <code class="inline">request</code> is a map describing the request to run - see <a href="Nostrum.Api.html"><code class="inline">Nostrum.Api</code></a>
 for more information. You can also send multiple requests at the same time
 and wait for their response: see <a href="https://www.erlang.org/doc/man/gen_statem.html#reqids_add-3"><code class="inline">:gen_statem.reqids_add/3</code></a> and
 <a href="https://www.erlang.org/doc/man/gen_statem.html#wait_response-3"><code class="inline">:gen_statem.wait_response/3</code></a> for more information.</p><h2 id="module-multi-node" class="section-heading">

diff --git a/Nostrum.Api.html b/Nostrum.Api.html
diff --git a/Nostrum.Cache.ChannelGuildMapping.html b/Nostrum.Cache.ChannelGuildMapping.html
@@ -157,9 +157,9 @@ <h1>
 <p>By default, nostrum will use <a href="Nostrum.Cache.ChannelGuildMapping.ETS.html"><code class="inline">Elixir.Nostrum.Cache.ChannelGuildMapping.ETS</code></a> to store the
 mapping. To override this, set the <code class="inline">[:caches, :channel_guild_mapping]</code>
 setting on nostrum's application configuration:</p><pre><code class="makeup elixir" translate="no"><span class="n">config</span><span class="w"> </span><span class="ss">:nostrum</span><span class="p">,</span><span class="w">
- </span><span class="ss">caches</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3150985195-1">%{</span><span class="w">
+ </span><span class="ss">caches</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="4382246140-1">%{</span><span class="w">
  </span><span class="ss">channel_guild_mapping</span><span class="p">:</span><span class="w"> </span><span class="nc">MyBot.Nostrum.Cache.ChannelGuildMapping</span><span class="w">
- </span><span class="p" data-group-id="3150985195-1">}</span></code></pre><p>This setting must be set at compile time.</p>
+ </span><span class="p" data-group-id="4382246140-1">}</span></code></pre><p>This setting must be set at compile time.</p>
  </section>
 
 </div>

diff --git a/Nostrum.Cache.MessageCache.Mnesia.html b/Nostrum.Cache.MessageCache.Mnesia.html
@@ -154,12 +154,12 @@ <h1>
 that the table cannot be changed to only store its contents on disk later.
 default: <code class="inline">:ordered_set</code></li></ul><p>To change this configuration, you can add the following to your
 <code class="inline">config.exs</code>:</p><pre><code class="makeup elixir" translate="no"><span class="n">config</span><span class="w"> </span><span class="ss">:nostrum</span><span class="p">,</span><span class="w">
- </span><span class="ss">caches</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1023827899-1">%{</span><span class="w">
- </span><span class="ss">messages</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1023827899-2">{</span><span class="nc">Nostrum.Cache.MessageCache.Mnesia</span><span class="p">,</span><span class="w">
+ </span><span class="ss">caches</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5589283225-1">%{</span><span class="w">
+ </span><span class="ss">messages</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5589283225-2">{</span><span class="nc">Nostrum.Cache.MessageCache.Mnesia</span><span class="p">,</span><span class="w">
  </span><span class="ss">size_limit</span><span class="p">:</span><span class="w"> </span><span class="mi">1000</span><span class="p">,</span><span class="w"> </span><span class="ss">eviction_count</span><span class="p">:</span><span class="w"> </span><span class="mi">50</span><span class="p">,</span><span class="w">
  </span><span class="ss">table_name</span><span class="p">:</span><span class="w"> </span><span class="ss">:my_custom_messages_table_name</span><span class="p">,</span><span class="w">
- </span><span class="ss">compressed</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:set</span><span class="p" data-group-id="1023827899-2">}</span><span class="w">
- </span><span class="p" data-group-id="1023827899-1">}</span></code></pre><p>You can also change the table name used by the cache by setting the
+ </span><span class="ss">compressed</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:set</span><span class="p" data-group-id="5589283225-2">}</span><span class="w">
+ </span><span class="p" data-group-id="5589283225-1">}</span></code></pre><p>You can also change the table name used by the cache by setting the
 <code class="inline">table_name</code> field in the configuration for the <code class="inline">messages</code> cache.</p>
  </section>
 

diff --git a/Nostrum.Cache.PresenceCache.html b/Nostrum.Cache.PresenceCache.html
@@ -638,12 +638,12 @@ <h1 class="signature" translate="no">get(guild_id, user_id)</h1>
  </a>
  <span class="text">Example</span>
 </h2>
-<pre><code class="makeup elixir" translate="no"><span class="k">case</span><span class="w"> </span><span class="nc">Nostrum.Cache.PresenceCache</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="7626513855-1">(</span><span class="mi">111133335555</span><span class="p">,</span><span class="w"> </span><span class="mi">222244446666</span><span class="p" data-group-id="7626513855-1">)</span><span class="w"> </span><span class="k" data-group-id="7626513855-2">do</span><span class="w">
- </span><span class="p" data-group-id="7626513855-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">presence</span><span class="p" data-group-id="7626513855-3">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
- </span><span class="s">&quot;They&#39;re </span><span class="si" data-group-id="7626513855-4">#{</span><span class="n">presence</span><span class="o">.</span><span class="n">status</span><span class="si" data-group-id="7626513855-4">}</span><span class="s">&quot;</span><span class="w">
- </span><span class="p" data-group-id="7626513855-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="c">_reason</span><span class="p" data-group-id="7626513855-5">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
+<pre><code class="makeup elixir" translate="no"><span class="k">case</span><span class="w"> </span><span class="nc">Nostrum.Cache.PresenceCache</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="9599069854-1">(</span><span class="mi">111133335555</span><span class="p">,</span><span class="w"> </span><span class="mi">222244446666</span><span class="p" data-group-id="9599069854-1">)</span><span class="w"> </span><span class="k" data-group-id="9599069854-2">do</span><span class="w">
+ </span><span class="p" data-group-id="9599069854-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">presence</span><span class="p" data-group-id="9599069854-3">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
+ </span><span class="s">&quot;They&#39;re </span><span class="si" data-group-id="9599069854-4">#{</span><span class="n">presence</span><span class="o">.</span><span class="n">status</span><span class="si" data-group-id="9599069854-4">}</span><span class="s">&quot;</span><span class="w">
+ </span><span class="p" data-group-id="9599069854-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="c">_reason</span><span class="p" data-group-id="9599069854-5">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
  </span><span class="s">&quot;They&#39;re dead Jim&quot;</span><span class="w">
-</span><span class="k" data-group-id="7626513855-2">end</span></code></pre>
+</span><span class="k" data-group-id="9599069854-2">end</span></code></pre>
  </section>
 </section>
 <section class="detail" id="get!/3">

diff --git a/Nostrum.Cache.UserCache.html b/Nostrum.Cache.UserCache.html
@@ -585,12 +585,12 @@ <h1 class="signature" translate="no">get(id)</h1>
  </a>
  <span class="text">Example</span>
 </h2>
-<pre><code class="makeup elixir" translate="no"><span class="k">case</span><span class="w"> </span><span class="nc">Nostrum.Cache.UserCache</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="8321142388-1">(</span><span class="mi">1111222233334444</span><span class="p" data-group-id="8321142388-1">)</span><span class="w"> </span><span class="k" data-group-id="8321142388-2">do</span><span class="w">
- </span><span class="p" data-group-id="8321142388-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">user</span><span class="p" data-group-id="8321142388-3">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
+<pre><code class="makeup elixir" translate="no"><span class="k">case</span><span class="w"> </span><span class="nc">Nostrum.Cache.UserCache</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="0206830551-1">(</span><span class="mi">1111222233334444</span><span class="p" data-group-id="0206830551-1">)</span><span class="w"> </span><span class="k" data-group-id="0206830551-2">do</span><span class="w">
+ </span><span class="p" data-group-id="0206830551-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">user</span><span class="p" data-group-id="0206830551-3">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
  </span><span class="s">&quot;We found &quot;</span><span class="w"> </span><span class="o">&lt;&gt;</span><span class="w"> </span><span class="n">user</span><span class="o">.</span><span class="n">username</span><span class="w">
- </span><span class="p" data-group-id="8321142388-4">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="c">_reason</span><span class="p" data-group-id="8321142388-4">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
+ </span><span class="p" data-group-id="0206830551-4">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="c">_reason</span><span class="p" data-group-id="0206830551-4">}</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">
  </span><span class="s">&quot;No es bueno&quot;</span><span class="w">
-</span><span class="k" data-group-id="8321142388-2">end</span></code></pre>
+</span><span class="k" data-group-id="0206830551-2">end</span></code></pre>
  </section>
 </section>
 <section class="detail" id="get!/1">