Skip to content

Commit

Permalink
Updates api docs (#175)
Browse files Browse the repository at this point in the history
  • Loading branch information
gpene authored Sep 27, 2023
1 parent 735a71d commit b17e013
Show file tree
Hide file tree
Showing 68 changed files with 644 additions and 577 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

168 changes: 84 additions & 84 deletions docs/classes/nakama_js.Client.html

Large diffs are not rendered by default.

134 changes: 67 additions & 67 deletions docs/classes/nakama_js.DefaultSocket.html

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions docs/classes/nakama_js.Session.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/classes/nakama_js.WebSocketAdapterText.html

Large diffs are not rendered by default.

121 changes: 90 additions & 31 deletions docs/classes/satori_js.Client.html

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions docs/classes/satori_js.Session.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/satori_js.ISession.html" class="tsd-signature-type" data-tsd-kind="Interface">ISession</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L45">satori-js/session.ts:45</a></li></ul></aside>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L45">satori-js/session.ts:45</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -71,7 +71,7 @@ <h5>token: <span class="tsd-signature-type">string</span></h5></li>
<h5>refresh_token: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="satori_js.Session.html" class="tsd-signature-type" data-tsd-kind="Class">Session</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L55">satori-js/session.ts:55</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L55">satori-js/session.ts:55</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="created_at" class="tsd-anchor"></a>
Expand All @@ -81,55 +81,55 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#created_at">created_at</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L48">satori-js/session.ts:48</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L48">satori-js/session.ts:48</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="expires_at" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>expires_<wbr/>at</span><a href="#expires_at" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">expires_<wbr/>at<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The UNIX timestamp when this session will expire.</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#expires_at">expires_at</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L49">satori-js/session.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L49">satori-js/session.ts:49</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="refresh_expires_at" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>refresh_<wbr/>expires_<wbr/>at</span><a href="#refresh_expires_at" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">refresh_<wbr/>expires_<wbr/>at<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The UNIX timestamp when the refresh token will expire.</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#refresh_expires_at">refresh_expires_at</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L50">satori-js/session.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L50">satori-js/session.ts:50</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="refresh_token" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>refresh_<wbr/>token</span><a href="#refresh_token" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">refresh_<wbr/>token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Refresh token that can be used for session token renewal.</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#refresh_token">refresh_token</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L51">satori-js/session.ts:51</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L51">satori-js/session.ts:51</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="token" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>token</span><a href="#token" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The authorization token used to construct this session.</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#token">token</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L47">satori-js/session.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L47">satori-js/session.ts:47</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="user_id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>user_<wbr/>id</span><a href="#user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">user_<wbr/>id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The ID of the user who owns this session.</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#user_id">user_id</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L52">satori-js/session.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L52">satori-js/session.ts:52</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="vars" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>vars</span><a href="#vars" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">vars<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span></div>
<div class="tsd-comment tsd-typography"><p>Any custom properties associated with this session.</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#vars">vars</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L53">satori-js/session.ts:53</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L53">satori-js/session.ts:53</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isexpired" class="tsd-anchor"></a>
Expand All @@ -147,7 +147,7 @@ <h5>currenttime: <span class="tsd-signature-type">number</span></h5></li></ul></
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#isexpired">isexpired</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L64">satori-js/session.ts:64</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L64">satori-js/session.ts:64</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isrefreshexpired" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>isrefreshexpired</span><a href="#isrefreshexpired" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -163,7 +163,7 @@ <h5>currenttime: <span class="tsd-signature-type">number</span></h5></li></ul></
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/satori_js.ISession.html">ISession</a>.<a href="../interfaces/satori_js.ISession.html#isrefreshexpired">isrefreshexpired</a></p>
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L68">satori-js/session.ts:68</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L68">satori-js/session.ts:68</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="update" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -178,7 +178,7 @@ <h5>token: <span class="tsd-signature-type">string</span></h5></li>
<h5>refreshToken: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L72">satori-js/session.ts:72</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L72">satori-js/session.ts:72</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="restore" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>restore</span><a href="#restore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -193,7 +193,7 @@ <h5>token: <span class="tsd-signature-type">string</span></h5></li>
<h5>refreshToken: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="satori_js.Session.html" class="tsd-signature-type" data-tsd-kind="Class">Session</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/54e16ab/packages/satori-js/session.ts#L104">satori-js/session.ts:104</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/heroiclabs/nakama-js/blob/735a71d/packages/satori-js/session.ts#L104">satori-js/session.ts:104</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit b17e013

Please sign in to comment.