mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-16 19:12:24 +00:00
74659fd03f
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
33 KiB
33 KiB
youtubei.js / Helpers / YTNode
Class: YTNode
Extended by
ChildElementAboutChannelAboutChannelViewAccountChannelAccountItemSectionAccountItemSectionHeaderAccountSectionListAppendContinuationItemsActionOpenPopupActionUpdateEngagementPanelActionAlertAlertWithButtonAnalyticsMainAppKeyMetricsAnalyticsRootAnalyticsShortsCarouselCardAnalyticsVideoAnalyticsVodCarouselCardCtaGoToCreatorStudioDataModelSectionStatRowAttributionViewAudioOnlyPlayabilityAutomixPreviewVideoAvatarViewBackstageImageBackstagePostBackstagePostThreadBadgeViewBrowseFeedActionsBrowserMediaSessionButtonButtonViewC4TabbedHeaderCallToActionButtonCardCardCollectionCarouselHeaderCarouselItemCarouselLockupChannelChannelAboutFullMetadataChannelAgeGateChannelExternalLinkViewChannelFeaturedContentChannelHeaderLinksChannelHeaderLinksViewChannelMetadataChannelMobileHeaderChannelOptionsChannelOwnerEmptyStateChannelSubMenuChannelTaglineChannelThumbnailWithLinkChannelVideoPlayerChapterChildVideoChipBarViewChipCloudChipCloudChipChipViewClipAdStateClipCreationClipCreationScrubberClipCreationTextInputClipSectionCollaboratorInfoCardContentCollageHeroImageCollectionThumbnailViewAuthorCommentBadgeCommentCommentActionButtonsCommentDialogCommentRepliesCommentReplyDialogCommentsEntryPointHeaderCommentsEntryPointTeaserCommentsHeaderCommentSimpleboxCommentsSimpleboxCommentThreadCommentViewCreatorHeartEmojiPickerPdgCommentChipSponsorCommentBadgeCompactChannelCompactLinkCompactMovieCompactStationCompactVideoConfirmDialogContentMetadataViewContentPreviewImageViewContinuationItemConversationBarCopyLinkCreatePlaylistDialogDecoratedAvatarViewDecoratedPlayerBarDefaultPromoPanelDescriptionPreviewViewDidYouMeanDislikeButtonViewDownloadButtonDropdownDropdownItemDynamicTextViewElementEmergencyOneboxEmojiPickerCategoryEmojiPickerCategoryButtonEmojiPickerUpsellCategoryEndscreenEndscreenElementEndScreenPlaylistEndScreenVideoEngagementPanelSectionListEngagementPanelTitleHeaderEomSettingsDisclaimerExpandableMetadataExpandableTabExpandableVideoDescriptionBodyExpandedShelfContentsFactoidFancyDismissibleDialogFeedFilterChipBarFeedNudgeFeedTabbedHeaderFlexibleActionsViewGameCardGameDetailsGridGridChannelGridHeaderGridMixGridMovieGridPlaylistGridShowGridVideoGuideCollapsibleEntryGuideCollapsibleSectionEntryGuideEntryGuideSectionHashtagHeaderHashtagTileHeatmapHeatMarkerHeroPlaylistThumbnailHighlightsCarouselHorizontalCardListHorizontalListHorizontalMovieListIconLinkImageBannerViewIncludingResultsForInfoPanelContainerInfoPanelContentInfoRowInteractiveTabbedHeaderItemSectionItemSectionHeaderItemSectionTabItemSectionTabbedHeaderLikeButtonLikeButtonViewLiveChatAddBannerToLiveChatCommandAddChatItemActionAddLiveChatTickerItemActionDimChatItemActionLiveChatAutoModMessageLiveChatBannerLiveChatBannerHeaderLiveChatBannerPollLiveChatMembershipItemLiveChatPaidMessageLiveChatPaidStickerLiveChatPlaceholderItemLiveChatProductItemLiveChatRestrictedParticipationLiveChatTickerPaidMessageItemLiveChatTickerSponsorItemPollHeaderLiveChatActionPanelMarkChatItemAsDeletedActionMarkChatItemsByAuthorAsDeletedActionRemoveBannerForLiveChatCommandRemoveChatItemActionRemoveChatItemByAuthorActionReplaceChatItemActionReplayChatItemActionShowLiveChatActionPanelActionShowLiveChatDialogActionShowLiveChatTooltipCommandUpdateDateTextActionUpdateDescriptionActionUpdateLiveChatPollActionUpdateTitleActionUpdateToggleButtonTextActionUpdateViewershipActionLiveChatDialogLiveChatHeaderLiveChatItemListLiveChatMessageInputLiveChatParticipantLiveChatParticipantsListLockupMetadataViewLockupViewMacroMarkersInfoItemMacroMarkersListMacroMarkersListItemMenuMenuPopupMenuServiceItemDownloadMultiPageMenuMultiPageMenuNotificationSectionMusicMenuItemDividerMusicMultiSelectMenuMusicMultiSelectMenuItemSimpleMenuHeaderMerchandiseItemMerchandiseShelfMessageMetadataBadgeMetadataRowMetadataRowContainerMetadataRowHeaderMetadataScreenMicroformatDataModalWithTitleAndButtonMovieMovingThumbnailMultiMarkersPlayerBarMusicCardShelfMusicCardShelfHeaderBasicMusicCarouselShelfMusicCarouselShelfBasicHeaderMusicDescriptionShelfMusicDetailHeaderMusicDownloadStateBadgeMusicEditablePlaylistDetailHeaderMusicElementHeaderMusicHeaderMusicImmersiveHeaderMusicInlineBadgeMusicItemThumbnailOverlayMusicLargeCardItemCarouselMusicMultiRowListItemMusicNavigationButtonMusicPlayButtonMusicPlaylistEditHeaderMusicPlaylistShelfMusicQueueMusicResponsiveHeaderMusicResponsiveListItemMusicResponsiveListItemFixedColumnMusicResponsiveListItemFlexColumnMusicShelfMusicSideAlignedItemMusicSortFilterButtonMusicTastebuilderShelfMusicTastebuilderShelfThumbnailMusicThumbnailMusicTwoRowItemMusicVisualHeaderNavigationEndpointNotificationPageHeaderPageHeaderViewPageIntroductionPivotButtonPlayerAnnotationsExpandedPlayerCaptionsTracklistPlayerControlsOverlayPlayerErrorMessagePlayerLegacyDesktopYpcOfferPlayerLegacyDesktopYpcTrailerPlayerLiveStoryboardSpecPlayerMicroformatPlayerOverflowPlayerOverlayPlayerOverlayAutoplayPlayerStoryboardSpecPlaylistPlaylistCustomThumbnailPlaylistHeaderPlaylistInfoCardContentPlaylistMetadataPlaylistPanelPlaylistPanelVideoPlaylistPanelVideoWrapperPlaylistSidebarPlaylistSidebarPrimaryInfoPlaylistSidebarSecondaryInfoPlaylistVideoPlaylistVideoListPlaylistVideoThumbnailPollPostMultiImageProductListProductListHeaderProductListItemProfileColumnProfileColumnStatsProfileColumnStatsEntryProfileColumnUserInfoQuizRecognitionShelfReelItemReelPlayerHeaderReelPlayerOverlayReelShelfRelatedChipCloudRichGridRichItemRichListHeaderRichMetadataRichMetadataRowRichSectionRichShelfSearchBoxSearchFilterSearchFilterGroupSearchFilterOptionsDialogSearchHeaderSearchRefinementCardSearchSubMenuSearchSuggestionSearchSuggestionsSectionSecondarySearchContainerSectionListSegmentedLikeDislikeButtonSegmentedLikeDislikeButtonViewSettingBooleanSettingsCheckboxSettingsOptionsSettingsSidebarSettingsSwitchSharedPostShelfShortsLockupViewShowCustomThumbnailShowingResultsForSimpleCardContentSimpleCardTeaserSimpleTextSectionSingleActionEmergencySupportSingleColumnBrowseResultsSingleColumnMusicWatchNextResultsSingleHeroImageSlimOwnerSlimVideoMetadataSortFilterHeaderSortFilterSubMenuStructuredDescriptionContentStructuredDescriptionPlaylistLockupSubFeedOptionSubFeedSelectorSubscribeButtonSubscriptionNotificationToggleButtonTabTabbedTabbedSearchResultsTextHeaderThumbnailBadgeViewThumbnailHoverOverlayViewThumbnailLandscapePortraitThumbnailOverlayBadgeViewThumbnailOverlayBottomPanelThumbnailOverlayEndorsementThumbnailOverlayHoverTextThumbnailOverlayInlineUnplayableThumbnailOverlayLoadingPreviewThumbnailOverlayNowPlayingThumbnailOverlayPinkingThumbnailOverlayPlaybackStatusThumbnailOverlayResumePlaybackThumbnailOverlaySidePanelThumbnailOverlayTimeStatusThumbnailOverlayToggleButtonThumbnailViewTimedMarkerDecorationTitleAndButtonListHeaderToggleButtonToggleButtonViewToggleMenuServiceItemTooltipTopicChannelDetailsTranscriptTranscriptFooterTranscriptSearchBoxTranscriptSearchPanelTranscriptSectionHeaderTranscriptSegmentTranscriptSegmentListTwoColumnBrowseResultsTwoColumnSearchResultsTwoColumnWatchNextResultsUniversalWatchCardUploadTimeFactoidUpsellDialogVerticalListVerticalWatchCardListVideoVideoAttributesSectionViewVideoAttributeViewVideoDescriptionCourseSectionVideoDescriptionHeaderVideoDescriptionInfocardsSectionVideoDescriptionMusicSectionVideoDescriptionTranscriptSectionVideoInfoCardContentVideoOwnerVideoPrimaryInfoVideoSecondaryInfoViewCountFactoidWatchCardCompactVideoWatchCardHeroVideoWatchCardRichHeaderWatchCardSectionSequenceWatchNextEndScreenYpcTrailerAnchoredSectionKidsBlocklistPickerKidsBlocklistPickerItemKidsCategoriesHeaderKidsCategoryTabKidsHomeScreenItemSectionContinuationNavigateActionShowMiniplayerCommandReloadContinuationItemsCommandSectionListContinuationMusicPlaylistShelfContinuationMusicShelfContinuationGridContinuationPlaylistPanelContinuationContinuationLiveChatContinuationContinuationCommand
Constructors
new YTNode()
new YTNode():
YTNode
Returns
Defined in
Properties
type
readonlytype:string
Defined in
type
readonlystatictype:string='YTNode'
Defined in
Methods
as()
as<
T,K>(...types):InstanceType<K[number]>
Cast to one of the given types.
Type Parameters
• T extends YTNode
• K extends YTNodeConstructor<T>[]
Parameters
• ...types: K
Returns
InstanceType<K[number]>
Defined in
hasKey()
hasKey<
T,R>(key):this is YTNode & { [k in string]: R }
Check for a key without asserting the type.
Type Parameters
• T extends string
• R = any
Parameters
• key: T
The key to check
Returns
this is YTNode & { [k in string]: R }
Whether the node has the key
Defined in
is()
is<
T,K>(...types):this is InstanceType<K[number]>
Check if the node is of the given type.
Type Parameters
• T extends YTNode
• K extends YTNodeConstructor<T>[]
Parameters
• ...types: K
The type to check
Returns
this is InstanceType<K[number]>
whether the node is of the given type
Defined in
key()
key<
T,R>(key):Maybe
Assert that the node has the given key and return it.
Type Parameters
• T extends string
• R = any
Parameters
• key: T
The key to check
Returns
The value of the key wrapped in a Maybe
Throws
If the node does not have the key