Skip to content

Commit b130a0b

Browse files
committed
docs: regenerate
1 parent 1bce903 commit b130a0b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/classes/Options.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Options | namemcwrapper</title><meta name="description" content="Documentation for namemcwrapper"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">namemcwrapper</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">namemcwrapper</a></li><li><a href="Options.html">Options</a></li></ul><h1>Class Options</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Options</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/IOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IOptions</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Options.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#cloudProxy" class="tsd-kind-icon">cloud<wbr/>Proxy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#defaultSkinsModel" class="tsd-kind-icon">default<wbr/>Skins<wbr/>Model</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#endpoint" class="tsd-kind-icon">endpoint</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#proxy" class="tsd-kind-icon">proxy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#rendersIgnoreProxy" class="tsd-kind-icon">renders<wbr/>Ignore<wbr/>Proxy</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Options.html#getEndpoint" class="tsd-kind-icon">get<wbr/>Endpoint</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/IOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Options.html" class="tsd-signature-type" data-tsd-kind="Class">Options</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MrZillaGold/NameMCWrapper/blob/master/src/options.ts#L97">options.ts:97</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/IOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Options.html" class="tsd-signature-type" data-tsd-kind="Class">Options</a></h4></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="cloudProxy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> cloud<wbr/>Proxy<a href="#cloudProxy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">cloud<wbr/>Proxy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>cookies<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>domain<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>expires<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>httpOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sameSite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;Strict&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Lax&quot;</span><span class="tsd-signature-symbol">; </span>secure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>maxTimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>session<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/IOptions.html">IOptions</a>.<a href="../interfaces/IOptions.html#cloudProxy">cloudProxy</a></p><ul><li>Defined in <a href="https://github.com/MrZillaGold/NameMCWrapper/blob/master/src/options.ts#L92">options.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2+
<p>CloudProxy options for requests
3+
NameMC often uses CloudFlare to protect against DDoS attacks
4+
If you want the library to work at such times, you need to deploy your own Cloud Proxy instance</p>
5+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="defaultSkinsModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> default<wbr/>Skins<wbr/>Model<a href="#defaultSkinsModel" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">default<wbr/>Skins<wbr/>Model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/Model.html#CLASSIC" class="tsd-signature-type" data-tsd-kind="Enumeration member">CLASSIC</a><span class="tsd-signature-symbol"> | </span><a href="../enums/Model.html#SLIM" class="tsd-signature-type" data-tsd-kind="Enumeration member">SLIM</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;classic&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;slim&quot;</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/IOptions.html">IOptions</a>.<a href="../interfaces/IOptions.html#defaultSkinsModel">defaultSkinsModel</a></p><ul><li>Defined in <a href="https://github.com/MrZillaGold/NameMCWrapper/blob/master/src/options.ts#L95">options.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6+
<p>Model for skins by default, if an error occurred while trying to parse it</p>
7+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="endpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> endpoint<a href="#endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">endpoint<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;namemc.com&quot;</span><span class="tsd-signature-symbol"> = &#39;namemc.com&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MrZillaGold/NameMCWrapper/blob/master/src/options.ts#L94">options.ts:94</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="proxy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> proxy<a href="#proxy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">proxy<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><span class="tsd-signature-symbol"> = &#39;&#39;</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/IOptions.html">IOptions</a>.<a href="../interfaces/IOptions.html#proxy">proxy</a></p><ul><li>Defined in <a href="https://github.com/MrZillaGold/NameMCWrapper/blob/master/src/options.ts#L91">options.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8+
<p>Proxy url for requests
9+
Support <a href="https://github.com/NoahCardoza/CloudProxy" class="external">CloudProxy</a></p>
10+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="rendersIgnoreProxy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> renders<wbr/>Ignore<wbr/>Proxy<a href="#rendersIgnoreProxy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">renders<wbr/>Ignore<wbr/>Proxy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/IOptions.html">IOptions</a>.<a href="../interfaces/IOptions.html#rendersIgnoreProxy">rendersIgnoreProxy</a></p><ul><li>Defined in <a href="https://github.com/MrZillaGold/NameMCWrapper/blob/master/src/options.ts#L93">options.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11+
<p>Ignore proxy url for renders</p>
12+
</div></div></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="getEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Endpoint<a href="#getEndpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Endpoint<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/IGetEndpointOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IGetEndpointOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MrZillaGold/NameMCWrapper/blob/master/src/options.ts#L113">options.ts:113</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <a href="../interfaces/IGetEndpointOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IGetEndpointOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="Options.html" class="tsd-kind-icon">Options</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Options.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#cloudProxy" class="tsd-kind-icon">cloud<wbr/>Proxy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#defaultSkinsModel" class="tsd-kind-icon">default<wbr/>Skins<wbr/>Model</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#endpoint" class="tsd-kind-icon">endpoint</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#proxy" class="tsd-kind-icon">proxy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Options.html#rendersIgnoreProxy" class="tsd-kind-icon">renders<wbr/>Ignore<wbr/>Proxy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Options.html#getEndpoint" class="tsd-kind-icon">get<wbr/>Endpoint</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)