Skip to main content

youtubei

Namespaces​

Classes​

Interfaces​

Type Aliases​

ChannelShelf​

Ƭ ChannelShelf: Shelf<BaseChannel[] | VideoCompact[] | PlaylistCompact[]> & { subtitle?: string }

Chapter​

Ƭ Chapter: Object

Type declaration​

NameType
startnumber
thumbnailsThumbnails
titlestring

ClientOptions​

Ƭ ClientOptions: HTTPOptions

HTTPOptions​

Ƭ HTTPOptions: Object

Type declaration​

NameType
apiKeystring
baseUrlstring
clientNamestring
clientVersionstring
fetchOptions?Partial<RequestInit>
initialCookie?string
oauth?OAuthOptions
pot?PotOptions
rawResponseLogPath?string
youtubeClientOptions?Record<string, unknown>

OAuthOptions​

Ƭ OAuthOptions: Object

Type declaration​

NameType
enabledboolean
refreshToken?string

OAuthProps​

Ƭ OAuthProps: Object

Type declaration​

NameType
expiresAtDate | null
refreshToken?string
tokenstring | null

PotOptions​

Ƭ PotOptions: Object

Type declaration​

NameType
tokenstring
visitorDatastring

SearchDuration​

Ƭ SearchDuration: "all" | "short" | "medium" | "long" | Duration

SearchFeature​

Ƭ SearchFeature: "live" | "4k" | "hd" | "subtitles" | "creativeCommons" | "360" | "vr180" | "3d" | "hdr" | "location" | Feature

SearchOptions​

Ƭ SearchOptions: Object

Type declaration​

NameType
duration?SearchDuration
features?SearchFeature[]
sortBy?SearchSort
type?SearchType
uploadDate?SearchUploadDate

SearchResultItem​

Ƭ SearchResultItem<T>: T extends "video" | VideoCompact ? VideoCompact : T extends "channel" | BaseChannel ? BaseChannel : T extends "playlist" | PlaylistCompact ? PlaylistCompact : VideoCompact | BaseChannel | PlaylistCompact

Type parameters​

NameType
T"all"

SearchSort​

Ƭ SearchSort: "relevance" | "rating" | "date" | "view" | Sort

SearchType​

Ƭ SearchType: "all" | "video" | "channel" | "playlist" | Type

SearchUploadDate​

Ƭ SearchUploadDate: "all" | "hour" | "today" | "week" | "month" | "year" | UploadDate