Documentation
Classes
- Caption
- Channel
- ChannelSection
- Comment
- Language
- Playlist
- Region
- Subscription
- Video
- VideoAbuseReportReason
- VideoCategory
- YouTube
References
default
Renames and re-exports YouTube
Type Aliases
Authorization
Ƭ Authorization: Object
Type declaration
| Name | Type |
|---|---|
accessToken? | string |
apiKey? | string |
Defined in
Banners
Ƭ Banners: Object
Type declaration
| Name | Type |
|---|---|
bannerImageUrl | string |
bannerMobileExtraHdImageUrl | string |
bannerMobileHdImageUrl | string |
bannerMobileImageUrl | string |
bannerMobileLowImageUrl | string |
bannerMobileMediumImageUrl | string |
bannerTabletExtraHdImageUrl | string |
bannerTabletHdImageUrl | string |
bannerTabletImageUrl | string |
bannerTabletLowImageUrl | string |
bannerTvHighImageUrl | string |
bannerTvImageUrl | string |
bannerTvLowImageUrl | string |
bannerTvMediumImageUrl | string |
Defined in
ChannelBrandingSettings
Ƭ ChannelBrandingSettings: Object
Type declaration
| Name | Type |
|---|---|
channel? | { country?: string ; defaultLanguage?: string ; defaultTab?: string ; description?: string ; featuredChannelsTitle?: string ; featuredChannelsUrls?: string[] ; keywords?: string ; moderateComments?: boolean ; profileColor?: string ; showBrowseView?: boolean ; showRelatedChannels?: boolean ; trackingAnalyticsAccountId?: string ; unsubscribedTrailer?: string } |
channel.country? | string |
channel.defaultLanguage? | string |
channel.defaultTab? | string |
channel.description? | string |
channel.featuredChannelsTitle? | string |
channel.featuredChannelsUrls? | string[] |
channel.keywords? | string |
channel.moderateComments? | boolean |
channel.profileColor? | string |
channel.showBrowseView? | boolean |
channel.showRelatedChannels? | boolean |
channel.trackingAnalyticsAccountId? | string |
channel.unsubscribedTrailer? | string |
image? | { bannerExternalUrl?: string ; trackingImageUrl?: string ; watchIconImageUrl?: string } |
image.bannerExternalUrl? | string |
image.trackingImageUrl? | string |
image.watchIconImageUrl? | string |
Defined in
ChannelParts
Ƭ ChannelParts: ("auditDetails" | "brandingSettings" | "contentDetails" | "contentOwnerDetails" | "id" | "localizations" | "snippet" | "statistics" | "status" | "topicDetails")[]
Defined in
ChannelResolvable
Ƭ ChannelResolvable: string | Channel
A URL, ID, search query, or object of a channel.
Defined in
ChannelSearchOptions
Ƭ ChannelSearchOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
channelType? | "any" | "show" | Filter by TV shows |
Defined in
types/GetPaginatedItems.ts:128
ChannelSectionParts
Ƭ ChannelSectionParts: ("contentDetails" | "id" | "localizations" | "snippet" | "targeting")[]
Defined in
ChannelSectionType
Ƭ ChannelSectionType: "allPlaylists" | "completedEvents" | "likedPlaylists" | "likes" | "liveEvents" | "multipleChannels" | "multiplePlaylists" | "popularUploads" | "postedPlaylists" | "postedVideos" | "recentActivity" | "recentPosts" | "recentUploads" | "singlePlaylist" | "subscriptions" | "upcomingEvents"
Defined in
CommentParts
Ƭ CommentParts: ("id" | "snippet")[]
Defined in
CommentResolvable
Ƭ CommentResolvable: string | Comment
An ID or object of a comment.
Defined in
CommentThreadParts
Ƭ CommentThreadParts: ("id" | "replies" | "snippet")[]
Defined in
EntitySearchOptions
Ƭ EntitySearchOptions<T>: Object
Type parameters
| Name | Type |
|---|---|
T | extends SearchType = SearchType |
Type declaration
| Name | Type |
|---|---|
pageOptions? | PageOptions |
searchFilters? | Omit<SearchFilters<T>, "types"> |
Defined in
GenericSearchOptions
Ƭ GenericSearchOptions<T>: Object
Type parameters
| Name | Type |
|---|---|
T | extends SearchType = SearchType |
Type declaration
| Name | Type |
|---|---|
pageOptions? | PageOptions |
searchFilters? | SearchFilters<T> |
Defined in
Image
Ƭ Image: Object
Type declaration
| Name | Type |
|---|---|
data | Buffer |
type | "jpeg" | "png" |
Defined in
ItemReturns
Ƭ ItemReturns<T, K>: T extends any[] ? InstanceType<K>[] : InstanceType<K>
Type parameters
| Name | Type |
|---|---|
T | extends any | any[] |
K | extends ItemTypes |
Defined in
ItemTypes
Ƭ ItemTypes: typeof GETTABLE_CLASSES[number]
Defined in
PageOptions
Ƭ PageOptions: Object
Type declaration
| Name | Type |
|---|---|
maxPerPage? | number |
pageToken? | string |
pages? | number |
Defined in
PaginatedInstance
Ƭ PaginatedInstance: InstanceType<PaginatedType>
Defined in
PaginatedResponse
Ƭ PaginatedResponse<T>: Object
Type parameters
| Name | Type |
|---|---|
T | extends PaginatedInstance |
Type declaration
| Name | Type |
|---|---|
items | T[] |
nextPageToken? | string |
prevPageToken? | string |
Defined in
PaginatedType
Ƭ PaginatedType: typeof PAGINATED_CLASSES[number]
Defined in
PlaylistItemParts
Ƭ PlaylistItemParts: ("contentDetails" | "id" | "snippet" | "status")[]
Defined in
PlaylistParts
Ƭ PlaylistParts: ("contentDetails" | "id" | "localizations" | "player" | "snippet" | "status")[]
Defined in
PlaylistResolvable
Ƭ PlaylistResolvable: string | Playlist
A URL, ID, search query, or object of a playlist.
Defined in
PlaylistSearchOptions
Ƭ PlaylistSearchOptions: Object
Type declaration
| Name | Type |
|---|---|
channel? | ChannelResolvable |
Defined in
types/GetPaginatedItems.ts:124
Resolvable
Ƭ Resolvable<T>: string | InstanceType<T>
Type parameters
| Name | Type |
|---|---|
T | extends PaginatedType |
Defined in
SearchFilters
Ƭ SearchFilters<T>: { order?: "date" | "rating" | "relevance" | "title" | "videoCount" | "viewCount" ; types?: T[] } & T extends typeof Video ? VideoSearchOptions : T extends typeof Playlist ? PlaylistSearchOptions : T extends typeof Channel ? ChannelSearchOptions : {}
Type parameters
| Name | Type |
|---|---|
T | extends SearchType = SearchType |
Defined in
SearchType
Ƭ SearchType: typeof Video | typeof Playlist | typeof Channel
Defined in
SubscriptionParts
Ƭ SubscriptionParts: ("contentDetails" | "id" | "snippet" | "subscriberSnippet")[]
Defined in
SubscriptionResolvable
Ƭ SubscriptionResolvable: string | Subscription
An ID or object of a subscription.
Defined in
Thumbnail
Ƭ Thumbnail: Object
Type declaration
| Name | Type |
|---|---|
height? | number |
url? | string |
width? | number |
Defined in
VideoCategoryResolvable
Ƭ VideoCategoryResolvable: string | VideoCategory
An ID or object of a video category.
Defined in
VideoParts
Ƭ VideoParts: ("contentDetails" | "fileDetails" | "id" | "liveStreamingDetails" | "localizations" | "player" | "processingDetails" | "recordingDetails" | "snippet" | "statistics" | "status" | "suggestions" | "topicDetails")[]
Defined in
VideoResolvable
Ƭ VideoResolvable: string | Video
A URL, ID, search query, or object of a video.
Defined in
VideoSearchOptions
Ƭ VideoSearchOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
channel? | ChannelResolvable | - |
eventType? | "completed" | "live" | "upcoming" | - |
location? | string | Latitude and longitude coordinates in the format (37.42307,-122.08427). |
locationRadius? | string | Units are m, km, ft, and mi. E.g. 5km. No larger than 1000km |
videoCaption? | "any" | "closedCaption" | "none" | - |
videoCategory? | VideoCategoryResolvable | - |
videoEmbeddable? | boolean | - |
videoType? | "any" | "episode" | "movie" | - |
Defined in
types/GetPaginatedItems.ts:104
VideoUpdateResource
Ƭ VideoUpdateResource: Object
Type declaration
| Name | Type |
|---|---|
id | string |
localizations? | { [key: string]: { description: string ; title: string }; } |
recordingDetails? | { recordingDate?: Date | string } |
recordingDetails.recordingDate? | Date | string |
snippet? | { categoryId: string ; defaultLanguage?: string ; description?: string ; tags?: string[] | string ; title: string } |
snippet.categoryId | string |
snippet.defaultLanguage? | string |
snippet.description? | string |
snippet.tags? | string[] | string |
snippet.title | string |
status? | { embeddable?: boolean ; license?: string ; privacyStatus?: "private" | "public" | "unlisted" ; publicStatsViewable?: boolean ; publishAt?: Date | string ; selfDeclaredMadeForKids?: boolean } |
status.embeddable? | boolean |
status.license? | string |
status.privacyStatus? | "private" | "public" | "unlisted" |
status.publicStatsViewable? | boolean |
status.publishAt? | Date | string |
status.selfDeclaredMadeForKids? | boolean |
Defined in
types/VideoUpdateResource.ts:1
YouTubeOptions
Ƭ YouTubeOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
cache? | boolean | Whether or not to cache entities. |
cacheCheckInterval? | number | How often to check for and delete expired cached items in seconds. |
cacheSearches? | boolean | Whether or not we should cache searches |
cacheTTL? | number | How long to cache entities in seconds (0 = unlimited). |
request? | Request | A custom internal request object to use instead of the default one. |
Defined in
Variables
GETTABLE_CLASSES
• Const GETTABLE_CLASSES: (typeof Video | typeof Channel | typeof Playlist | typeof Comment | typeof Subscription | typeof VideoCategory | typeof ChannelSection | typeof Caption)[]