Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Velenir
Velenir committed Jul 5, 2024
1 parent ee0acb6 commit 0550c29
Show file tree
Hide file tree
Showing 222 changed files with 665 additions and 617 deletions.
2 changes: 1 addition & 1 deletion docs/html/assets/search.js
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/html/classes/FetcherError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ <h3 class="tsd-anchor-link"><span>code</span><a href="#code" aria-label="Permali
<div class="tsd-signature">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/FetcherErrorInterface.html">FetcherErrorInterface</a>.<a href="../interfaces/FetcherErrorInterface.html#code">code</a></p>
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/helpers/misc.ts#L109">src/helpers/misc.ts:109</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/helpers/misc.ts#L109">src/helpers/misc.ts:109</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="isAxiosError" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" 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">is<wbr/>Axios<wbr/>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/FetcherErrorInterface.html">FetcherErrorInterface</a>.<a href="../interfaces/FetcherErrorInterface.html#isAxiosError">isAxiosError</a></p>
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/helpers/misc.ts#L113">src/helpers/misc.ts:113</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/helpers/misc.ts#L113">src/helpers/misc.ts:113</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand All @@ -95,13 +95,13 @@ <h3 class="tsd-anchor-link"><span>request</span><a href="#request" aria-label="P
<div class="tsd-signature">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/FetcherErrorInterface.html">FetcherErrorInterface</a>.<a href="../interfaces/FetcherErrorInterface.html#request">request</a></p>
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/helpers/misc.ts#L111">src/helpers/misc.ts:111</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/helpers/misc.ts#L111">src/helpers/misc.ts:111</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="response" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>response</span><a href="#response" 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">response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.AxiosResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AxiosResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/FetcherErrorInterface.html">FetcherErrorInterface</a>.<a href="../interfaces/FetcherErrorInterface.html#response">response</a></p>
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/helpers/misc.ts#L112">src/helpers/misc.ts:112</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/helpers/misc.ts#L112">src/helpers/misc.ts:112</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand All @@ -113,7 +113,7 @@ <h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Per
<div class="tsd-signature">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/FetcherErrorInterface.html">FetcherErrorInterface</a>.<a href="../interfaces/FetcherErrorInterface.html#status">status</a></p>
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/helpers/misc.ts#L110">src/helpers/misc.ts:110</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/helpers/misc.ts#L110">src/helpers/misc.ts:110</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" 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">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../functions/_internal_.Error-1.html" class="tsd-signature-type" data-tsd-kind="Function">Error</a>, stackTraces<span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.CallSite.html" class="tsd-signature-type" data-tsd-kind="Interface">CallSite</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
Expand Down
16 changes: 8 additions & 8 deletions docs/html/classes/ParaSwap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,42 +79,42 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">account</span><a href="#account" 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">account<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L77">src/legacy/index.ts:77</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L77">src/legacy/index.ts:77</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="apiURL" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span class="deprecated">apiURL</span><a href="#apiURL" 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">apiURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L73">src/legacy/index.ts:73</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L73">src/legacy/index.ts:73</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="chainId" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span class="deprecated">chain<wbr/>Id</span><a href="#chainId" 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">chain<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L72">src/legacy/index.ts:72</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L72">src/legacy/index.ts:72</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="ethersDeps" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">ethers<wbr/>Deps</span><a href="#ethersDeps" 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">ethers<wbr/>Deps<span class="tsd-signature-symbol">?:</span> <a href="../interfaces/EthersProviderDeps.html" class="tsd-signature-type" data-tsd-kind="Interface">EthersProviderDeps</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L76">src/legacy/index.ts:76</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L76">src/legacy/index.ts:76</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="fetcher" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span class="deprecated">fetcher</span><a href="#fetcher" 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">fetcher<span class="tsd-signature-symbol">:</span> <a href="../types/FetcherFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">FetcherFunction</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L70">src/legacy/index.ts:70</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L70">src/legacy/index.ts:70</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sdk" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span class="deprecated">sdk</span><a href="#sdk" 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">sdk<span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.Partial.html" class="tsd-signature-type" data-tsd-kind="Type alias">Partial</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/SwapSDKMethods.html" class="tsd-signature-type" data-tsd-kind="Type alias">SwapSDKMethods</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/_internal_.TxResponse.html" class="tsd-signature-type" data-tsd-kind="Type alias">TxResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L69">src/legacy/index.ts:69</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L69">src/legacy/index.ts:69</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="version" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span class="deprecated">version</span><a href="#version" 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">version<span class="tsd-signature-symbol">:</span> <a href="../types/ParaSwapVersion.html" class="tsd-signature-type" data-tsd-kind="Type alias">ParaSwapVersion</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L74">src/legacy/index.ts:74</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L74">src/legacy/index.ts:74</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="web3Provider" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">web3<wbr/>Provider</span><a href="#web3Provider" 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">web3<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <a href="_internal_.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/legacy/index.ts#L75">src/legacy/index.ts:75</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/feat/new_v6_params/src/legacy/index.ts#L75">src/legacy/index.ts:75</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="approveToken" class="tsd-anchor"></a>
Expand Down
Loading

0 comments on commit 0550c29

Please sign in to comment.