UNPKG

@simbachain/libsimba-js

Version:

libsimba-js is a library simplifying the use of SIMBAChain APIs. We aim to abstract away the various blockchain concepts, reducing the necessary time needed to get to working code.

1,287 lines (654 loc) 32.5 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">PagedResponse | libsimba-js</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <meta name="description" content="Simbachain Blockchain abstraction and interaction library"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="libsimba-js"><meta property="twitter:description" content="Simbachain Blockchain abstraction and interaction library"></head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a href="test.html" data-ice="testLink">Test</a> <div class="search-box"> <span> <img src="./image/search.png"> <span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span> </span> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/simbachain/libsimba-js"><img width="20px" src="./image/github.png"></a></header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~BadMetadataException.html">BadMetadataException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~BaseException.html">BaseException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~GenerateTransactionException.html">GenerateTransactionException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~GetRequestException.html">GetRequestException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~GetTransactionsException.html">GetTransactionsException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~MethodCallValidationMetadataException.html">MethodCallValidationMetadataException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~MissingMetadataException.html">MissingMetadataException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~NotImplementedException.html">NotImplementedException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~NotInBrowserException.html">NotInBrowserException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~PostRequestException.html">PostRequestException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~RetriesExceededException.html">RetriesExceededException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~SigningException.html">SigningException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~SubmitTransactionException.html">SubmitTransactionException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~TransactionStatusCheckException.html">TransactionStatusCheckException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~UserRejectedSigningException.html">UserRejectedSigningException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~WalletLockedException.html">WalletLockedException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~WalletNotFoundException.html">WalletNotFoundException</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getSimbaInstance">getSimbaInstance</a></span></span></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#simba">simba</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html">PagedResponse</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/simba/simba.js~Simbachain.html">Simbachain</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/simba/simbabase.js~SimbaBase.html">SimbaBase</a></span></span></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#wallet">wallet</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/wallet/localwallet.js~LocalWallet.html">LocalWallet</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/wallet/pkwallet.js~PKWallet.html">PKWallet</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/wallet/wallet.js~Wallet.html">Wallet</a></span></span></li> </ul> </div> </nav> <div class="content" data-ice="content"><div class="header-notice"> <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import PagedResponse from &apos;<span><a href="file/src/simba/pagedresponse.js.html#lineNumber4">@simbachain/libsimba-js/src/simba/pagedresponse.js</a></span>&apos;</code></pre></div> <span data-ice="access">public</span> <span data-ice="kind">class</span> <span data-ice="source">| <span><a href="file/src/simba/pagedresponse.js.html#lineNumber4">source</a></span></span> </div> <div class="self-detail detail"> <h1 data-ice="name">PagedResponse</h1> <div class="description" data-ice="description"><p>Wrapper for paged responses</p> </div> </div> <div data-ice="constructorSummary"><h2>Constructor Summary</h2><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Public Constructor</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-constructor-constructor">constructor</a></span></span><span class="code" data-ice="signature">(data: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, url: <span>URL</span>, simba: <span><a href="class/src/simba/simbabase.js~SimbaBase.html">SimbaBase</a></span>)</span> </p> </div> <div> <div data-ice="description"><p>Wrapper for paged responses</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> <div data-ice="memberSummary"><h2>Member Summary</h2><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Public Members</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-member-results">results</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-member-simba">simba</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-member-url">url</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> </div> </td> <td> </td> </tr> </tbody> </table> <table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Private Members</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">private</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-member-_count">_count</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">private</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-member-_next_page">_next_page</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">private</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-member-_previous_page">_previous_page</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> </div> </td> <td> </td> </tr> </tbody> </table> </div> <div data-ice="methodSummary"><h2>Method Summary</h2><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">Public Methods</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-method-count">count</a></span></span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> </p> </div> <div> <div data-ice="description"><p>Returns the result count</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-method-current_page">current_page</a></span></span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> </p> </div> <div> <div data-ice="description"><p>Returns the current page number</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-method-data">data</a></span></span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> </p> </div> <div> <div data-ice="description"><p>Returns the actual data</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="async">async</span> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-method-next">next</a></span></span><span class="code" data-ice="signature">(): <span>Promise&lt;PagedResponse&gt; </span> | <span> null</span></span> </p> </div> <div> <div data-ice="description"><p>Grab the next page</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-method-next_page">next_page</a></span></span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> </p> </div> <div> <div data-ice="description"><p>Returns the next page number</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="async">async</span> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-method-previous">previous</a></span></span><span class="code" data-ice="signature">(): <span>Promise&lt;PagedResponse&gt; </span> | <span> null</span></span> </p> </div> <div> <div data-ice="description"><p>Grab the previous page</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span class="code" data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html#instance-method-previous_page">previous_page</a></span></span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> </p> </div> <div> <div data-ice="description"><p>Returns the previous page number</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> <div data-ice="constructorDetails"><h2 data-ice="title">Public Constructors</h2> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-constructor-constructor"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">constructor</span><span class="code" data-ice="signature">(data: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>, url: <span>URL</span>, simba: <span><a href="class/src/simba/simbabase.js~SimbaBase.html">SimbaBase</a></span>)</span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber11">source</a></span></span> </span> </h3> <div data-ice="description"><p>Wrapper for paged responses</p> </div> <div data-ice="properties"><div data-ice="properties"> <h4 data-ice="title">Params:</h4> <table class="params"> <thead> <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr> </thead> <tbody> <tr data-ice="property" data-depth="0"> <td data-ice="name" class="code" data-depth="0">data</td> <td data-ice="type" class="code"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>The response</p> </td> </tr> <tr data-ice="property" data-depth="0"> <td data-ice="name" class="code" data-depth="0">url</td> <td data-ice="type" class="code"><span>URL</span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>The URL that provided the response</p> </td> </tr> <tr data-ice="property" data-depth="0"> <td data-ice="name" class="code" data-depth="0">simba</td> <td data-ice="type" class="code"><span><a href="class/src/simba/simbabase.js~SimbaBase.html">SimbaBase</a></span></td> <td data-ice="appendix"></td> <td data-ice="description"><p>The SimbaBase instance that requested the response</p> </td> </tr> </tbody> </table> </div> </div> </div> </div> <div data-ice="memberDetails"><h2 data-ice="title">Public Members</h2> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-member-results"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">results</span><span class="code" data-ice="signature">: <span>*</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber16">source</a></span></span> </span> </h3> <div data-ice="properties"> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-member-simba"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">simba</span><span class="code" data-ice="signature">: <span>*</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber17">source</a></span></span> </span> </h3> <div data-ice="properties"> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-member-url"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">url</span><span class="code" data-ice="signature">: <span>*</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber12">source</a></span></span> </span> </h3> <div data-ice="properties"> </div> </div> <h2 data-ice="title">Private Members</h2> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-member-_count"> <span class="access" data-ice="access">private</span> <span class="code" data-ice="name">_count</span><span class="code" data-ice="signature">: <span>*</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber13">source</a></span></span> </span> </h3> <div data-ice="properties"> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-member-_next_page"> <span class="access" data-ice="access">private</span> <span class="code" data-ice="name">_next_page</span><span class="code" data-ice="signature">: <span>*</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber14">source</a></span></span> </span> </h3> <div data-ice="properties"> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-member-_previous_page"> <span class="access" data-ice="access">private</span> <span class="code" data-ice="name">_previous_page</span><span class="code" data-ice="signature">: <span>*</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber15">source</a></span></span> </span> </h3> <div data-ice="properties"> </div> </div> </div> <div data-ice="methodDetails"><h2 data-ice="title">Public Methods</h2> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-count"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">count</span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber50">source</a></span></span> </span> </h3> <div data-ice="description"><p>Returns the result count</p> </div> <div data-ice="properties"> </div> <div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tbody> <tr> <td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></td> </tr> </tbody> </table> <div data-ice="returnProperties"> </div> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-current_page"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">current_page</span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber58">source</a></span></span> </span> </h3> <div data-ice="description"><p>Returns the current page number</p> </div> <div data-ice="properties"> </div> <div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tbody> <tr> <td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></td> </tr> </tbody> </table> <div data-ice="returnProperties"> </div> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-data"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">data</span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber42">source</a></span></span> </span> </h3> <div data-ice="description"><p>Returns the actual data</p> </div> <div data-ice="properties"> </div> <div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tbody> <tr> <td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td> </tr> </tbody> </table> <div data-ice="returnProperties"> </div> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-next"> <span class="access" data-ice="access">public</span> <span data-ice="async">async</span> <span class="code" data-ice="name">next</span><span class="code" data-ice="signature">(): <span>Promise&lt;PagedResponse&gt; </span> | <span> null</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber24">source</a></span></span> </span> </h3> <div data-ice="description"><p>Grab the next page</p> </div> <div data-ice="properties"> </div> <div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tbody> <tr> <td class="return-type code" data-ice="returnType"><span>Promise&lt;PagedResponse&gt; </span> | <span> null</span></td> <td class="return-desc" data-ice="returnDescription"><p>Null if there&apos;s no next page</p> </td> </tr> </tbody> </table> <div data-ice="returnProperties"> </div> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-next_page"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">next_page</span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber66">source</a></span></span> </span> </h3> <div data-ice="description"><p>Returns the next page number</p> </div> <div data-ice="properties"> </div> <div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tbody> <tr> <td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></td> </tr> </tbody> </table> <div data-ice="returnProperties"> </div> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-previous"> <span class="access" data-ice="access">public</span> <span data-ice="async">async</span> <span class="code" data-ice="name">previous</span><span class="code" data-ice="signature">(): <span>Promise&lt;PagedResponse&gt; </span> | <span> null</span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber33">source</a></span></span> </span> </h3> <div data-ice="description"><p>Grab the previous page</p> </div> <div data-ice="properties"> </div> <div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tbody> <tr> <td class="return-type code" data-ice="returnType"><span>Promise&lt;PagedResponse&gt; </span> | <span> null</span></td> <td class="return-desc" data-ice="returnDescription"><p>Null if there&apos;s no next page</p> </td> </tr> </tbody> </table> <div data-ice="returnProperties"> </div> </div> </div> <div class="detail" data-ice="detail"> <h3 data-ice="anchor" id="instance-method-previous_page"> <span class="access" data-ice="access">public</span> <span class="code" data-ice="name">previous_page</span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></span> <span class="right-info"> <span data-ice="source"><span><a href="file/src/simba/pagedresponse.js.html#lineNumber74">source</a></span></span> </span> </h3> <div data-ice="description"><p>Returns the previous page number</p> </div> <div data-ice="properties"> </div> <div class="return-params" data-ice="returnParams"> <h4>Return:</h4> <table> <tbody> <tr> <td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></td> </tr> </tbody> </table> <div data-ice="returnProperties"> </div> </div> </div> </div> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>