2023-08-09 07:06:05 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > PipedAPI | piped-api< / title > < meta name = "description" content = "Documentation for piped-api" / > < 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 defer src = "../assets/main.js" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" < / script > < header class = "tsd-page-toolbar" >
< div class = "tsd-toolbar-contents container" >
< div class = "table-cell" id = "tsd-search" data-base = ".." >
< div class = "field" > < label for = "tsd-search-field" class = "tsd-widget tsd-toolbar-icon search no-caption" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < path d = "M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill = "var(--color-text)" > < / path > < / svg > < / label > < input type = "text" id = "tsd-search-field" aria-label = "Search" / > < / div >
< div class = "field" >
< div id = "tsd-toolbar-links" > < / div > < / 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" > piped-api< / a > < / div >
< div class = "table-cell" id = "tsd-widgets" > < a href = "#" class = "tsd-widget tsd-toolbar-icon menu no-caption" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < rect x = "1" y = "3" width = "14" height = "2" fill = "var(--color-text)" > < / rect > < rect x = "1" y = "7" width = "14" height = "2" fill = "var(--color-text)" > < / rect > < rect x = "1" y = "11" width = "14" height = "2" fill = "var(--color-text)" > < / rect > < / svg > < / a > < / div > < / div > < / header >
< div class = "container container-main" >
< div class = "col-content" >
< div class = "tsd-page-title" >
< ul class = "tsd-breadcrumb" >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 07:06:05 +00:00
< 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 >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L15" > index.ts:15< / a > < / li > < / ul > < / aside >
2023-08-09 07:06:05 +00:00
< 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" >
< h5 class = "tsd-index-heading uppercase" role = "button" aria-expanded = "false" tabIndex = 0 > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < path d = "M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill = "var(--color-text)" > < / path > < / svg > Index< / h5 > < / summary >
< div class = "tsd-accordion-details" >
< section class = "tsd-index-section" >
< h3 class = "tsd-index-heading" > Constructors< / h3 >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 07:06:05 +00:00
< / div > < / section >
< section class = "tsd-index-section" >
< h3 class = "tsd-index-heading" > Properties< / h3 >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 07:06:05 +00:00
< / div > < / section >
< section class = "tsd-index-section" >
< h3 class = "tsd-index-heading" > Methods< / h3 >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 16:36:24 +00:00
< a href = "index.PipedAPI.html#channelTabs" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > channel< wbr / > Tabs< / span > < / a >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 07:06:05 +00:00
< / 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" >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 07:06:05 +00:00
< 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" > = " https://pipedapi.kavin.rocks" < / span > < / h5 > < / li > < / ul > < / div >
2023-08-09 13:13:08 +00:00
< 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" >
2023-08-09 07:06:05 +00:00
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L17" > index.ts:17< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section >
2023-08-09 07:06:05 +00:00
< 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 >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L16" > index.ts:16< / a > < / li > < / ul > < / aside > < / section > < / section >
2023-08-09 07:06:05 +00:00
< 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 >
< h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagPrivate" > Private< / code > < span > _get< / span > < a href = "#_get" 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 tsd-is-private" >
< li class = "tsd-signature tsd-anchor-link" id = "_get._get-1" > < span class = "tsd-kind-call-signature" > _get< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > url< / 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" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#_get._get-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 data from the specified URL.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > url< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The URL from which to retrieve data.< / 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" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < ul >
< li > A Promise that resolves to the parsed JSON data.< / li >
< / ul >
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L27" > index.ts:27< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / 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" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves a channel by its ID.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > id< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The ID of the channel to retrieve.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li >
< li >
< h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > nextpage< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< 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 >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / 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" > > < / span > < / h4 > < p > A Promise that resolves to the retrieved Channel object.< / p >
2023-08-09 07:06:05 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L72" > index.ts:72< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / span > < a href = "../interfaces/types.Channel.html" class = "tsd-signature-type tsd-kind-interface" > Channel< / a > < span class = "tsd-signature-symbol" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves a channel by its name.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > name< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The name of the channel.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Channel.html" class = "tsd-signature-type tsd-kind-interface" > Channel< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A promise that resolves to the channel object.< / p >
2023-08-09 07:06:05 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L91" > index.ts:91< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
< section class = "tsd-panel tsd-member" > < a id = "channelTabs" class = "tsd-anchor" > < / a >
< h3 class = "tsd-anchor-link" > < span > channel< wbr / > Tabs< / span > < a href = "#channelTabs" 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 = "channelTabs.channelTabs-1" > < span class = "tsd-kind-call-signature" > channel< wbr / > Tabs< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > data< / 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" > < < / span > < a href = "../interfaces/types.Tab.html" class = "tsd-signature-type tsd-kind-interface" > Tab< / a > < span class = "tsd-signature-symbol" > > < / span > < a href = "#channelTabs.channelTabs-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-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > data< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < / ul > < / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Tab.html" class = "tsd-signature-type tsd-kind-interface" > Tab< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L81" > index.ts:81< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / span > < a href = "../interfaces/types.Comments.html" class = "tsd-signature-type tsd-kind-interface" > Comments< / a > < span class = "tsd-signature-symbol" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves comments for a specific video.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > videoId< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The ID of the video for which to retrieve comments.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li >
< li >
< h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > nextpage< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< 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 >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Comments.html" class = "tsd-signature-type tsd-kind-interface" > Comments< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A Promise that resolves to the comments for the video.< / p >
2023-08-09 07:06:05 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L59" > index.ts:59< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / 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" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves a playlist based on its ID.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > id< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The ID of the playlist to retrieve.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li >
< li >
< h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > nextpage< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< 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 >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / 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" > > < / span > < / h4 > < p > A Promise that resolves to a Playlist or NextPagePlaylist object.< / p >
2023-08-09 07:06:05 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L112" > index.ts:112< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / span > < a href = "../interfaces/types.Search.html" class = "tsd-signature-type tsd-kind-interface" > Search< / a > < span class = "tsd-signature-symbol" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Searches videos for a given query with an optional filter.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > query< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The query to search for.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li >
< li >
< h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > filter< / span > : < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > = " all" < / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The optional filter to apply.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Search.html" class = "tsd-signature-type tsd-kind-interface" > Search< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < ul >
2023-08-09 07:06:05 +00:00
< li > A Promise that resolves to the search results.< / li >
< / ul >
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L154" > index.ts:154< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / span > < a href = "../interfaces/types.Sponsors.html" class = "tsd-signature-type tsd-kind-interface" > Sponsors< / a > < span class = "tsd-signature-symbol" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves sponsors based on the provided ID and category.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > id< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The ID of the video.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li >
< li >
< h5 > < span class = "tsd-kind-parameter" > category< / span > : < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > = ...< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The category of sponsors you would like to skip. Example: [" sponsor" ].< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Sponsors.html" class = "tsd-signature-type tsd-kind-interface" > Sponsors< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A promise that resolves to the sponsors.< / p >
2023-08-09 07:06:05 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L138" > index.ts:138< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / span > < a href = "../interfaces/types.Streams.html" class = "tsd-signature-type tsd-kind-interface" > Streams< / a > < span class = "tsd-signature-symbol" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves the streams for a given video ID.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > videoId< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The ID of the video.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Streams.html" class = "tsd-signature-type tsd-kind-interface" > Streams< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A promise that resolves to the streams for the given video ID.< / p >
2023-08-09 07:06:05 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L48" > index.ts:48< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
< li class = "tsd-signature tsd-anchor-link" id = "suggestions.suggestions-1" > < span class = "tsd-kind-call-signature" > suggestions< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > query< / 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" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#suggestions.suggestions-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 suggestions based on the given query.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > query< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The query string to search for suggestions.< / 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" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A promise that resolves to an array of string suggestions.< / p >
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L127" > index.ts:127< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / 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" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves the trending videos for a specific region.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > region< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< 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 >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / 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" > > < / span > < / h4 > < ul >
2023-08-09 07:06:05 +00:00
< 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 >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L38" > index.ts:38< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section >
2023-08-09 07:06:05 +00:00
< 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" >
2023-08-09 13:13:08 +00:00
< 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" > < < / span > < a href = "../interfaces/types.Channel.html" class = "tsd-signature-type tsd-kind-interface" > Channel< / a > < span class = "tsd-signature-symbol" > > < / 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 >
2023-08-09 07:06:05 +00:00
< li class = "tsd-description" >
< div class = "tsd-comment tsd-typography" > < p > Retrieves a user by their name.< / p >
< / div >
< div class = "tsd-parameters" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameter-list" >
< li >
< h5 > < span class = "tsd-kind-parameter" > name< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" > < p > The name of the user.< / p >
< / div >
< div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div >
2023-08-09 13:13:08 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Channel.html" class = "tsd-signature-type tsd-kind-interface" > Channel< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A Promise that resolves to the user' s channel.< / p >
2023-08-09 07:06:05 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" >
< ul >
2023-08-09 16:36:24 +00:00
< li > Defined in < a href = "https://github.com/artegoser/piped-api/blob/5465963/src/index.ts#L101" > index.ts:101< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / div >
2023-08-09 07:06:05 +00:00
< div class = "col-sidebar" >
< div class = "page-menu" >
< div class = "tsd-navigation settings" >
< details class = "tsd-index-accordion" > < summary class = "tsd-accordion-summary" >
< h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < path d = "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill = "var(--color-text)" id = "icon-chevronDown" > < / path > < / svg > Settings< / h3 > < / summary >
< div class = "tsd-accordion-details" >
< div class = "tsd-filter-visibility" >
< h4 class = "uppercase" > Member Visibility< / h4 > < form >
< ul id = "tsd-filter-options" >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-protected" name = "protected" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Protected< / span > < / label > < / li >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-private" name = "private" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Private< / span > < / label > < / li >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li >
< li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-external" name = "external" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > External< / span > < / label > < / li > < / ul > < / form > < / div >
< div class = "tsd-theme-toggle" >
< h4 class = "uppercase" > Theme< / h4 > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div >
< details open class = "tsd-index-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" >
< h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary >
< div class = "tsd-accordion-details" >
< ul >
< li > < a href = "#constructor" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-512" > < / use > < / svg > < span > constructor< / span > < / a > < / li >
< li > < a href = "#host" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > host< / span > < / a > < / li >
< li > < a href = "#_get" class = "tsd-is-private" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > _get< / span > < / a > < / li >
< li > < a href = "#channel" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > channel< / span > < / a > < / li >
< li > < a href = "#channelByName" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > channel< wbr / > By< wbr / > Name< / span > < / a > < / li >
2023-08-09 16:36:24 +00:00
< li > < a href = "#channelTabs" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > channel< wbr / > Tabs< / span > < / a > < / li >
2023-08-09 07:06:05 +00:00
< li > < a href = "#comments" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > comments< / span > < / a > < / li >
< li > < a href = "#playlist" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > playlist< / span > < / a > < / li >
< li > < a href = "#search" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > search< / span > < / a > < / li >
< li > < a href = "#sponsors" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > sponsors< / span > < / a > < / li >
< li > < a href = "#streams" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > streams< / span > < / a > < / li >
< li > < a href = "#suggestions" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > suggestions< / span > < / a > < / li >
< 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" >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 07:06:05 +00:00
< ul class = "tsd-small-nested-navigation" >
2023-08-09 13:13:08 +00:00
< 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 >
2023-08-09 07:06:05 +00:00
< div class = "tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p > < / div >
< div class = "overlay" > < / div > < / body > < / html >
