artegoser/piped-api
1
0
Fork 0
mirror of https://github.com/artegoser/piped-api.git synced 2025-02-23 20:51:27 +03:00
Code Issues Projects Releases Packages Wiki Activity

Deploying to gh-pages from @ artegoser/piped-api@a37588554b 🚀

Browse source
This commit is contained in:
artegoser 2023-08-09 13:13:08 +00:00
parent 405e7da1cd
commit 56772bee9e
21 changed files with 809 additions and 699 deletions
Download patch file Download diff file Expand all files Collapse all files

123
classes/PipedAPI.html → classes/index.PipedAPI.html
View file

@ -12,15 +12,16 @@
<div class="col-content">
<div class="tsd-page-title">
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">piped-api</a></li>
<li><a href="PipedAPI.html">PipedAPI</a></li></ul>
<li><a href="../index.html">piped-api</a></li>
<li><a href="../modules/index.html">index</a></li>
<li><a href="index.PipedAPI.html">PipedAPI</a></li></ul>
<h1>Class PipedAPI</h1></div>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">PipedAPI</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L14">piped-api.ts:14</a></li></ul></aside>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L14">index.ts:14</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">
@ -28,48 +29,48 @@
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Constructors</h3>
<div class="tsd-index-list"><a href="PipedAPI.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
<div class="tsd-index-list"><a href="index.PipedAPI.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="PipedAPI.html#host" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>host</span></a>
<div class="tsd-index-list"><a href="index.PipedAPI.html#host" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>host</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="PipedAPI.html#_get" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>_get</span></a>
<a href="PipedAPI.html#channel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>channel</span></a>
<a href="PipedAPI.html#channelByName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>channel<wbr/>By<wbr/>Name</span></a>
<a href="PipedAPI.html#comments" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>comments</span></a>
<a href="PipedAPI.html#playlist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>playlist</span></a>
<a href="PipedAPI.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>search</span></a>
<a href="PipedAPI.html#sponsors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sponsors</span></a>
<a href="PipedAPI.html#streams" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>streams</span></a>
<a href="PipedAPI.html#suggestions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>suggestions</span></a>
<a href="PipedAPI.html#trending" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trending</span></a>
<a href="PipedAPI.html#user" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>user</span></a>
<div class="tsd-index-list"><a href="index.PipedAPI.html#_get" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>_get</span></a>
<a href="index.PipedAPI.html#channel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>channel</span></a>
<a href="index.PipedAPI.html#channelByName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>channel<wbr/>By<wbr/>Name</span></a>
<a href="index.PipedAPI.html#comments" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>comments</span></a>
<a href="index.PipedAPI.html#playlist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>playlist</span></a>
<a href="index.PipedAPI.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>search</span></a>
<a href="index.PipedAPI.html#sponsors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sponsors</span></a>
<a href="index.PipedAPI.html#streams" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>streams</span></a>
<a href="index.PipedAPI.html#suggestions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>suggestions</span></a>
<a href="index.PipedAPI.html#trending" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trending</span></a>
<a href="index.PipedAPI.html#user" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>user</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><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></g></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="constructor.new_PipedAPI"><span class="tsd-kind-constructor-signature">new <wbr/>PipedAPI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PipedAPI.html" class="tsd-signature-type tsd-kind-class">PipedAPI</a><a href="#constructor.new_PipedAPI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="constructor.new_PipedAPI"><span class="tsd-kind-constructor-signature">new <wbr/>PipedAPI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.PipedAPI.html" class="tsd-signature-type tsd-kind-class">PipedAPI</a><a href="#constructor.new_PipedAPI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">host</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;https://pipedapi.kavin.rocks&quot;</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="PipedAPI.html" class="tsd-signature-type tsd-kind-class">PipedAPI</a></h4><aside class="tsd-sources">
<h4 class="tsd-returns-title">Returns <a href="index.PipedAPI.html" class="tsd-signature-type tsd-kind-class">PipedAPI</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L16">piped-api.ts:16</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L16">index.ts:16</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"><a id="host" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>host</span><a href="#host" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">host</span><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/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L15">piped-api.ts:15</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L15">index.ts:15</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_get" class="tsd-anchor"></a>
@ -93,11 +94,11 @@
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L26">piped-api.ts:26</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L26">index.ts:26</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="channel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>channel</span><a href="#channel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="channel.channel-1"><span class="tsd-kind-call-signature">channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">nextpage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NextPageChannel.html" class="tsd-signature-type tsd-kind-interface">NextPageChannel</a><span class="tsd-signature-symbol">&gt;</span><a href="#channel.channel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="channel.channel-1"><span class="tsd-kind-call-signature">channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">nextpage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.NextPageChannel.html" class="tsd-signature-type tsd-kind-interface">NextPageChannel</a><span class="tsd-signature-symbol">&gt;</span><a href="#channel.channel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves a channel by its ID.</p>
</div>
@ -114,15 +115,15 @@
<div class="tsd-comment tsd-typography"><p>The JSON encoded nextpage variable, to be sent as a query string (optional).</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NextPageChannel.html" class="tsd-signature-type tsd-kind-interface">NextPageChannel</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to the retrieved Channel object.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.NextPageChannel.html" class="tsd-signature-type tsd-kind-interface">NextPageChannel</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to the retrieved Channel object.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L71">piped-api.ts:71</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L71">index.ts:71</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="channelByName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>channel<wbr/>By<wbr/>Name</span><a href="#channelByName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="channelByName.channelByName-1"><span class="tsd-kind-call-signature">channel<wbr/>By<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span><a href="#channelByName.channelByName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="channelByName.channelByName-1"><span class="tsd-kind-call-signature">channel<wbr/>By<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span><a href="#channelByName.channelByName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves a channel by its name.</p>
</div>
@ -134,15 +135,15 @@
<div class="tsd-comment tsd-typography"><p>The name of the channel.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the channel object.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the channel object.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L86">piped-api.ts:86</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L86">index.ts:86</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="comments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>comments</span><a href="#comments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="comments.comments-1"><span class="tsd-kind-call-signature">comments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoId</span>, <span class="tsd-kind-parameter">nextpage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Comments.html" class="tsd-signature-type tsd-kind-interface">Comments</a><span class="tsd-signature-symbol">&gt;</span><a href="#comments.comments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="comments.comments-1"><span class="tsd-kind-call-signature">comments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoId</span>, <span class="tsd-kind-parameter">nextpage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Comments.html" class="tsd-signature-type tsd-kind-interface">Comments</a><span class="tsd-signature-symbol">&gt;</span><a href="#comments.comments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves comments for a specific video.</p>
</div>
@ -159,15 +160,15 @@
<div class="tsd-comment tsd-typography"><p>The JSON encoded nextpage variable, to be sent as a query string (optional).</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Comments.html" class="tsd-signature-type tsd-kind-interface">Comments</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to the comments for the video.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Comments.html" class="tsd-signature-type tsd-kind-interface">Comments</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to the comments for the video.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L58">piped-api.ts:58</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L58">index.ts:58</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="playlist" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>playlist</span><a href="#playlist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="playlist.playlist-1"><span class="tsd-kind-call-signature">playlist</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">nextpage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Playlist.html" class="tsd-signature-type tsd-kind-interface">Playlist</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NextPagePlaylist.html" class="tsd-signature-type tsd-kind-interface">NextPagePlaylist</a><span class="tsd-signature-symbol">&gt;</span><a href="#playlist.playlist-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="playlist.playlist-1"><span class="tsd-kind-call-signature">playlist</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">nextpage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Playlist.html" class="tsd-signature-type tsd-kind-interface">Playlist</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.NextPagePlaylist.html" class="tsd-signature-type tsd-kind-interface">NextPagePlaylist</a><span class="tsd-signature-symbol">&gt;</span><a href="#playlist.playlist-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves a playlist based on its ID.</p>
</div>
@ -184,15 +185,15 @@
<div class="tsd-comment tsd-typography"><p>The token for the next page of results (optional).</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Playlist.html" class="tsd-signature-type tsd-kind-interface">Playlist</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NextPagePlaylist.html" class="tsd-signature-type tsd-kind-interface">NextPagePlaylist</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to a Playlist or NextPagePlaylist object.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Playlist.html" class="tsd-signature-type tsd-kind-interface">Playlist</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.NextPagePlaylist.html" class="tsd-signature-type tsd-kind-interface">NextPagePlaylist</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to a Playlist or NextPagePlaylist object.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L107">piped-api.ts:107</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L107">index.ts:107</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="search" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>search</span><a href="#search" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="search.search-1"><span class="tsd-kind-call-signature">search</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Search.html" class="tsd-signature-type tsd-kind-interface">Search</a><span class="tsd-signature-symbol">&gt;</span><a href="#search.search-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="search.search-1"><span class="tsd-kind-call-signature">search</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Search.html" class="tsd-signature-type tsd-kind-interface">Search</a><span class="tsd-signature-symbol">&gt;</span><a href="#search.search-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Searches videos for a given query with an optional filter.</p>
</div>
@ -209,17 +210,17 @@
<div class="tsd-comment tsd-typography"><p>The optional filter to apply.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Search.html" class="tsd-signature-type tsd-kind-interface">Search</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Search.html" class="tsd-signature-type tsd-kind-interface">Search</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<li>A Promise that resolves to the search results.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L149">piped-api.ts:149</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L149">index.ts:149</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="sponsors" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>sponsors</span><a href="#sponsors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="sponsors.sponsors-1"><span class="tsd-kind-call-signature">sponsors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">category</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Sponsors.html" class="tsd-signature-type tsd-kind-interface">Sponsors</a><span class="tsd-signature-symbol">&gt;</span><a href="#sponsors.sponsors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="sponsors.sponsors-1"><span class="tsd-kind-call-signature">sponsors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">category</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Sponsors.html" class="tsd-signature-type tsd-kind-interface">Sponsors</a><span class="tsd-signature-symbol">&gt;</span><a href="#sponsors.sponsors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves sponsors based on the provided ID and category.</p>
</div>
@ -236,15 +237,15 @@
<div class="tsd-comment tsd-typography"><p>The category of sponsors you would like to skip. Example: [&quot;sponsor&quot;].</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Sponsors.html" class="tsd-signature-type tsd-kind-interface">Sponsors</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the sponsors.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Sponsors.html" class="tsd-signature-type tsd-kind-interface">Sponsors</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the sponsors.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L133">piped-api.ts:133</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L133">index.ts:133</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="streams" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>streams</span><a href="#streams" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="streams.streams-1"><span class="tsd-kind-call-signature">streams</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Streams.html" class="tsd-signature-type tsd-kind-interface">Streams</a><span class="tsd-signature-symbol">&gt;</span><a href="#streams.streams-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="streams.streams-1"><span class="tsd-kind-call-signature">streams</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Streams.html" class="tsd-signature-type tsd-kind-interface">Streams</a><span class="tsd-signature-symbol">&gt;</span><a href="#streams.streams-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves the streams for a given video ID.</p>
</div>
@ -256,11 +257,11 @@
<div class="tsd-comment tsd-typography"><p>The ID of the video.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Streams.html" class="tsd-signature-type tsd-kind-interface">Streams</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the streams for the given video ID.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Streams.html" class="tsd-signature-type tsd-kind-interface">Streams</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the streams for the given video ID.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L47">piped-api.ts:47</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L47">index.ts:47</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="suggestions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>suggestions</span><a href="#suggestions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -280,11 +281,11 @@
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L122">piped-api.ts:122</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L122">index.ts:122</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="trending" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>trending</span><a href="#trending" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="trending.trending-1"><span class="tsd-kind-call-signature">trending</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">region</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Video.html" class="tsd-signature-type tsd-kind-interface">Video</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#trending.trending-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="trending.trending-1"><span class="tsd-kind-call-signature">trending</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">region</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Video.html" class="tsd-signature-type tsd-kind-interface">Video</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#trending.trending-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves the trending videos for a specific region.</p>
</div>
@ -296,17 +297,17 @@
<div class="tsd-comment tsd-typography"><p>The region for which to retrieve trending videos.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Video.html" class="tsd-signature-type tsd-kind-interface">Video</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Video.html" class="tsd-signature-type tsd-kind-interface">Video</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<li>A promise that resolves to an array of Video objects representing the trending videos.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L37">piped-api.ts:37</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L37">index.ts:37</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="user" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="user.user-1"><span class="tsd-kind-call-signature">user</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span><a href="#user.user-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="user.user-1"><span class="tsd-kind-call-signature">user</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span><a href="#user.user-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves a user by their name.</p>
</div>
@ -318,11 +319,11 @@
<div class="tsd-comment tsd-typography"><p>The name of the user.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to the user&#39;s channel.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to the user&#39;s channel.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/6f0aaa4/src/piped-api.ts#L96">piped-api.ts:96</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/artegoser/piped-api/blob/a375885/src/index.ts#L96">index.ts:96</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@ -356,24 +357,14 @@
<li><a href="#trending" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trending</span></a></li>
<li><a href="#user" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>user</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>piped-<wbr/>api</span></a>
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>piped-<wbr/>api</span></a>
<ul class="tsd-small-nested-navigation">
<li><a href="PipedAPI.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>PipedAPI</span></a></li>
<li><a href="../interfaces/AudioStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Audio<wbr/>Stream</span></a></li>
<li><a href="../interfaces/Channel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Channel</span></a></li>
<li><a href="../interfaces/Comment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Comment</span></a></li>
<li><a href="../interfaces/Comments.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Comments</span></a></li>
<li><a href="../interfaces/NextPageChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Next<wbr/>Page<wbr/>Channel</span></a></li>
<li><a href="../interfaces/NextPagePlaylist.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Next<wbr/>Page<wbr/>Playlist</span></a></li>
<li><a href="../interfaces/Playlist.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Playlist</span></a></li>
<li><a href="../interfaces/Search.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search</span></a></li>
<li><a href="../interfaces/Segments.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Segments</span></a></li>
<li><a href="../interfaces/Sponsors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Sponsors</span></a></li>
<li><a href="../interfaces/Streams.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Streams</span></a></li>
<li><a href="../interfaces/Subtitle.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Subtitle</span></a></li>
<li><a href="../interfaces/Video.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Video</span></a></li>
<li><a href="../interfaces/VideoStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Video<wbr/>Stream</span></a></li>
<li><a href="../types/Item.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Item</span></a></li></ul></nav></div></div></div>
<li>
<details class="tsd-index-accordion" open data-key="index"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>index</span></a></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="index.PipedAPI.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>PipedAPI</span></a></li></ul></div></details></li>
<li><a href="../modules/types.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>types</span></a></li></ul></nav></div></div></div>
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div></body></html>