From 0733f60b57877f6b8b87dfd5cc6195b5085f5c09 Mon Sep 17 00:00:00 2001 From: Luan Date: Sun, 12 Oct 2025 12:03:26 -0300 Subject: [PATCH] chore: Use latest version of `typedoc-plugin-markdown` --- docs/api/README.md | 453 ++----- docs/api/classes/Actions.md | 116 +- docs/api/classes/Continuation.md | 138 ++- docs/api/classes/ContinuationCommand.md | 130 +- docs/api/classes/EventEmitter.md | 122 +- docs/api/classes/GridContinuation.md | 142 ++- docs/api/classes/HTTPClient.md | 84 +- docs/api/classes/Innertube.md | 552 ++++----- docs/api/classes/ItemSectionContinuation.md | 132 +- docs/api/classes/LiveChatContinuation.md | 184 +-- .../classes/MusicPlaylistShelfContinuation.md | 132 +- docs/api/classes/MusicShelfContinuation.md | 132 +- docs/api/classes/NavigateAction.md | 128 +- docs/api/classes/OAuth2.md | 134 +-- docs/api/classes/Platform.md | 28 +- docs/api/classes/Player.md | 166 +-- docs/api/classes/PlaylistPanelContinuation.md | 132 +- .../classes/ReloadContinuationItemsCommand.md | 136 ++- docs/api/classes/SectionListContinuation.md | 132 +- docs/api/classes/Session.md | 492 ++++---- docs/api/classes/ShowMiniplayerCommand.md | 132 +- docs/api/classes/UniversalCache.md | 82 +- docs/api/enumerations/ClientType.md | 54 +- docs/api/interfaces/ApiResponse.md | 16 +- docs/api/interfaces/HTTPClientInit.md | 6 +- .../api/namespaces/APIResponseTypes/README.md | 63 - .../interfaces/IBotguardChallenge.md | 53 - .../APIResponseTypes/interfaces/IEndpoint.md | 35 - .../interfaces/IParsedResponse.md | 521 -------- .../interfaces/IPlayabilityStatus.md | 53 - .../interfaces/IPlaybackTracking.md | 23 - .../interfaces/IPlayerConfig.md | 73 -- .../interfaces/IRawBotguardChallenge.md | 53 - .../interfaces/IRawPlayerConfig.md | 73 -- .../interfaces/IRawResponse.md | 497 -------- .../interfaces/IRawTrustedResource.md | 23 - .../interfaces/IStreamingData.md | 63 - .../interfaces/ITrustedResource.md | 23 - .../AddToPlaylistServiceRequest.md | 27 - .../type-aliases/BrowseRequest.md | 39 - .../BrowseRequestSupportedMetadata.md | 23 - .../type-aliases/ContinuationRequest.md | 31 - .../type-aliases/CreateCommentRequest.md | 63 - .../CreatePlaylistServiceRequest.md | 35 - .../DeletePlaylistServiceRequest.md | 15 - .../type-aliases/FeedbackContext.md | 15 - .../type-aliases/FeedbackRequest.md | 27 - .../APIResponseTypes/type-aliases/FormData.md | 31 - .../GetAccountsListInnertubeRequest.md | 43 - .../GetKidsBlocklistPickerRequest.md | 19 - .../type-aliases/IBrowseResponse.md | 9 - .../type-aliases/IGetChallengeResponse.md | 9 - .../IGetNotificationsMenuResponse.md | 9 - .../type-aliases/IGetTranscriptResponse.md | 9 - .../type-aliases/IGuideResponse.md | 9 - .../type-aliases/INextResponse.md | 9 - .../type-aliases/IPlayerResponse.md | 9 - .../type-aliases/IResolveURLResponse.md | 9 - .../type-aliases/ISearchResponse.md | 9 - .../type-aliases/IUpdatedMetadataResponse.md | 9 - .../type-aliases/InlineSettingStatus.md | 9 - .../type-aliases/LikeRequest.md | 19 - .../type-aliases/LikeTarget.md | 15 - .../LiveChatItemContextMenuRequest.md | 15 - ...ifyChannelNotificationPreferenceRequest.md | 19 - .../type-aliases/NextNavendpoint.md | 19 - .../PerformCommentActionRequest.md | 15 - .../type-aliases/PlaylistEditRequest.md | 23 - .../type-aliases/PlaylistPrivacyStatus.md | 9 - .../APIResponseTypes/type-aliases/RawData.md | 9 - .../APIResponseTypes/type-aliases/RawNode.md | 9 - .../type-aliases/ReelWatchRequest.md | 43 - .../type-aliases/SearchRequest.md | 27 - .../type-aliases/ShareEntityServiceRequest.md | 19 - .../type-aliases/SubscribeRequest.md | 31 - .../type-aliases/UnsubscribeRequest.md | 23 - .../type-aliases/WatchNextRequest.md | 35 - .../type-aliases/WatchRequest.md | 51 - .../BinarySerializer/functions/deserialize.md | 21 - .../BinarySerializer/functions/serialize.md | 17 - .../variables/MAGIC_HEADER.md | 9 - .../BinarySerializer/variables/VERSION.md | 9 - docs/api/namespaces/Clients/classes/Kids.md | 116 -- docs/api/namespaces/Clients/classes/Music.md | 251 ---- docs/api/namespaces/Clients/classes/Studio.md | 89 -- .../namespaces/Constants/variables/OAUTH.md | 23 - .../Constants/variables/SUPPORTED_CLIENTS.md | 9 - .../FormatUtils/functions/chooseFormat.md | 25 - .../FormatUtils/functions/download.md | 27 - .../FormatUtils/functions/toDash.md | 35 - .../Generator/functions/camelToSnake.md | 17 - .../functions/generateTypescriptClass.md | 27 - .../Generator/functions/introspect.md | 31 - .../Generator/functions/isIgnoredKey.md | 23 - .../Generator/functions/isMiscType.md | 27 - .../Generator/functions/isRenderer.md | 23 - .../Generator/functions/isRendererList.md | 24 - .../Generator/functions/mergeKeyInfo.md | 35 - .../namespaces/Generator/functions/parse.md | 35 - .../Generator/functions/toParser.md | 35 - .../Generator/functions/toTypeDeclaration.md | 27 - .../interfaces/ObjectInferenceType.md | 33 - .../interfaces/PrimitiveInferenceType.md | 33 - .../interfaces/RendererInferenceType.md | 33 - .../type-aliases/ArrayInferenceType.md | 9 - .../Generator/type-aliases/InferenceType.md | 9 - .../Generator/type-aliases/KeyInfo.md | 9 - .../type-aliases/MiscInferenceType.md | 9 - docs/api/namespaces/Helpers/classes/Maybe.md | 605 ---------- .../Helpers/classes/SuperParsedResult.md | 97 -- .../Helpers/interfaces/Constructor.md | 25 - .../Helpers/interfaces/YTNodeConstructor.md | 35 - .../JsHelpers/functions/getNodeSourceRange.md | 23 - .../JsHelpers/functions/memberBaseName.md | 25 - .../JsHelpers/functions/memberToString.md | 25 - .../JsHelpers/type-aliases/AstVisitFn.md | 21 - .../JsHelpers/type-aliases/AstVisitResult.md | 9 - .../JsHelpers/type-aliases/AstVisitor.md | 9 - .../JsHelpers/variables/WALK_STOP.md | 9 - .../namespaces/JsHelpers/variables/indent.md | 9 - .../JsHelpers/variables/jsBuiltIns.md | 9 - .../JsMatchers/functions/nMatcher.md | 17 - .../JsMatchers/functions/sigMatcher.md | 17 - .../JsMatchers/functions/timestampMatcher.md | 17 - docs/api/namespaces/LZW/functions/compress.md | 21 - .../namespaces/LZW/functions/decompress.md | 21 - docs/api/namespaces/Log/functions/debug.md | 19 - docs/api/namespaces/Log/functions/error.md | 19 - docs/api/namespaces/Log/functions/info.md | 19 - docs/api/namespaces/Log/functions/setLevel.md | 17 - docs/api/namespaces/Log/functions/warn.md | 19 - docs/api/namespaces/Log/functions/warnOnce.md | 19 - .../Managers/classes/AccountManager.md | 77 -- .../Managers/classes/InteractionManager.md | 234 ---- .../Managers/classes/PlaylistManager.md | 323 ----- .../Misc/classes/AccessibilityContext.md | 31 - .../Misc/classes/AccessibilityData.md | 51 - docs/api/namespaces/Misc/classes/Author.md | 131 -- .../namespaces/Misc/classes/ChildElement.md | 231 ---- .../namespaces/Misc/classes/CommandContext.md | 121 -- docs/api/namespaces/Misc/classes/EmojiRun.md | 85 -- docs/api/namespaces/Misc/classes/Format.md | 527 -------- .../Misc/classes/RendererContext.md | 41 - .../Misc/classes/SubscriptionButton.md | 61 - docs/api/namespaces/Misc/classes/Text.md | 155 --- docs/api/namespaces/Misc/classes/TextRun.md | 195 --- docs/api/namespaces/Misc/classes/Thumbnail.md | 71 -- .../namespaces/Misc/classes/VideoDetails.md | 221 ---- docs/api/namespaces/Mixins/classes/Feed.md | 306 ----- .../Mixins/classes/FilterableFeed.md | 423 ------- .../namespaces/Mixins/classes/MediaInfo.md | 456 ------- .../namespaces/Mixins/classes/TabbedFeed.md | 451 ------- .../Parser/functions/addRuntimeParser.md | 19 - .../functions/applyCommentsMutations.md | 19 - .../Parser/functions/applyMutations.md | 19 - .../Parser/functions/getDynamicParsers.md | 13 - .../namespaces/Parser/functions/hasParser.md | 17 - docs/api/namespaces/Parser/functions/parse.md | 87 -- .../namespaces/Parser/functions/parseArray.md | 71 -- .../api/namespaces/Parser/functions/parseC.md | 17 - .../Parser/functions/parseCommands.md | 23 - .../Parser/functions/parseFormats.md | 19 - .../namespaces/Parser/functions/parseItem.md | 71 -- .../namespaces/Parser/functions/parseLC.md | 17 - .../namespaces/Parser/functions/parseRR.md | 17 - .../Parser/functions/parseResponse.md | 25 - .../Parser/functions/sanitizeClassName.md | 17 - .../Parser/functions/setParserErrorHandler.md | 17 - .../Parser/functions/shouldIgnore.md | 17 - .../Parser/type-aliases/ParserError.md | 15 - .../Parser/type-aliases/ParserErrorHandler.md | 17 - .../ProtoUtils/functions/decodeVisitorData.md | 17 - .../functions/encodeCommentActionParams.md | 19 - .../ProtoUtils/functions/encodeNextParams.md | 19 - .../ProtoUtils/functions/encodeVisitorData.md | 19 - .../type-aliases/CommentActionParamsArgs.md | 27 - .../namespaces/Types/classes/JsAnalyzer.md | 83 -- .../namespaces/Types/classes/JsExtractor.md | 48 - .../Types/interfaces/AnalyzerOptions.md | 15 - .../Types/interfaces/BuildScriptResult.md | 39 - .../Types/interfaces/EmitterOptions.md | 67 -- .../Types/interfaces/ExtractionConfig.md | 61 - .../Types/interfaces/ExtractionState.md | 73 -- .../Types/interfaces/FormatOptions.md | 116 -- .../Types/interfaces/GetVideoInfoOptions.md | 32 - .../api/namespaces/Types/interfaces/ICache.md | 69 -- .../Types/interfaces/ICacheConstructor.md | 23 - .../Types/interfaces/PlatformShim.md | 343 ------ .../interfaces/SideEffectPolicyOptions.md | 16 - .../Types/interfaces/VariableMetadata.md | 53 - .../namespaces/Types/type-aliases/Duration.md | 9 - .../Types/type-aliases/EngagementType.md | 9 - .../Types/type-aliases/EvalResult.md | 9 - .../Types/type-aliases/ExtractionMatch.md | 9 - .../namespaces/Types/type-aliases/Feature.md | 9 - .../Types/type-aliases/FetchFunction.md | 9 - .../Types/type-aliases/FormatFilter.md | 17 - .../Types/type-aliases/InnerTubeClient.md | 9 - .../Types/type-aliases/InnerTubeConfig.md | 9 - .../Types/type-aliases/MusicSearchFilters.md | 15 - .../Types/type-aliases/MusicSearchType.md | 9 - .../namespaces/Types/type-aliases/Runtime.md | 9 - .../Types/type-aliases/SearchFilters.md | 31 - .../Types/type-aliases/SearchType.md | 9 - .../Types/type-aliases/SideEffectMode.md | 9 - .../namespaces/Types/type-aliases/SortBy.md | 9 - .../Types/type-aliases/URLTransformer.md | 17 - .../UpdateVideoMetadataOptions.md | 47 - .../Types/type-aliases/UploadDate.md | 9 - .../UploadedVideoMetadataOptions.md | 27 - .../Types/type-aliases/VMPrimative.md | 9 - .../namespaces/Utils/functions/base64ToU8.md | 17 - .../namespaces/Utils/functions/concatMemos.md | 17 - .../namespaces/Utils/functions/debugFetch.md | 41 - .../namespaces/Utils/functions/deepCompare.md | 22 - .../Utils/functions/escapeStringRegexp.md | 17 - .../Utils/functions/generateRandomString.md | 19 - .../Utils/functions/generateSidAuth.md | 21 - .../namespaces/Utils/functions/getCookie.md | 21 - .../Utils/functions/getRandomUserAgent.md | 21 - .../functions/getStringBetweenStrings.md | 29 - .../api/namespaces/Utils/functions/hasKeys.md | 25 - .../namespaces/Utils/functions/isTextRun.md | 17 - .../Utils/functions/streamToIterable.md | 17 - .../Utils/functions/throwIfMissing.md | 17 - .../Utils/functions/timeToSeconds.md | 21 - .../namespaces/Utils/functions/u8ToBase64.md | 17 - .../Utils/type-aliases/DeviceCategory.md | 9 - docs/api/namespaces/YT/classes/AccountInfo.md | 45 - docs/api/namespaces/YT/classes/Channel.md | 1064 ----------------- .../YT/classes/ChannelListContinuation.md | 371 ------ docs/api/namespaces/YT/classes/Comments.md | 133 --- .../YT/classes/FilteredChannelList.md | 467 -------- docs/api/namespaces/YT/classes/Guide.md | 45 - docs/api/namespaces/YT/classes/HashtagFeed.md | 465 ------- docs/api/namespaces/YT/classes/History.md | 401 ------- docs/api/namespaces/YT/classes/HomeFeed.md | 467 -------- docs/api/namespaces/YT/classes/ItemMenu.md | 87 -- docs/api/namespaces/YT/classes/Library.md | 449 ------- docs/api/namespaces/YT/classes/LiveChat.md | 565 --------- .../YT/classes/NotificationsMenu.md | 71 -- docs/api/namespaces/YT/classes/Playlist.md | 471 -------- docs/api/namespaces/YT/classes/Search.md | 467 -------- docs/api/namespaces/YT/classes/Settings.md | 139 --- .../namespaces/YT/classes/SmoothedQueue.md | 153 --- .../namespaces/YT/classes/TranscriptInfo.md | 101 -- docs/api/namespaces/YT/classes/VideoInfo.md | 891 -------------- docs/api/namespaces/YTKids/classes/Channel.md | 381 ------ .../api/namespaces/YTKids/classes/HomeFeed.md | 417 ------- docs/api/namespaces/YTKids/classes/Search.md | 379 ------ docs/api/namespaces/YTMusic/classes/Album.md | 85 -- docs/api/namespaces/YTMusic/classes/Artist.md | 71 -- .../api/namespaces/YTMusic/classes/Explore.md | 55 - .../namespaces/YTMusic/classes/HomeFeed.md | 119 -- .../api/namespaces/YTMusic/classes/Library.md | 155 --- .../YTMusic/classes/LibraryContinuation.md | 75 -- .../namespaces/YTMusic/classes/Playlist.md | 145 --- docs/api/namespaces/YTMusic/classes/Recap.md | 73 -- docs/api/namespaces/YTMusic/classes/Search.md | 255 ---- .../YTNodes/classes/AboutChannel.md | 221 ---- .../YTNodes/classes/AboutChannelView.md | 341 ------ .../namespaces/YTNodes/classes/AccountItem.md | 283 ----- .../YTNodes/classes/AccountItemSection.md | 221 ---- .../YTNodes/classes/ActiveAccountHeader.md | 251 ---- .../classes/AddBannerToLiveChatCommand.md | 211 ---- .../YTNodes/classes/AddChatItemAction.md | 221 ---- .../classes/AddLiveChatTickerItemAction.md | 221 ---- .../YTNodes/classes/AddToPlaylistCommand.md | 251 ---- .../classes/AddToPlaylistServiceEndpoint.md | 245 ---- .../YTNodes/classes/AlertWithButton.md | 231 ---- .../YTNodes/classes/AnchoredSection.md | 259 ---- .../classes/AppendContinuationItemsAction.md | 221 ---- .../YTNodes/classes/AuthorCommentBadge.md | 245 ---- .../namespaces/YTNodes/classes/AvatarView.md | 231 ---- .../YTNodes/classes/BackgroundPromo.md | 241 ---- .../YTNodes/classes/BackstagePost.md | 335 ------ .../namespaces/YTNodes/classes/BadgeView.md | 231 ---- .../YTNodes/classes/BrowseEndpoint.md | 241 ---- .../YTNodes/classes/BrowserMediaSession.md | 221 ---- .../classes/BumperUserEduContentView.md | 231 ---- docs/api/namespaces/YTNodes/classes/Button.md | 306 ----- .../YTNodes/classes/ButtonCardView.md | 231 ---- .../namespaces/YTNodes/classes/ButtonView.md | 481 -------- .../YTNodes/classes/C4TabbedHeader.md | 321 ----- .../YTNodes/classes/CallToActionButton.md | 231 ---- docs/api/namespaces/YTNodes/classes/Card.md | 251 ---- .../YTNodes/classes/CardCollection.md | 231 ---- .../YTNodes/classes/CarouselItem.md | 265 ---- .../YTNodes/classes/CarouselItemView.md | 221 ---- .../YTNodes/classes/CarouselLockup.md | 221 ---- .../YTNodes/classes/CarouselTitleView.md | 231 ---- .../ChangeEngagementPanelVisibilityAction.md | 221 ---- .../api/namespaces/YTNodes/classes/Channel.md | 291 ----- .../classes/ChannelAboutFullMetadata.md | 321 ----- .../YTNodes/classes/ChannelAgeGate.md | 261 ---- .../classes/ChannelExternalLinkView.md | 231 ---- .../YTNodes/classes/ChannelHeaderLinksView.md | 221 ---- .../YTNodes/classes/ChannelMetadata.md | 341 ------ .../YTNodes/classes/ChannelOptions.md | 241 ---- .../YTNodes/classes/ChannelOwnerEmptyState.md | 221 ---- .../YTNodes/classes/ChannelSubMenu.md | 221 ---- .../YTNodes/classes/ChannelSwitcherHeader.md | 221 ---- .../YTNodes/classes/ChannelSwitcherPage.md | 221 ---- .../YTNodes/classes/ChannelTagline.md | 261 ---- .../classes/ChannelThumbnailWithLink.md | 245 ---- .../YTNodes/classes/ChannelVideoPlayer.md | 251 ---- .../namespaces/YTNodes/classes/ChildVideo.md | 249 ---- .../namespaces/YTNodes/classes/ChipCloud.md | 241 ---- .../YTNodes/classes/ChipCloudChip.md | 231 ---- .../namespaces/YTNodes/classes/ChipView.md | 241 ---- .../classes/ClientSideToggleMenuItem.md | 293 ----- .../YTNodes/classes/ClipCreation.md | 301 ----- .../YTNodes/classes/ClipCreationScrubber.md | 281 ----- .../YTNodes/classes/ClipCreationTextInput.md | 221 ---- .../namespaces/YTNodes/classes/ClipSection.md | 211 ---- .../classes/CollaboratorInfoCardContent.md | 251 ---- .../YTNodes/classes/CollageHeroImage.md | 241 ---- .../classes/CollectionThumbnailView.md | 229 ---- .../YTNodes/classes/CommentActionButtons.md | 241 ---- .../YTNodes/classes/CommentDialog.md | 271 ----- .../YTNodes/classes/CommentReplies.md | 251 ---- .../YTNodes/classes/CommentReplyDialog.md | 251 ---- .../YTNodes/classes/CommentSimplebox.md | 251 ---- .../YTNodes/classes/CommentThread.md | 315 ----- .../namespaces/YTNodes/classes/CommentView.md | 697 ----------- .../classes/CommentsEntryPointHeader.md | 261 ---- .../classes/CommentsEntryPointTeaser.md | 221 ---- .../YTNodes/classes/CommentsHeader.md | 261 ---- .../YTNodes/classes/CommentsSimplebox.md | 221 ---- .../YTNodes/classes/CompactChannel.md | 291 ----- .../namespaces/YTNodes/classes/CompactLink.md | 261 ---- .../YTNodes/classes/CompactMovie.md | 319 ----- .../YTNodes/classes/CompactStation.md | 251 ---- .../YTNodes/classes/CompactVideo.md | 501 -------- .../YTNodes/classes/ConfirmDialog.md | 241 ---- .../YTNodes/classes/ContentMetadataView.md | 221 ---- .../classes/ContentPreviewImageView.md | 221 ---- .../YTNodes/classes/ContinuationCommand.md | 241 ---- .../YTNodes/classes/ContinuationItem.md | 231 ---- .../namespaces/YTNodes/classes/CopyLink.md | 231 ---- .../YTNodes/classes/CreateCommentEndpoint.md | 241 ---- .../YTNodes/classes/CreatePlaylistDialog.md | 251 ---- .../classes/CreatePlaylistDialogFormView.md | 261 ---- .../classes/CreatePlaylistServiceEndpoint.md | 241 ---- .../YTNodes/classes/CreatorHeart.md | 279 ----- .../YTNodes/classes/CreatorHeartView.md | 293 ----- .../YTNodes/classes/DecoratedAvatarView.md | 231 ---- .../YTNodes/classes/DecoratedPlayerBar.md | 221 ---- .../YTNodes/classes/DefaultPromoPanel.md | 311 ----- .../YTNodes/classes/DeletePlaylistEndpoint.md | 241 ---- .../YTNodes/classes/DescriptionPreviewView.md | 285 ----- .../namespaces/YTNodes/classes/DialogView.md | 231 ---- .../namespaces/YTNodes/classes/DidYouMean.md | 231 ---- .../YTNodes/classes/DislikeButtonView.md | 221 ---- .../YTNodes/classes/DismissableDialog.md | 241 ---- .../DismissableDialogContentSection.md | 221 ---- .../YTNodes/classes/DownloadButton.md | 241 ---- .../YTNodes/classes/DropdownItem.md | 261 ---- .../YTNodes/classes/DropdownView.md | 261 ---- .../YTNodes/classes/DynamicTextView.md | 221 ---- .../YTNodes/classes/EmergencyOnebox.md | 231 ---- .../namespaces/YTNodes/classes/EmojiPicker.md | 331 ----- .../YTNodes/classes/EmojiPickerCategory.md | 251 ---- .../classes/EmojiPickerCategoryButton.md | 231 ---- .../classes/EmojiPickerUpsellCategory.md | 261 ---- .../YTNodes/classes/EndScreenPlaylist.md | 261 ---- .../YTNodes/classes/EndScreenVideo.md | 299 ----- .../YTNodes/classes/EndscreenElement.md | 381 ------ .../classes/EngagementPanelSectionList.md | 269 ----- .../classes/EngagementPanelTitleHeader.md | 241 ---- .../YTNodes/classes/EomSettingsDisclaimer.md | 235 ---- .../YTNodes/classes/ExpandableMetadata.md | 257 ---- .../YTNodes/classes/ExpandableTab.md | 241 ---- .../classes/ExpandableVideoDescriptionBody.md | 231 ---- .../YTNodes/classes/ExpandedShelfContents.md | 225 ---- .../api/namespaces/YTNodes/classes/Factoid.md | 231 ---- .../YTNodes/classes/FancyDismissibleDialog.md | 221 ---- .../namespaces/YTNodes/classes/FeedNudge.md | 261 ---- .../YTNodes/classes/FeedbackEndpoint.md | 241 ---- .../YTNodes/classes/FlexibleActionsView.md | 221 ---- .../YTNodes/classes/FormFooterView.md | 231 ---- .../namespaces/YTNodes/classes/GameDetails.md | 251 ---- .../GetAccountsListInnertubeEndpoint.md | 241 ---- .../classes/GetKidsBlocklistPickerCommand.md | 241 ---- .../YTNodes/classes/GetMultiPageMenuAction.md | 211 ---- docs/api/namespaces/YTNodes/classes/Grid.md | 275 ----- .../namespaces/YTNodes/classes/GridChannel.md | 261 ---- .../api/namespaces/YTNodes/classes/GridMix.md | 291 ----- .../namespaces/YTNodes/classes/GridMovie.md | 281 ----- .../YTNodes/classes/GridPlaylist.md | 311 ----- .../YTNodes/classes/GridShelfView.md | 271 ----- .../namespaces/YTNodes/classes/GridShow.md | 261 ---- .../namespaces/YTNodes/classes/GridVideo.md | 393 ------ .../YTNodes/classes/GuideCollapsibleEntry.md | 231 ---- .../classes/GuideCollapsibleSectionEntry.md | 241 ---- .../YTNodes/classes/GuideDownloadsEntry.md | 295 ----- .../namespaces/YTNodes/classes/GuideEntry.md | 265 ---- .../namespaces/YTNodes/classes/HashtagTile.md | 271 ----- .../YTNodes/classes/HeroPlaylistThumbnail.md | 221 ---- .../classes/HideEngagementPanelEndpoint.md | 211 ---- .../YTNodes/classes/HorizontalCardList.md | 241 ---- .../YTNodes/classes/HorizontalList.md | 235 ---- .../YTNodes/classes/HorizontalMovieList.md | 245 ---- .../classes/HowThisWasMadeSectionView.md | 231 ---- .../namespaces/YTNodes/classes/IconLink.md | 231 ---- .../YTNodes/classes/ImageBannerView.md | 221 ---- .../YTNodes/classes/IncludingResultsFor.md | 261 ---- .../YTNodes/classes/InfoPanelContainer.md | 271 ----- .../YTNodes/classes/InfoPanelContent.md | 291 ----- .../classes/InteractiveTabbedHeader.md | 291 ----- .../namespaces/YTNodes/classes/ItemSection.md | 241 ---- .../YTNodes/classes/ItemSectionTab.md | 231 ---- .../classes/ItemSectionTabbedHeader.md | 231 ---- .../YTNodes/classes/KidsBlocklistPicker.md | 241 ---- .../classes/KidsBlocklistPickerItem.md | 283 ----- .../YTNodes/classes/KidsCategoriesHeader.md | 221 ---- .../YTNodes/classes/KidsCategoryTab.md | 249 ---- .../namespaces/YTNodes/classes/LikeButton.md | 245 ---- .../YTNodes/classes/LikeButtonView.md | 239 ---- .../YTNodes/classes/LikeEndpoint.md | 255 ---- .../YTNodes/classes/ListItemView.md | 251 ---- .../YTNodes/classes/LiveChatActionPanel.md | 231 ---- .../YTNodes/classes/LiveChatAuthorBadge.md | 267 ----- .../YTNodes/classes/LiveChatAutoModMessage.md | 261 ---- .../YTNodes/classes/LiveChatBanner.md | 301 ----- .../classes/LiveChatBannerChatSummary.md | 251 ---- .../YTNodes/classes/LiveChatBannerHeader.md | 231 ---- .../YTNodes/classes/LiveChatBannerPoll.md | 261 ---- .../YTNodes/classes/LiveChatBannerRedirect.md | 241 ---- .../YTNodes/classes/LiveChatDialog.md | 221 ---- .../YTNodes/classes/LiveChatHeader.md | 231 ---- .../YTNodes/classes/LiveChatItemBumperView.md | 211 ---- .../LiveChatItemContextMenuEndpoint.md | 241 ---- .../YTNodes/classes/LiveChatItemList.md | 221 ---- .../YTNodes/classes/LiveChatMembershipItem.md | 301 ----- .../YTNodes/classes/LiveChatMessageInput.md | 241 ---- .../classes/LiveChatModeChangeMessage.md | 271 ----- .../YTNodes/classes/LiveChatPaidMessage.md | 411 ------- .../YTNodes/classes/LiveChatPaidSticker.md | 371 ------ .../YTNodes/classes/LiveChatParticipant.md | 231 ---- .../classes/LiveChatPlaceholderItem.md | 221 ---- .../YTNodes/classes/LiveChatProductItem.md | 341 ------ .../LiveChatRestrictedParticipation.md | 221 ---- ...hatSponsorshipsGiftPurchaseAnnouncement.md | 241 ---- ...tSponsorshipsGiftRedemptionAnnouncement.md | 271 ----- .../classes/LiveChatSponsorshipsHeader.md | 271 ----- .../YTNodes/classes/LiveChatTextMessage.md | 301 ----- .../classes/LiveChatTickerPaidMessageItem.md | 321 ----- .../classes/LiveChatTickerPaidStickerItem.md | 301 ----- .../classes/LiveChatTickerSponsorItem.md | 241 ---- .../LiveChatViewerEngagementMessage.md | 281 ----- .../YTNodes/classes/LockupMetadataView.md | 241 ---- .../namespaces/YTNodes/classes/LockupView.md | 251 ---- .../YTNodes/classes/MacroMarkersInfoItem.md | 221 ---- .../YTNodes/classes/MacroMarkersListEntity.md | 323 ----- .../YTNodes/classes/MacroMarkersListItem.md | 261 ---- .../classes/MarkChatItemAsDeletedAction.md | 221 ---- .../MarkChatItemsByAuthorAsDeletedAction.md | 221 ---- docs/api/namespaces/YTNodes/classes/Menu.md | 269 ----- .../YTNodes/classes/MenuFlexibleItem.md | 221 ---- .../YTNodes/classes/MenuNavigationItem.md | 341 ------ .../YTNodes/classes/MenuServiceItem.md | 341 ------ .../classes/MenuServiceItemDownload.md | 221 ---- .../YTNodes/classes/MerchandiseItem.md | 311 ----- .../YTNodes/classes/MerchandiseShelf.md | 245 ---- .../YTNodes/classes/MetadataBadge.md | 245 ---- .../YTNodes/classes/MetadataRowHeader.md | 221 ---- .../YTNodes/classes/MicroformatData.md | 431 ------- .../YTNodes/classes/MobileTopbar.md | 231 ---- .../classes/ModalWithTitleAndButton.md | 231 ---- ...fyChannelNotificationPreferenceEndpoint.md | 241 ---- docs/api/namespaces/YTNodes/classes/Movie.md | 339 ------ .../YTNodes/classes/MultiPageMenu.md | 231 ---- .../MultiPageMenuNotificationSection.md | 235 ---- .../YTNodes/classes/MusicCardShelf.md | 311 ----- .../YTNodes/classes/MusicCarouselShelf.md | 231 ---- .../classes/MusicCarouselShelfBasicHeader.md | 251 ---- .../YTNodes/classes/MusicDescriptionShelf.md | 241 ---- .../YTNodes/classes/MusicDetailHeader.md | 323 ----- .../classes/MusicDownloadStateBadge.md | 221 ---- .../MusicEditablePlaylistDetailHeader.md | 231 ---- .../YTNodes/classes/MusicElementHeader.md | 211 ---- .../YTNodes/classes/MusicImmersiveHeader.md | 291 ----- .../YTNodes/classes/MusicInlineBadge.md | 235 ---- .../classes/MusicItemThumbnailOverlay.md | 231 ---- .../classes/MusicLargeCardItemCarousel.md | 221 ---- .../YTNodes/classes/MusicMultiRowListItem.md | 291 ----- .../classes/MusicMultiSelectMenuItem.md | 251 ---- .../YTNodes/classes/MusicNavigationButton.md | 221 ---- .../YTNodes/classes/MusicPlayButton.md | 289 ----- .../classes/MusicPlaylistEditHeader.md | 271 ----- .../YTNodes/classes/MusicPlaylistShelf.md | 241 ---- .../YTNodes/classes/MusicResponsiveHeader.md | 291 ----- .../classes/MusicResponsiveListItem.md | 477 -------- .../MusicResponsiveListItemFixedColumn.md | 221 ---- .../MusicResponsiveListItemFlexColumn.md | 221 ---- .../namespaces/YTNodes/classes/MusicShelf.md | 271 ----- .../YTNodes/classes/MusicSortFilterButton.md | 231 ---- .../YTNodes/classes/MusicTastebuilderShelf.md | 251 ---- .../YTNodes/classes/MusicTwoRowItem.md | 363 ------ .../YTNodes/classes/MusicVisualHeader.md | 241 ---- .../YTNodes/classes/NavigationEndpoint.md | 377 ------ .../YTNodes/classes/Notification.md | 291 ----- .../OpenOnePickAddVideoModalCommand.md | 231 ---- .../YTNodes/classes/OpenPopupAction.md | 221 ---- .../namespaces/YTNodes/classes/PageHeader.md | 221 ---- .../YTNodes/classes/PageHeaderView.md | 291 ----- .../YTNodes/classes/PageIntroduction.md | 241 ---- .../YTNodes/classes/PanelFooterView.md | 231 ---- .../YTNodes/classes/PdgCommentChip.md | 239 ---- .../YTNodes/classes/PdgReplyButtonView.md | 231 ---- .../classes/PerformCommentActionEndpoint.md | 241 ---- .../YTNodes/classes/PivotBarItem.md | 275 ----- .../namespaces/YTNodes/classes/PivotButton.md | 271 ----- .../classes/PlayerCaptionsTracklist.md | 241 ---- .../YTNodes/classes/PlayerControlsOverlay.md | 211 ---- .../YTNodes/classes/PlayerErrorMessage.md | 251 ---- .../classes/PlayerLegacyDesktopYpcOffer.md | 241 ---- .../classes/PlayerLegacyDesktopYpcTrailer.md | 291 ----- .../YTNodes/classes/PlayerMicroformat.md | 393 ------ .../YTNodes/classes/PlayerOverlay.md | 291 ----- .../YTNodes/classes/PlayerOverlayAutoplay.md | 331 ----- .../classes/PlayerOverlayVideoDetails.md | 221 ---- .../namespaces/YTNodes/classes/Playlist.md | 347 ------ .../YTNodes/classes/PlaylistAddToOption.md | 271 ----- .../YTNodes/classes/PlaylistEditEndpoint.md | 241 ---- .../YTNodes/classes/PlaylistHeader.md | 371 ------ .../classes/PlaylistInfoCardContent.md | 251 ---- .../YTNodes/classes/PlaylistMetadata.md | 221 ---- .../YTNodes/classes/PlaylistPanel.md | 291 ----- .../YTNodes/classes/PlaylistPanelVideo.md | 345 ------ .../classes/PlaylistPanelVideoWrapper.md | 221 ---- .../YTNodes/classes/PlaylistSidebar.md | 225 ---- .../classes/PlaylistSidebarPrimaryInfo.md | 261 ---- .../classes/PlaylistSidebarSecondaryInfo.md | 221 ---- .../classes/PlaylistThumbnailOverlay.md | 221 ---- .../YTNodes/classes/PlaylistVideo.md | 387 ------ .../YTNodes/classes/PlaylistVideoList.md | 241 ---- docs/api/namespaces/YTNodes/classes/Poll.md | 241 ---- .../namespaces/YTNodes/classes/PollHeader.md | 251 ---- docs/api/namespaces/YTNodes/classes/Post.md | 383 ------ .../YTNodes/classes/PrefetchWatchCommand.md | 237 ---- .../YTNodes/classes/ProductListItem.md | 281 ----- .../YTNodes/classes/ProfileColumnStats.md | 225 ---- .../classes/ProfileColumnStatsEntry.md | 221 ---- .../YTNodes/classes/ProfileColumnUserInfo.md | 221 ---- docs/api/namespaces/YTNodes/classes/Quiz.md | 221 ---- .../YTNodes/classes/RecognitionShelf.md | 251 ---- .../namespaces/YTNodes/classes/ReelItem.md | 275 ----- .../YTNodes/classes/ReelPlayerHeader.md | 251 ---- .../YTNodes/classes/ReelPlayerOverlay.md | 311 ----- .../namespaces/YTNodes/classes/ReelShelf.md | 245 ---- .../YTNodes/classes/ReelWatchEndpoint.md | 241 ---- .../classes/RemoveBannerForLiveChatCommand.md | 211 ---- .../YTNodes/classes/RemoveChatItemAction.md | 211 ---- .../classes/RemoveChatItemByAuthorAction.md | 211 ---- .../YTNodes/classes/ReplaceChatItemAction.md | 221 ---- .../YTNodes/classes/ReplaceLiveChatAction.md | 221 ---- .../YTNodes/classes/ReplayChatItemAction.md | 221 ---- .../YTNodes/classes/RichListHeader.md | 241 ---- .../YTNodes/classes/RichMetadata.md | 261 ---- .../namespaces/YTNodes/classes/RichSection.md | 231 ---- .../namespaces/YTNodes/classes/RichShelf.md | 321 ----- .../YTNodes/classes/RunAttestationCommand.md | 221 ---- .../namespaces/YTNodes/classes/SearchBox.md | 241 ---- .../YTNodes/classes/SearchEndpoint.md | 241 ---- .../YTNodes/classes/SearchFilter.md | 269 ----- .../classes/SearchFilterOptionsDialog.md | 221 ---- .../YTNodes/classes/SearchHeader.md | 221 ---- .../YTNodes/classes/SearchRefinementCard.md | 231 ---- .../YTNodes/classes/SearchSubMenu.md | 231 ---- .../YTNodes/classes/SearchSuggestion.md | 245 ---- .../classes/SecondarySearchContainer.md | 221 ---- .../namespaces/YTNodes/classes/SectionList.md | 251 ---- .../classes/SegmentedLikeDislikeButton.md | 221 ---- .../classes/SegmentedLikeDislikeButtonView.md | 291 ----- .../YTNodes/classes/SettingBoolean.md | 251 ---- .../YTNodes/classes/SettingsCheckbox.md | 251 ---- .../YTNodes/classes/SettingsSidebar.md | 235 ---- .../YTNodes/classes/SettingsSwitch.md | 251 ---- .../classes/ShareEntityServiceEndpoint.md | 246 ---- .../namespaces/YTNodes/classes/ShareTarget.md | 241 ---- .../namespaces/YTNodes/classes/SharedPost.md | 291 ----- docs/api/namespaces/YTNodes/classes/Shelf.md | 271 ----- .../YTNodes/classes/ShortsLockupView.md | 309 ----- .../YTNodes/classes/ShowDialogCommand.md | 221 ---- .../classes/ShowEngagementPanelEndpoint.md | 221 ---- .../classes/ShowLiveChatActionPanelAction.md | 211 ---- .../classes/ShowLiveChatDialogAction.md | 211 ---- .../classes/ShowLiveChatTooltipCommand.md | 211 ---- .../YTNodes/classes/ShowingResultsFor.md | 261 ---- .../YTNodes/classes/SignalServiceEndpoint.md | 221 ---- .../YTNodes/classes/SimpleCardContent.md | 261 ---- .../YTNodes/classes/SimpleCardTeaser.md | 221 ---- .../YTNodes/classes/SimpleMenuHeader.md | 221 ---- .../YTNodes/classes/SimpleTextSection.md | 221 ---- .../classes/SingleActionEmergencySupport.md | 251 ---- .../YTNodes/classes/SingleHeroImage.md | 221 ---- .../namespaces/YTNodes/classes/SlimOwner.md | 241 ---- .../YTNodes/classes/SlimVideoMetadata.md | 271 ----- .../YTNodes/classes/SortFilterHeader.md | 211 ---- .../YTNodes/classes/SortFilterSubMenu.md | 265 ---- .../YTNodes/classes/SponsorCommentBadge.md | 221 ---- .../StructuredDescriptionPlaylistLockup.md | 301 ----- .../YTNodes/classes/SubFeedOption.md | 231 ---- .../YTNodes/classes/SubscribeButton.md | 371 ------ .../YTNodes/classes/SubscribeButtonView.md | 335 ------ .../YTNodes/classes/SubscribeEndpoint.md | 241 ---- .../SubscriptionNotificationToggleButton.md | 243 ---- docs/api/namespaces/YTNodes/classes/Tab.md | 241 ---- .../YTNodes/classes/TextCarouselItemView.md | 241 ---- .../YTNodes/classes/TextFieldView.md | 241 ---- .../YTNodes/classes/ThumbnailBadgeView.md | 249 ---- .../classes/ThumbnailBottomOverlayView.md | 221 ---- .../classes/ThumbnailHoverOverlayView.md | 231 ---- .../classes/ThumbnailLandscapePortrait.md | 221 ---- .../classes/ThumbnailOverlayBadgeView.md | 221 ---- .../classes/ThumbnailOverlayBottomPanel.md | 221 ---- .../classes/ThumbnailOverlayEndorsement.md | 211 ---- .../classes/ThumbnailOverlayHoverText.md | 221 ---- .../ThumbnailOverlayInlineUnplayable.md | 221 ---- .../classes/ThumbnailOverlayLoadingPreview.md | 211 ---- .../classes/ThumbnailOverlayNowPlaying.md | 211 ---- .../classes/ThumbnailOverlayPlaybackStatus.md | 211 ---- .../ThumbnailOverlayProgressBarView.md | 211 ---- .../classes/ThumbnailOverlaySidePanel.md | 221 ---- .../classes/ThumbnailOverlayTimeStatus.md | 221 ---- .../classes/ThumbnailOverlayToggleButton.md | 267 ----- .../YTNodes/classes/TimedMarkerDecoration.md | 251 ---- .../YTNodes/classes/ToggleButton.md | 331 ----- .../YTNodes/classes/ToggleButtonView.md | 251 ---- .../YTNodes/classes/ToggleFormField.md | 241 ---- .../YTNodes/classes/ToggleMenuServiceItem.md | 261 ---- .../api/namespaces/YTNodes/classes/Tooltip.md | 277 ----- .../YTNodes/classes/TopbarMenuButton.md | 231 ---- .../YTNodes/classes/TopicChannelDetails.md | 251 ---- .../YTNodes/classes/TranscriptFooter.md | 211 ---- .../YTNodes/classes/TranscriptSearchBox.md | 241 ---- .../YTNodes/classes/TranscriptSearchPanel.md | 241 ---- .../classes/TranscriptSectionHeader.md | 231 ---- .../YTNodes/classes/TranscriptSegment.md | 251 ---- .../YTNodes/classes/TranscriptSegmentList.md | 241 ---- .../YTNodes/classes/TwoColumnBrowseResults.md | 225 ---- .../YTNodes/classes/TwoColumnSearchResults.md | 241 ---- .../YTNodes/classes/UnifiedSharePanel.md | 241 ---- .../YTNodes/classes/UniversalWatchCard.md | 241 ---- .../YTNodes/classes/UnsubscribeEndpoint.md | 241 ---- .../UpdateChannelSwitcherPageAction.md | 221 ---- .../YTNodes/classes/UpdateDateTextAction.md | 211 ---- .../classes/UpdateDescriptionAction.md | 211 ---- .../classes/UpdateEngagementPanelAction.md | 221 ---- .../UpdateEngagementPanelContentCommand.md | 221 ---- .../classes/UpdateLiveChatPollAction.md | 211 ---- .../classes/UpdateSubscribeButtonAction.md | 221 ---- .../classes/UpdateToggleButtonTextAction.md | 231 ---- .../YTNodes/classes/UpdateViewershipAction.md | 251 ---- .../YTNodes/classes/UpsellDialog.md | 251 ---- .../YTNodes/classes/VerticalList.md | 245 ---- .../YTNodes/classes/VerticalWatchCardList.md | 245 ---- docs/api/namespaces/YTNodes/classes/Video.md | 603 ---------- .../YTNodes/classes/VideoAttributeView.md | 295 ----- .../classes/VideoAttributesSectionView.md | 251 ---- .../namespaces/YTNodes/classes/VideoCard.md | 749 ------------ .../YTNodes/classes/VideoDescriptionHeader.md | 271 ----- .../VideoDescriptionInfocardsSection.md | 261 ---- .../classes/VideoDescriptionMusicSection.md | 221 ---- .../VideoDescriptionTranscriptSection.md | 231 ---- .../YTNodes/classes/VideoInfoCardContent.md | 261 ---- .../classes/VideoMetadataCarouselView.md | 221 ---- .../YTNodes/classes/VideoPrimaryInfo.md | 281 ----- .../YTNodes/classes/VideoSecondaryInfo.md | 291 ----- .../YTNodes/classes/VideoViewCount.md | 241 ---- .../YTNodes/classes/ViewCountFactoid.md | 231 ---- .../classes/VoiceReplyContainerView.md | 221 ---- .../YTNodes/classes/WatchCardCompactVideo.md | 249 ---- .../YTNodes/classes/WatchCardHeroVideo.md | 241 ---- .../YTNodes/classes/WatchCardRichHeader.md | 251 ---- .../YTNodes/classes/WatchEndpoint.md | 245 ---- .../YTNodes/classes/WatchNextEndpoint.md | 241 ---- .../namespaces/YTNodes/classes/YpcTrailer.md | 221 ---- .../YTShorts/classes/ShortFormVideoInfo.md | 595 --------- docs/api/type-aliases/Context.md | 124 +- docs/api/type-aliases/DeviceAndUserCode.md | 30 +- docs/api/type-aliases/InnertubeEndpoint.md | 6 +- .../OAuth2AuthErrorEventHandler.md | 12 +- .../type-aliases/OAuth2AuthEventHandler.md | 14 +- .../OAuth2AuthPendingEventHandler.md | 12 +- docs/api/type-aliases/OAuth2ClientID.md | 14 +- docs/api/type-aliases/OAuth2Tokens.md | 34 +- docs/api/type-aliases/ParsedResponse.md | 10 +- docs/api/type-aliases/SWSessionData.md | 18 +- docs/api/type-aliases/SessionArgs.md | 44 +- docs/api/type-aliases/SessionData.md | 22 +- docs/api/type-aliases/SessionOptions.md | 90 +- package-lock.json | 11 +- package.json | 2 +- 696 files changed, 2256 insertions(+), 131099 deletions(-) delete mode 100644 docs/api/namespaces/APIResponseTypes/README.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IBotguardChallenge.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IEndpoint.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IRawBotguardChallenge.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IRawTrustedResource.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md delete mode 100644 docs/api/namespaces/APIResponseTypes/interfaces/ITrustedResource.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequestSupportedMetadata.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/ContinuationRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackContext.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/FormData.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/LikeRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/LikeTarget.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/NextNavendpoint.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/PerformCommentActionRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistEditRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistPrivacyStatus.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/RawData.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/RawNode.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/ReelWatchRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/SearchRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/ShareEntityServiceRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/SubscribeRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/UnsubscribeRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/WatchNextRequest.md delete mode 100644 docs/api/namespaces/APIResponseTypes/type-aliases/WatchRequest.md delete mode 100644 docs/api/namespaces/BinarySerializer/functions/deserialize.md delete mode 100644 docs/api/namespaces/BinarySerializer/functions/serialize.md delete mode 100644 docs/api/namespaces/BinarySerializer/variables/MAGIC_HEADER.md delete mode 100644 docs/api/namespaces/BinarySerializer/variables/VERSION.md delete mode 100644 docs/api/namespaces/Clients/classes/Kids.md delete mode 100644 docs/api/namespaces/Clients/classes/Music.md delete mode 100644 docs/api/namespaces/Clients/classes/Studio.md delete mode 100644 docs/api/namespaces/Constants/variables/OAUTH.md delete mode 100644 docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md delete mode 100644 docs/api/namespaces/FormatUtils/functions/chooseFormat.md delete mode 100644 docs/api/namespaces/FormatUtils/functions/download.md delete mode 100644 docs/api/namespaces/FormatUtils/functions/toDash.md delete mode 100644 docs/api/namespaces/Generator/functions/camelToSnake.md delete mode 100644 docs/api/namespaces/Generator/functions/generateTypescriptClass.md delete mode 100644 docs/api/namespaces/Generator/functions/introspect.md delete mode 100644 docs/api/namespaces/Generator/functions/isIgnoredKey.md delete mode 100644 docs/api/namespaces/Generator/functions/isMiscType.md delete mode 100644 docs/api/namespaces/Generator/functions/isRenderer.md delete mode 100644 docs/api/namespaces/Generator/functions/isRendererList.md delete mode 100644 docs/api/namespaces/Generator/functions/mergeKeyInfo.md delete mode 100644 docs/api/namespaces/Generator/functions/parse.md delete mode 100644 docs/api/namespaces/Generator/functions/toParser.md delete mode 100644 docs/api/namespaces/Generator/functions/toTypeDeclaration.md delete mode 100644 docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md delete mode 100644 docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md delete mode 100644 docs/api/namespaces/Generator/interfaces/RendererInferenceType.md delete mode 100644 docs/api/namespaces/Generator/type-aliases/ArrayInferenceType.md delete mode 100644 docs/api/namespaces/Generator/type-aliases/InferenceType.md delete mode 100644 docs/api/namespaces/Generator/type-aliases/KeyInfo.md delete mode 100644 docs/api/namespaces/Generator/type-aliases/MiscInferenceType.md delete mode 100644 docs/api/namespaces/Helpers/classes/Maybe.md delete mode 100644 docs/api/namespaces/Helpers/classes/SuperParsedResult.md delete mode 100644 docs/api/namespaces/Helpers/interfaces/Constructor.md delete mode 100644 docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md delete mode 100644 docs/api/namespaces/JsHelpers/functions/getNodeSourceRange.md delete mode 100644 docs/api/namespaces/JsHelpers/functions/memberBaseName.md delete mode 100644 docs/api/namespaces/JsHelpers/functions/memberToString.md delete mode 100644 docs/api/namespaces/JsHelpers/type-aliases/AstVisitFn.md delete mode 100644 docs/api/namespaces/JsHelpers/type-aliases/AstVisitResult.md delete mode 100644 docs/api/namespaces/JsHelpers/type-aliases/AstVisitor.md delete mode 100644 docs/api/namespaces/JsHelpers/variables/WALK_STOP.md delete mode 100644 docs/api/namespaces/JsHelpers/variables/indent.md delete mode 100644 docs/api/namespaces/JsHelpers/variables/jsBuiltIns.md delete mode 100644 docs/api/namespaces/JsMatchers/functions/nMatcher.md delete mode 100644 docs/api/namespaces/JsMatchers/functions/sigMatcher.md delete mode 100644 docs/api/namespaces/JsMatchers/functions/timestampMatcher.md delete mode 100644 docs/api/namespaces/LZW/functions/compress.md delete mode 100644 docs/api/namespaces/LZW/functions/decompress.md delete mode 100644 docs/api/namespaces/Log/functions/debug.md delete mode 100644 docs/api/namespaces/Log/functions/error.md delete mode 100644 docs/api/namespaces/Log/functions/info.md delete mode 100644 docs/api/namespaces/Log/functions/setLevel.md delete mode 100644 docs/api/namespaces/Log/functions/warn.md delete mode 100644 docs/api/namespaces/Log/functions/warnOnce.md delete mode 100644 docs/api/namespaces/Managers/classes/AccountManager.md delete mode 100644 docs/api/namespaces/Managers/classes/InteractionManager.md delete mode 100644 docs/api/namespaces/Managers/classes/PlaylistManager.md delete mode 100644 docs/api/namespaces/Misc/classes/AccessibilityContext.md delete mode 100644 docs/api/namespaces/Misc/classes/AccessibilityData.md delete mode 100644 docs/api/namespaces/Misc/classes/Author.md delete mode 100644 docs/api/namespaces/Misc/classes/ChildElement.md delete mode 100644 docs/api/namespaces/Misc/classes/CommandContext.md delete mode 100644 docs/api/namespaces/Misc/classes/EmojiRun.md delete mode 100644 docs/api/namespaces/Misc/classes/Format.md delete mode 100644 docs/api/namespaces/Misc/classes/RendererContext.md delete mode 100644 docs/api/namespaces/Misc/classes/SubscriptionButton.md delete mode 100644 docs/api/namespaces/Misc/classes/Text.md delete mode 100644 docs/api/namespaces/Misc/classes/TextRun.md delete mode 100644 docs/api/namespaces/Misc/classes/Thumbnail.md delete mode 100644 docs/api/namespaces/Misc/classes/VideoDetails.md delete mode 100644 docs/api/namespaces/Mixins/classes/Feed.md delete mode 100644 docs/api/namespaces/Mixins/classes/FilterableFeed.md delete mode 100644 docs/api/namespaces/Mixins/classes/MediaInfo.md delete mode 100644 docs/api/namespaces/Mixins/classes/TabbedFeed.md delete mode 100644 docs/api/namespaces/Parser/functions/addRuntimeParser.md delete mode 100644 docs/api/namespaces/Parser/functions/applyCommentsMutations.md delete mode 100644 docs/api/namespaces/Parser/functions/applyMutations.md delete mode 100644 docs/api/namespaces/Parser/functions/getDynamicParsers.md delete mode 100644 docs/api/namespaces/Parser/functions/hasParser.md delete mode 100644 docs/api/namespaces/Parser/functions/parse.md delete mode 100644 docs/api/namespaces/Parser/functions/parseArray.md delete mode 100644 docs/api/namespaces/Parser/functions/parseC.md delete mode 100644 docs/api/namespaces/Parser/functions/parseCommands.md delete mode 100644 docs/api/namespaces/Parser/functions/parseFormats.md delete mode 100644 docs/api/namespaces/Parser/functions/parseItem.md delete mode 100644 docs/api/namespaces/Parser/functions/parseLC.md delete mode 100644 docs/api/namespaces/Parser/functions/parseRR.md delete mode 100644 docs/api/namespaces/Parser/functions/parseResponse.md delete mode 100644 docs/api/namespaces/Parser/functions/sanitizeClassName.md delete mode 100644 docs/api/namespaces/Parser/functions/setParserErrorHandler.md delete mode 100644 docs/api/namespaces/Parser/functions/shouldIgnore.md delete mode 100644 docs/api/namespaces/Parser/type-aliases/ParserError.md delete mode 100644 docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md delete mode 100644 docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md delete mode 100644 docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md delete mode 100644 docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md delete mode 100644 docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md delete mode 100644 docs/api/namespaces/ProtoUtils/type-aliases/CommentActionParamsArgs.md delete mode 100644 docs/api/namespaces/Types/classes/JsAnalyzer.md delete mode 100644 docs/api/namespaces/Types/classes/JsExtractor.md delete mode 100644 docs/api/namespaces/Types/interfaces/AnalyzerOptions.md delete mode 100644 docs/api/namespaces/Types/interfaces/BuildScriptResult.md delete mode 100644 docs/api/namespaces/Types/interfaces/EmitterOptions.md delete mode 100644 docs/api/namespaces/Types/interfaces/ExtractionConfig.md delete mode 100644 docs/api/namespaces/Types/interfaces/ExtractionState.md delete mode 100644 docs/api/namespaces/Types/interfaces/FormatOptions.md delete mode 100644 docs/api/namespaces/Types/interfaces/GetVideoInfoOptions.md delete mode 100644 docs/api/namespaces/Types/interfaces/ICache.md delete mode 100644 docs/api/namespaces/Types/interfaces/ICacheConstructor.md delete mode 100644 docs/api/namespaces/Types/interfaces/PlatformShim.md delete mode 100644 docs/api/namespaces/Types/interfaces/SideEffectPolicyOptions.md delete mode 100644 docs/api/namespaces/Types/interfaces/VariableMetadata.md delete mode 100644 docs/api/namespaces/Types/type-aliases/Duration.md delete mode 100644 docs/api/namespaces/Types/type-aliases/EngagementType.md delete mode 100644 docs/api/namespaces/Types/type-aliases/EvalResult.md delete mode 100644 docs/api/namespaces/Types/type-aliases/ExtractionMatch.md delete mode 100644 docs/api/namespaces/Types/type-aliases/Feature.md delete mode 100644 docs/api/namespaces/Types/type-aliases/FetchFunction.md delete mode 100644 docs/api/namespaces/Types/type-aliases/FormatFilter.md delete mode 100644 docs/api/namespaces/Types/type-aliases/InnerTubeClient.md delete mode 100644 docs/api/namespaces/Types/type-aliases/InnerTubeConfig.md delete mode 100644 docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md delete mode 100644 docs/api/namespaces/Types/type-aliases/MusicSearchType.md delete mode 100644 docs/api/namespaces/Types/type-aliases/Runtime.md delete mode 100644 docs/api/namespaces/Types/type-aliases/SearchFilters.md delete mode 100644 docs/api/namespaces/Types/type-aliases/SearchType.md delete mode 100644 docs/api/namespaces/Types/type-aliases/SideEffectMode.md delete mode 100644 docs/api/namespaces/Types/type-aliases/SortBy.md delete mode 100644 docs/api/namespaces/Types/type-aliases/URLTransformer.md delete mode 100644 docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md delete mode 100644 docs/api/namespaces/Types/type-aliases/UploadDate.md delete mode 100644 docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md delete mode 100644 docs/api/namespaces/Types/type-aliases/VMPrimative.md delete mode 100644 docs/api/namespaces/Utils/functions/base64ToU8.md delete mode 100644 docs/api/namespaces/Utils/functions/concatMemos.md delete mode 100644 docs/api/namespaces/Utils/functions/debugFetch.md delete mode 100644 docs/api/namespaces/Utils/functions/deepCompare.md delete mode 100644 docs/api/namespaces/Utils/functions/escapeStringRegexp.md delete mode 100644 docs/api/namespaces/Utils/functions/generateRandomString.md delete mode 100644 docs/api/namespaces/Utils/functions/generateSidAuth.md delete mode 100644 docs/api/namespaces/Utils/functions/getCookie.md delete mode 100644 docs/api/namespaces/Utils/functions/getRandomUserAgent.md delete mode 100644 docs/api/namespaces/Utils/functions/getStringBetweenStrings.md delete mode 100644 docs/api/namespaces/Utils/functions/hasKeys.md delete mode 100644 docs/api/namespaces/Utils/functions/isTextRun.md delete mode 100644 docs/api/namespaces/Utils/functions/streamToIterable.md delete mode 100644 docs/api/namespaces/Utils/functions/throwIfMissing.md delete mode 100644 docs/api/namespaces/Utils/functions/timeToSeconds.md delete mode 100644 docs/api/namespaces/Utils/functions/u8ToBase64.md delete mode 100644 docs/api/namespaces/Utils/type-aliases/DeviceCategory.md delete mode 100644 docs/api/namespaces/YT/classes/AccountInfo.md delete mode 100644 docs/api/namespaces/YT/classes/Channel.md delete mode 100644 docs/api/namespaces/YT/classes/ChannelListContinuation.md delete mode 100644 docs/api/namespaces/YT/classes/Comments.md delete mode 100644 docs/api/namespaces/YT/classes/FilteredChannelList.md delete mode 100644 docs/api/namespaces/YT/classes/Guide.md delete mode 100644 docs/api/namespaces/YT/classes/HashtagFeed.md delete mode 100644 docs/api/namespaces/YT/classes/History.md delete mode 100644 docs/api/namespaces/YT/classes/HomeFeed.md delete mode 100644 docs/api/namespaces/YT/classes/ItemMenu.md delete mode 100644 docs/api/namespaces/YT/classes/Library.md delete mode 100644 docs/api/namespaces/YT/classes/LiveChat.md delete mode 100644 docs/api/namespaces/YT/classes/NotificationsMenu.md delete mode 100644 docs/api/namespaces/YT/classes/Playlist.md delete mode 100644 docs/api/namespaces/YT/classes/Search.md delete mode 100644 docs/api/namespaces/YT/classes/Settings.md delete mode 100644 docs/api/namespaces/YT/classes/SmoothedQueue.md delete mode 100644 docs/api/namespaces/YT/classes/TranscriptInfo.md delete mode 100644 docs/api/namespaces/YT/classes/VideoInfo.md delete mode 100644 docs/api/namespaces/YTKids/classes/Channel.md delete mode 100644 docs/api/namespaces/YTKids/classes/HomeFeed.md delete mode 100644 docs/api/namespaces/YTKids/classes/Search.md delete mode 100644 docs/api/namespaces/YTMusic/classes/Album.md delete mode 100644 docs/api/namespaces/YTMusic/classes/Artist.md delete mode 100644 docs/api/namespaces/YTMusic/classes/Explore.md delete mode 100644 docs/api/namespaces/YTMusic/classes/HomeFeed.md delete mode 100644 docs/api/namespaces/YTMusic/classes/Library.md delete mode 100644 docs/api/namespaces/YTMusic/classes/LibraryContinuation.md delete mode 100644 docs/api/namespaces/YTMusic/classes/Playlist.md delete mode 100644 docs/api/namespaces/YTMusic/classes/Recap.md delete mode 100644 docs/api/namespaces/YTMusic/classes/Search.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AboutChannel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AboutChannelView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AccountItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AccountItemSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ActiveAccountHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AddChatItemAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AddToPlaylistCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AddToPlaylistServiceEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AlertWithButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AnchoredSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md delete mode 100644 docs/api/namespaces/YTNodes/classes/AvatarView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/BackgroundPromo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/BackstagePost.md delete mode 100644 docs/api/namespaces/YTNodes/classes/BadgeView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/BrowseEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md delete mode 100644 docs/api/namespaces/YTNodes/classes/BumperUserEduContentView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Button.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ButtonCardView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ButtonView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CallToActionButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Card.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CardCollection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CarouselItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CarouselItemView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CarouselLockup.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CarouselTitleView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChangeEngagementPanelVisibilityAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Channel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelMetadata.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelOptions.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelSwitcherHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelSwitcherPage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelTagline.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChildVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChipCloud.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChipCloudChip.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ChipView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ClientSideToggleMenuItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ClipCreation.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ClipSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CollageHeroImage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentActionButtons.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentReplies.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentSimplebox.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentThread.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentsHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CompactChannel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CompactLink.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CompactMovie.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CompactStation.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CompactVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ConfirmDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ContentMetadataView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ContinuationCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ContinuationItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CopyLink.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CreateCommentEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CreatePlaylistDialogFormView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CreatePlaylistServiceEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CreatorHeart.md delete mode 100644 docs/api/namespaces/YTNodes/classes/CreatorHeartView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DeletePlaylistEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DialogView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DidYouMean.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DislikeButtonView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DismissableDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DismissableDialogContentSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DownloadButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DropdownItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DropdownView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/DynamicTextView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EmojiPicker.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EndScreenVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EndscreenElement.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ExpandableTab.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Factoid.md delete mode 100644 docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/FeedNudge.md delete mode 100644 docs/api/namespaces/YTNodes/classes/FeedbackEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/FormFooterView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GameDetails.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GetAccountsListInnertubeEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GetKidsBlocklistPickerCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Grid.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GridChannel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GridMix.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GridMovie.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GridPlaylist.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GridShelfView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GridShow.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GridVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md delete mode 100644 docs/api/namespaces/YTNodes/classes/GuideEntry.md delete mode 100644 docs/api/namespaces/YTNodes/classes/HashtagTile.md delete mode 100644 docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md delete mode 100644 docs/api/namespaces/YTNodes/classes/HideEngagementPanelEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/HorizontalCardList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/HorizontalList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/HowThisWasMadeSectionView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/IconLink.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ImageBannerView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md delete mode 100644 docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md delete mode 100644 docs/api/namespaces/YTNodes/classes/InfoPanelContent.md delete mode 100644 docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ItemSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ItemSectionTab.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md delete mode 100644 docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/KidsCategoriesHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LikeButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LikeButtonView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LikeEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ListItemView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatBanner.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatBannerChatSummary.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatBannerRedirect.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatItemBumperView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatItemContextMenuEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatItemList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatModeChangeMessage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LockupMetadataView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/LockupView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Menu.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MenuFlexibleItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MenuServiceItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MerchandiseItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MetadataBadge.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MicroformatData.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MobileTopbar.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Movie.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MultiPageMenu.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicCardShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicElementHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicPlayButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Notification.md delete mode 100644 docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/OpenPopupAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PageHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PageHeaderView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PageIntroduction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PanelFooterView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PdgCommentChip.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PdgReplyButtonView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PerformCommentActionEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PivotBarItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PivotButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerOverlay.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlayerOverlayVideoDetails.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Playlist.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistAddToOption.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistEditEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistPanel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistThumbnailOverlay.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Poll.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PollHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Post.md delete mode 100644 docs/api/namespaces/YTNodes/classes/PrefetchWatchCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ProductListItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Quiz.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RecognitionShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReelItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReelShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReelWatchEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReplaceLiveChatAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RichListHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RichMetadata.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RichSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RichShelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/RunAttestationCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchBox.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchFilter.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchSubMenu.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SearchSuggestion.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SectionList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SettingBoolean.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SettingsSidebar.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SettingsSwitch.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShareEntityServiceEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShareTarget.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SharedPost.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Shelf.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShortsLockupView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShowDialogCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShowEngagementPanelEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SignalServiceEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SimpleCardContent.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SimpleTextSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SingleHeroImage.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SlimOwner.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SortFilterHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md delete mode 100644 docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SubFeedOption.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SubscribeButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SubscribeButtonView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SubscribeEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Tab.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TextCarouselItemView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TextFieldView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ToggleButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ToggleButtonView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ToggleFormField.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Tooltip.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TopbarMenuButton.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TranscriptFooter.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TranscriptSegment.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md delete mode 100644 docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UnifiedSharePanel.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UnsubscribeEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateChannelSwitcherPageAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateSubscribeButtonAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md delete mode 100644 docs/api/namespaces/YTNodes/classes/UpsellDialog.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VerticalList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md delete mode 100644 docs/api/namespaces/YTNodes/classes/Video.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoAttributeView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoCard.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoMetadataCarouselView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VideoViewCount.md delete mode 100644 docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md delete mode 100644 docs/api/namespaces/YTNodes/classes/VoiceReplyContainerView.md delete mode 100644 docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md delete mode 100644 docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md delete mode 100644 docs/api/namespaces/YTNodes/classes/WatchEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/WatchNextEndpoint.md delete mode 100644 docs/api/namespaces/YTNodes/classes/YpcTrailer.md delete mode 100644 docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md diff --git a/docs/api/README.md b/docs/api/README.md index cf5be052..4076164a 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,366 +1,30 @@ # youtubei.js -## References - -### AddToPlaylistServiceRequest - -Re-exports [AddToPlaylistServiceRequest](namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md) - -*** - -### AppendContinuationItemsAction - -Re-exports [AppendContinuationItemsAction](namespaces/YTNodes/classes/AppendContinuationItemsAction.md) - -*** - -### BrowseRequest - -Re-exports [BrowseRequest](namespaces/APIResponseTypes/type-aliases/BrowseRequest.md) - -*** - -### BrowseRequestSupportedMetadata - -Re-exports [BrowseRequestSupportedMetadata](namespaces/APIResponseTypes/type-aliases/BrowseRequestSupportedMetadata.md) - -*** - -### ContinuationRequest - -Re-exports [ContinuationRequest](namespaces/APIResponseTypes/type-aliases/ContinuationRequest.md) - -*** - -### CreateCommentRequest - -Re-exports [CreateCommentRequest](namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md) - -*** - -### CreatePlaylistServiceRequest - -Re-exports [CreatePlaylistServiceRequest](namespaces/APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md) - -*** - -### default - -Renames and re-exports [Innertube](classes/Innertube.md) - -*** - -### DeletePlaylistServiceRequest - -Re-exports [DeletePlaylistServiceRequest](namespaces/APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md) - -*** - -### FeedbackContext - -Re-exports [FeedbackContext](namespaces/APIResponseTypes/type-aliases/FeedbackContext.md) - -*** - -### FeedbackRequest - -Re-exports [FeedbackRequest](namespaces/APIResponseTypes/type-aliases/FeedbackRequest.md) - -*** - -### FormData - -Re-exports [FormData](namespaces/APIResponseTypes/type-aliases/FormData.md) - -*** - -### GetAccountsListInnertubeRequest - -Re-exports [GetAccountsListInnertubeRequest](namespaces/APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md) - -*** - -### GetKidsBlocklistPickerRequest - -Re-exports [GetKidsBlocklistPickerRequest](namespaces/APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md) - -*** - -### IBotguardChallenge - -Re-exports [IBotguardChallenge](namespaces/APIResponseTypes/interfaces/IBotguardChallenge.md) - -*** - -### IBrowseResponse - -Re-exports [IBrowseResponse](namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md) - -*** - -### IEndpoint - -Re-exports [IEndpoint](namespaces/APIResponseTypes/interfaces/IEndpoint.md) - -*** - -### IGetChallengeResponse - -Re-exports [IGetChallengeResponse](namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md) - -*** - -### IGetNotificationsMenuResponse - -Re-exports [IGetNotificationsMenuResponse](namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md) - -*** - -### IGetTranscriptResponse - -Re-exports [IGetTranscriptResponse](namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md) - -*** - -### IGuideResponse - -Re-exports [IGuideResponse](namespaces/APIResponseTypes/type-aliases/IGuideResponse.md) - -*** - -### INextResponse - -Re-exports [INextResponse](namespaces/APIResponseTypes/type-aliases/INextResponse.md) - -*** - -### InlineSettingStatus - -Re-exports [InlineSettingStatus](namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md) - -*** - -### IParsedResponse - -Re-exports [IParsedResponse](namespaces/APIResponseTypes/interfaces/IParsedResponse.md) - -*** - -### IPlayabilityStatus - -Re-exports [IPlayabilityStatus](namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md) - -*** - -### IPlaybackTracking - -Re-exports [IPlaybackTracking](namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md) - -*** - -### IPlayerConfig - -Re-exports [IPlayerConfig](namespaces/APIResponseTypes/interfaces/IPlayerConfig.md) - -*** - -### IPlayerResponse - -Re-exports [IPlayerResponse](namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md) - -*** - -### IRawBotguardChallenge - -Re-exports [IRawBotguardChallenge](namespaces/APIResponseTypes/interfaces/IRawBotguardChallenge.md) - -*** - -### IRawPlayerConfig - -Re-exports [IRawPlayerConfig](namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md) - -*** - -### IRawResponse - -Re-exports [IRawResponse](namespaces/APIResponseTypes/interfaces/IRawResponse.md) - -*** - -### IRawTrustedResource - -Re-exports [IRawTrustedResource](namespaces/APIResponseTypes/interfaces/IRawTrustedResource.md) - -*** - -### IResolveURLResponse - -Re-exports [IResolveURLResponse](namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md) - -*** - -### ISearchResponse - -Re-exports [ISearchResponse](namespaces/APIResponseTypes/type-aliases/ISearchResponse.md) - -*** - -### IStreamingData - -Re-exports [IStreamingData](namespaces/APIResponseTypes/interfaces/IStreamingData.md) - -*** - -### ITrustedResource - -Re-exports [ITrustedResource](namespaces/APIResponseTypes/interfaces/ITrustedResource.md) - -*** - -### IUpdatedMetadataResponse - -Re-exports [IUpdatedMetadataResponse](namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md) - -*** - -### JsAnalyzer - -Re-exports [JsAnalyzer](namespaces/Types/classes/JsAnalyzer.md) - -*** - -### JsExtractor - -Re-exports [JsExtractor](namespaces/Types/classes/JsExtractor.md) - -*** - -### LikeRequest - -Re-exports [LikeRequest](namespaces/APIResponseTypes/type-aliases/LikeRequest.md) - -*** - -### LikeTarget - -Re-exports [LikeTarget](namespaces/APIResponseTypes/type-aliases/LikeTarget.md) - -*** - -### LiveChatItemContextMenuRequest - -Re-exports [LiveChatItemContextMenuRequest](namespaces/APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md) - -*** - -### ModifyChannelNotificationPreferenceRequest - -Re-exports [ModifyChannelNotificationPreferenceRequest](namespaces/APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md) - -*** - -### NextNavendpoint - -Re-exports [NextNavendpoint](namespaces/APIResponseTypes/type-aliases/NextNavendpoint.md) - -*** - -### PerformCommentActionRequest - -Re-exports [PerformCommentActionRequest](namespaces/APIResponseTypes/type-aliases/PerformCommentActionRequest.md) - -*** - -### PlaylistEditRequest - -Re-exports [PlaylistEditRequest](namespaces/APIResponseTypes/type-aliases/PlaylistEditRequest.md) - -*** - -### PlaylistPrivacyStatus - -Re-exports [PlaylistPrivacyStatus](namespaces/APIResponseTypes/type-aliases/PlaylistPrivacyStatus.md) - -*** - -### RawData - -Re-exports [RawData](namespaces/APIResponseTypes/type-aliases/RawData.md) - -*** - -### RawNode - -Re-exports [RawNode](namespaces/APIResponseTypes/type-aliases/RawNode.md) - -*** - -### ReelWatchRequest - -Re-exports [ReelWatchRequest](namespaces/APIResponseTypes/type-aliases/ReelWatchRequest.md) - -*** - -### SearchRequest - -Re-exports [SearchRequest](namespaces/APIResponseTypes/type-aliases/SearchRequest.md) - -*** - -### ShareEntityServiceRequest - -Re-exports [ShareEntityServiceRequest](namespaces/APIResponseTypes/type-aliases/ShareEntityServiceRequest.md) - -*** - -### SubscribeRequest - -Re-exports [SubscribeRequest](namespaces/APIResponseTypes/type-aliases/SubscribeRequest.md) - -*** - -### UnsubscribeRequest - -Re-exports [UnsubscribeRequest](namespaces/APIResponseTypes/type-aliases/UnsubscribeRequest.md) - -*** - -### WatchNextRequest - -Re-exports [WatchNextRequest](namespaces/APIResponseTypes/type-aliases/WatchNextRequest.md) - -*** - -### WatchRequest - -Re-exports [WatchRequest](namespaces/APIResponseTypes/type-aliases/WatchRequest.md) - ## Namespaces -- [APIResponseTypes](namespaces/APIResponseTypes/README.md) -- [BinarySerializer](namespaces/BinarySerializer/README.md) -- [Clients](namespaces/Clients/README.md) -- [Constants](namespaces/Constants/README.md) -- [FormatUtils](namespaces/FormatUtils/README.md) -- [Generator](namespaces/Generator/README.md) -- [Helpers](namespaces/Helpers/README.md) -- [JsHelpers](namespaces/JsHelpers/README.md) -- [JsMatchers](namespaces/JsMatchers/README.md) -- [Log](namespaces/Log/README.md) -- [LZW](namespaces/LZW/README.md) -- [Managers](namespaces/Managers/README.md) -- [Misc](namespaces/Misc/README.md) -- [Mixins](namespaces/Mixins/README.md) -- [Parser](namespaces/Parser/README.md) -- [ProtoUtils](namespaces/ProtoUtils/README.md) -- [Types](namespaces/Types/README.md) -- [Utils](namespaces/Utils/README.md) -- [YT](namespaces/YT/README.md) -- [YTKids](namespaces/YTKids/README.md) -- [YTMusic](namespaces/YTMusic/README.md) -- [YTNodes](namespaces/YTNodes/README.md) -- [YTShorts](namespaces/YTShorts/README.md) +- [APIResponseTypes](youtubei.js/namespaces/APIResponseTypes/README.md) +- [BinarySerializer](youtubei.js/namespaces/BinarySerializer/README.md) +- [Clients](youtubei.js/namespaces/Clients/README.md) +- [Constants](youtubei.js/namespaces/Constants/README.md) +- [FormatUtils](youtubei.js/namespaces/FormatUtils/README.md) +- [Generator](youtubei.js/namespaces/Generator/README.md) +- [Helpers](youtubei.js/namespaces/Helpers/README.md) +- [JsHelpers](youtubei.js/namespaces/JsHelpers/README.md) +- [JsMatchers](youtubei.js/namespaces/JsMatchers/README.md) +- [Log](youtubei.js/namespaces/Log/README.md) +- [LZW](youtubei.js/namespaces/LZW/README.md) +- [Managers](youtubei.js/namespaces/Managers/README.md) +- [Misc](youtubei.js/namespaces/Misc/README.md) +- [Mixins](youtubei.js/namespaces/Mixins/README.md) +- [Parser](youtubei.js/namespaces/Parser/README.md) +- [ProtoUtils](youtubei.js/namespaces/ProtoUtils/README.md) +- [Types](youtubei.js/namespaces/Types/README.md) +- [Utils](youtubei.js/namespaces/Utils/README.md) +- [YT](youtubei.js/namespaces/YT/README.md) +- [YTKids](youtubei.js/namespaces/YTKids/README.md) +- [YTMusic](youtubei.js/namespaces/YTMusic/README.md) +- [YTNodes](youtubei.js/namespaces/YTNodes/README.md) +- [YTShorts](youtubei.js/namespaces/YTShorts/README.md) ## Enumerations @@ -369,6 +33,7 @@ Re-exports [WatchRequest](namespaces/APIResponseTypes/type-aliases/WatchRequest. ## Classes - [Actions](classes/Actions.md) +- [AppendContinuationItemsAction](classes/AppendContinuationItemsAction.md) - [Continuation](classes/Continuation.md) - [ContinuationCommand](classes/ContinuationCommand.md) - [EventEmitter](classes/EventEmitter.md) @@ -394,19 +59,89 @@ Re-exports [WatchRequest](namespaces/APIResponseTypes/type-aliases/WatchRequest. - [ApiResponse](interfaces/ApiResponse.md) - [HTTPClientInit](interfaces/HTTPClientInit.md) +- [IBotguardChallenge](interfaces/IBotguardChallenge.md) +- [IEndpoint](interfaces/IEndpoint.md) +- [IParsedResponse](interfaces/IParsedResponse.md) +- [IPlayabilityStatus](interfaces/IPlayabilityStatus.md) +- [IPlaybackTracking](interfaces/IPlaybackTracking.md) +- [IPlayerConfig](interfaces/IPlayerConfig.md) +- [IRawBotguardChallenge](interfaces/IRawBotguardChallenge.md) +- [IRawPlayerConfig](interfaces/IRawPlayerConfig.md) +- [IRawResponse](interfaces/IRawResponse.md) +- [IRawTrustedResource](interfaces/IRawTrustedResource.md) +- [IStreamingData](interfaces/IStreamingData.md) +- [ITrustedResource](interfaces/ITrustedResource.md) ## Type Aliases +- [AddToPlaylistServiceRequest](type-aliases/AddToPlaylistServiceRequest.md) +- [BrowseRequest](type-aliases/BrowseRequest.md) +- [BrowseRequestSupportedMetadata](type-aliases/BrowseRequestSupportedMetadata.md) - [Context](type-aliases/Context.md) +- [ContinuationRequest](type-aliases/ContinuationRequest.md) +- [CreateCommentRequest](type-aliases/CreateCommentRequest.md) +- [CreatePlaylistServiceRequest](type-aliases/CreatePlaylistServiceRequest.md) +- [DeletePlaylistServiceRequest](type-aliases/DeletePlaylistServiceRequest.md) - [DeviceAndUserCode](type-aliases/DeviceAndUserCode.md) +- [FeedbackContext](type-aliases/FeedbackContext.md) +- [FeedbackRequest](type-aliases/FeedbackRequest.md) +- [FormData](type-aliases/FormData.md) +- [GetAccountsListInnertubeRequest](type-aliases/GetAccountsListInnertubeRequest.md) +- [GetKidsBlocklistPickerRequest](type-aliases/GetKidsBlocklistPickerRequest.md) +- [IBrowseResponse](type-aliases/IBrowseResponse.md) +- [IGetChallengeResponse](type-aliases/IGetChallengeResponse.md) +- [IGetNotificationsMenuResponse](type-aliases/IGetNotificationsMenuResponse.md) +- [IGetTranscriptResponse](type-aliases/IGetTranscriptResponse.md) +- [IGuideResponse](type-aliases/IGuideResponse.md) +- [INextResponse](type-aliases/INextResponse.md) +- [InlineSettingStatus](type-aliases/InlineSettingStatus.md) - [InnertubeEndpoint](type-aliases/InnertubeEndpoint.md) +- [IPlayerResponse](type-aliases/IPlayerResponse.md) +- [IResolveURLResponse](type-aliases/IResolveURLResponse.md) +- [ISearchResponse](type-aliases/ISearchResponse.md) +- [IUpdatedMetadataResponse](type-aliases/IUpdatedMetadataResponse.md) +- [LikeRequest](type-aliases/LikeRequest.md) +- [LikeTarget](type-aliases/LikeTarget.md) +- [LiveChatItemContextMenuRequest](type-aliases/LiveChatItemContextMenuRequest.md) +- [ModifyChannelNotificationPreferenceRequest](type-aliases/ModifyChannelNotificationPreferenceRequest.md) +- [NextNavendpoint](type-aliases/NextNavendpoint.md) - [OAuth2AuthErrorEventHandler](type-aliases/OAuth2AuthErrorEventHandler.md) - [OAuth2AuthEventHandler](type-aliases/OAuth2AuthEventHandler.md) - [OAuth2AuthPendingEventHandler](type-aliases/OAuth2AuthPendingEventHandler.md) - [OAuth2ClientID](type-aliases/OAuth2ClientID.md) - [OAuth2Tokens](type-aliases/OAuth2Tokens.md) - [ParsedResponse](type-aliases/ParsedResponse.md) +- [PerformCommentActionRequest](type-aliases/PerformCommentActionRequest.md) +- [PlaylistEditRequest](type-aliases/PlaylistEditRequest.md) +- [PlaylistPrivacyStatus](type-aliases/PlaylistPrivacyStatus.md) +- [RawData](type-aliases/RawData.md) +- [RawNode](type-aliases/RawNode.md) +- [ReelWatchRequest](type-aliases/ReelWatchRequest.md) +- [SearchRequest](type-aliases/SearchRequest.md) - [SessionArgs](type-aliases/SessionArgs.md) - [SessionData](type-aliases/SessionData.md) - [SessionOptions](type-aliases/SessionOptions.md) +- [ShareEntityServiceRequest](type-aliases/ShareEntityServiceRequest.md) +- [SubscribeRequest](type-aliases/SubscribeRequest.md) - [SWSessionData](type-aliases/SWSessionData.md) +- [UnsubscribeRequest](type-aliases/UnsubscribeRequest.md) +- [WatchNextRequest](type-aliases/WatchNextRequest.md) +- [WatchRequest](type-aliases/WatchRequest.md) + +## References + +### default + +Renames and re-exports [Innertube](classes/Innertube.md) + +*** + +### JsAnalyzer + +Re-exports [JsAnalyzer](youtubei.js/namespaces/Types/classes/JsAnalyzer.md) + +*** + +### JsExtractor + +Re-exports [JsExtractor](youtubei.js/namespaces/Types/classes/JsExtractor.md) diff --git a/docs/api/classes/Actions.md b/docs/api/classes/Actions.md index a2ec5bda..b9ced584 100644 --- a/docs/api/classes/Actions.md +++ b/docs/api/classes/Actions.md @@ -2,23 +2,25 @@ # Class: Actions +Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L46) + ## Constructors -### new Actions() +### Constructor -> **new Actions**(`session`): [`Actions`](Actions.md) +> **new Actions**(`session`): `Actions` + +Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L49) #### Parameters -• **session**: [`Session`](Session.md) +##### session + +[`Session`](Session.md) #### Returns -[`Actions`](Actions.md) - -#### Defined in - -[src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L49) +`Actions` ## Properties @@ -26,110 +28,138 @@ > **session**: [`Session`](Session.md) -#### Defined in - -[src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L47) +Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L47) ## Methods ### execute() -#### execute(endpoint, args) +#### Call Signature > **execute**\<`T`\>(`endpoint`, `args`): `Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\> +Defined in: [src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L81) + Executes an API call. ##### Type Parameters -• **T** *extends* `string` +###### T + +`T` *extends* `string` ##### Parameters -• **endpoint**: `T` +###### endpoint + +`T` The endpoint to call. -• **args** +###### args Call arguments -• **args.parse**: `true` +###### parse -• **args.protobuf?**: `false` +`true` -• **args.serialized\_data?**: `any` +###### protobuf? -• **args.skip\_auth\_check?**: `boolean` +`false` + +###### serialized_data? + +`any` + +###### skip_auth_check? + +`boolean` ##### Returns `Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\> -##### Defined in +#### Call Signature -[src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L81) +> **execute**\<`T`\>(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> -#### execute(endpoint, args) +Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L88) -> **execute**\<`T`\>(`endpoint`, `args`?): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> +Executes an API call. ##### Type Parameters -• **T** *extends* `string` +###### T + +`T` *extends* `string` ##### Parameters -• **endpoint**: `T` +###### endpoint -• **args?** +`T` -• **args.parse?**: `false` +The endpoint to call. -• **args.protobuf?**: `true` +###### args? -• **args.serialized\_data?**: `any` +Call arguments -• **args.skip\_auth\_check?**: `boolean` +###### parse? + +`false` + +###### protobuf? + +`true` + +###### serialized_data? + +`any` + +###### skip_auth_check? + +`boolean` ##### Returns `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> -##### Defined in - -[src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L88) - *** ### stats() > **stats**(`url`, `client`, `params`): `Promise`\<`Response`\> +Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L59) + Makes calls to the playback tracking API. #### Parameters -• **url**: `string` +##### url + +`string` The URL to call. -• **client** +##### client The client to use. -• **client.client\_name**: `string` +###### client_name -• **client.client\_version**: `string` +`string` -• **params** +###### client_version + +`string` + +##### params Call parameters. #### Returns `Promise`\<`Response`\> - -#### Defined in - -[src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L59) diff --git a/docs/api/classes/Continuation.md b/docs/api/classes/Continuation.md index b571ef57..f5ea3f77 100644 --- a/docs/api/classes/Continuation.md +++ b/docs/api/classes/Continuation.md @@ -2,31 +2,33 @@ # Class: Continuation +Defined in: [src/parser/continuations.ts:139](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L139) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new Continuation() +### Constructor -> **new Continuation**(`data`): [`Continuation`](Continuation.md) +> **new Continuation**(`data`): `Continuation` + +Defined in: [src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L147) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`Continuation`](Continuation.md) +`Continuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L147) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties @@ -34,9 +36,7 @@ > **continuation\_type**: `string` -#### Defined in - -[src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L142) +Defined in: [src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L142) *** @@ -44,9 +44,7 @@ > `optional` **time\_until\_last\_message\_ms**: `number` -#### Defined in - -[src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L144) +Defined in: [src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L144) *** @@ -54,9 +52,7 @@ > `optional` **timeout\_ms**: `number` -#### Defined in - -[src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L143) +Defined in: [src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L143) *** @@ -64,9 +60,7 @@ > **token**: `string` -#### Defined in - -[src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L145) +Defined in: [src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L145) *** @@ -74,13 +68,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -88,13 +80,11 @@ > `readonly` `static` **type**: `"continuation"` = `'continuation'` +Defined in: [src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L140) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L140) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -102,17 +92,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -128,11 +126,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -140,17 +134,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is Continuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -162,11 +164,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -174,17 +172,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -196,35 +202,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -234,8 +244,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/ContinuationCommand.md b/docs/api/classes/ContinuationCommand.md index 7aee2911..45b4b5ff 100644 --- a/docs/api/classes/ContinuationCommand.md +++ b/docs/api/classes/ContinuationCommand.md @@ -2,31 +2,33 @@ # Class: ContinuationCommand +Defined in: [src/parser/continuations.ts:214](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L214) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new ContinuationCommand() +### Constructor -> **new ContinuationCommand**(`data`): [`ContinuationCommand`](ContinuationCommand.md) +> **new ContinuationCommand**(`data`): `ContinuationCommand` + +Defined in: [src/parser/continuations.ts:220](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L220) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`ContinuationCommand`](ContinuationCommand.md) +`ContinuationCommand` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:220](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L220) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties @@ -34,9 +36,7 @@ > **request**: `string` -#### Defined in - -[src/parser/continuations.ts:217](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L217) +Defined in: [src/parser/continuations.ts:217](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L217) *** @@ -44,9 +44,7 @@ > **token**: `string` -#### Defined in - -[src/parser/continuations.ts:218](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L218) +Defined in: [src/parser/continuations.ts:218](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L218) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,13 +64,11 @@ > `readonly` `static` **type**: `"ContinuationCommand"` = `'ContinuationCommand'` +Defined in: [src/parser/continuations.ts:215](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L215) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:215](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L215) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -82,17 +76,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -108,11 +110,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -120,17 +118,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is ContinuationCommand & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -142,11 +148,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -154,17 +156,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -176,35 +186,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -214,8 +228,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/EventEmitter.md b/docs/api/classes/EventEmitter.md index ed552041..8adf282b 100644 --- a/docs/api/classes/EventEmitter.md +++ b/docs/api/classes/EventEmitter.md @@ -2,6 +2,8 @@ # Class: EventEmitter +Defined in: [src/utils/EventEmitterLike.ts:3](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L3) + ## Extends - `EventTarget` @@ -9,31 +11,31 @@ ## Extended by - [`Session`](Session.md) -- [`LiveChat`](../namespaces/YT/classes/LiveChat.md) +- [`LiveChat`](../youtubei.js/namespaces/YT/classes/LiveChat.md) ## Constructors -### new EventEmitter() +### Constructor -> **new EventEmitter**(): [`EventEmitter`](EventEmitter.md) +> **new EventEmitter**(): `EventEmitterLike` + +Defined in: [src/utils/EventEmitterLike.ts:6](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L6) #### Returns -[`EventEmitter`](EventEmitter.md) +`EventEmitterLike` #### Overrides `EventTarget.constructor` -#### Defined in - -[src/utils/EventEmitterLike.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L6) - ## Methods ### addEventListener() -> **addEventListener**(`type`, `callback`, `options`?): `void` +> **addEventListener**(`type`, `callback`, `options?`): `void` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8256 Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched. @@ -53,11 +55,17 @@ The event listener is appended to target's event listener list and is not append #### Parameters -• **type**: `string` +##### type -• **callback**: `null` \| `EventListenerOrEventListenerObject` +`string` -• **options?**: `boolean` \| `AddEventListenerOptions` +##### callback + +`EventListenerOrEventListenerObject` | `null` + +##### options? + +`boolean` | `AddEventListenerOptions` #### Returns @@ -67,23 +75,23 @@ The event listener is appended to target's event listener list and is not append `EventTarget.addEventListener` -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8256 - *** ### dispatchEvent() > **dispatchEvent**(`event`): `boolean` +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8262 + Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) #### Parameters -• **event**: `Event` +##### event + +`Event` #### Returns @@ -93,95 +101,101 @@ Dispatches a synthetic event event to target and returns true if either event's `EventTarget.dispatchEvent` -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8262 - *** ### emit() > **emit**(`type`, ...`args`): `void` +Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L10) + #### Parameters -• **type**: `string` +##### type -• ...**args**: `any`[] +`string` + +##### args + +...`any`[] #### Returns `void` -#### Defined in - -[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L10) - *** ### off() > **off**(`type`, `listener`): `void` +Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L40) + #### Parameters -• **type**: `string` +##### type -• **listener** +`string` + +##### listener + +(...`args`) => `void` #### Returns `void` -#### Defined in - -[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L40) - *** ### on() > **on**(`type`, `listener`): `void` +Defined in: [src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L15) + #### Parameters -• **type**: `string` +##### type -• **listener** +`string` + +##### listener + +(...`args`) => `void` #### Returns `void` -#### Defined in - -[src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L15) - *** ### once() > **once**(`type`, `listener`): `void` +Defined in: [src/utils/EventEmitterLike.ts:27](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L27) + #### Parameters -• **type**: `string` +##### type -• **listener** +`string` + +##### listener + +(...`args`) => `void` #### Returns `void` -#### Defined in - -[src/utils/EventEmitterLike.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L27) - *** ### removeEventListener() -> **removeEventListener**(`type`, `callback`, `options`?): `void` +> **removeEventListener**(`type`, `callback`, `options?`): `void` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8268 Removes the event listener in target's event listener list with the same type, callback, and options. @@ -189,11 +203,17 @@ Removes the event listener in target's event listener list with the same type, c #### Parameters -• **type**: `string` +##### type -• **callback**: `null` \| `EventListenerOrEventListenerObject` +`string` -• **options?**: `boolean` \| `EventListenerOptions` +##### callback + +`EventListenerOrEventListenerObject` | `null` + +##### options? + +`boolean` | `EventListenerOptions` #### Returns @@ -202,7 +222,3 @@ Removes the event listener in target's event listener list with the same type, c #### Inherited from `EventTarget.removeEventListener` - -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8268 diff --git a/docs/api/classes/GridContinuation.md b/docs/api/classes/GridContinuation.md index 3a8f88a5..1f0a2d58 100644 --- a/docs/api/classes/GridContinuation.md +++ b/docs/api/classes/GridContinuation.md @@ -2,31 +2,33 @@ # Class: GridContinuation +Defined in: [src/parser/continuations.ts:108](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L108) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new GridContinuation() +### Constructor -> **new GridContinuation**(`data`): [`GridContinuation`](GridContinuation.md) +> **new GridContinuation**(`data`): `GridContinuation` + +Defined in: [src/parser/continuations.ts:114](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L114) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`GridContinuation`](GridContinuation.md) +`GridContinuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:114](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L114) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties @@ -34,19 +36,15 @@ > **continuation**: `string` -#### Defined in - -[src/parser/continuations.ts:111](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L111) +Defined in: [src/parser/continuations.ts:111](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L111) *** ### items -> **items**: `null` \| [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **items**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null` -#### Defined in - -[src/parser/continuations.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L112) +Defined in: [src/parser/continuations.ts:112](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L112) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,27 +64,25 @@ > `readonly` `static` **type**: `"gridContinuation"` = `'gridContinuation'` +Defined in: [src/parser/continuations.ts:109](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L109) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:109](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L109) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Accessors ### contents -> `get` **contents**(): `null` \| [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +#### Get Signature -#### Returns +> **get** **contents**(): [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null` -`null` \| [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +Defined in: [src/parser/continuations.ts:120](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L120) -#### Defined in +##### Returns -[src/parser/continuations.ts:120](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L120) +[`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null` ## Methods @@ -96,17 +90,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -122,11 +124,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -134,17 +132,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is GridContinuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -156,11 +162,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -168,17 +170,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -190,35 +200,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -228,8 +242,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/HTTPClient.md b/docs/api/classes/HTTPClient.md index 9de68761..c06ac856 100644 --- a/docs/api/classes/HTTPClient.md +++ b/docs/api/classes/HTTPClient.md @@ -2,80 +2,100 @@ # Class: HTTPClient +Defined in: [src/utils/HTTPClient.ts:25](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/HTTPClient.ts#L25) + ## Constructors -### new HTTPClient() +### Constructor -> **new HTTPClient**(`session`, `cookie`?, `fetch`?): [`HTTPClient`](HTTPClient.md) +> **new HTTPClient**(`session`, `cookie?`, `fetch?`): `HTTPClient` + +Defined in: [src/utils/HTTPClient.ts:30](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/HTTPClient.ts#L30) #### Parameters -• **session**: [`Session`](Session.md) +##### session -• **cookie?**: `string` +[`Session`](Session.md) -• **fetch?** +##### cookie? + +`string` + +##### fetch? + +\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \} #### Returns -[`HTTPClient`](HTTPClient.md) - -#### Defined in - -[src/utils/HTTPClient.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/HTTPClient.ts#L30) +`HTTPClient` ## Accessors ### fetch\_function -> `get` **fetch\_function**(): (`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\> +#### Get Signature -#### Returns +> **get** **fetch\_function**(): \{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \} -`Function` +Defined in: [src/utils/HTTPClient.ts:36](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/HTTPClient.ts#L36) + +##### Returns + +> (`input`, `init?`): `Promise`\<`Response`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch) -##### Parameters +###### Parameters -• **input**: `URL` \| `RequestInfo` +###### input -• **init?**: `RequestInit` +`URL` | `RequestInfo` -##### Returns +###### init? + +`RequestInit` + +###### Returns `Promise`\<`Response`\> -##### Parameters +> (`input`, `init?`): `Promise`\<`Response`\> -• **input**: `string` \| `URL` \| `Request` +[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch) -• **init?**: `RequestInit` +###### Parameters -##### Returns +###### input + +`string` | `URL` | `Request` + +###### init? + +`RequestInit` + +###### Returns `Promise`\<`Response`\> -#### Defined in - -[src/utils/HTTPClient.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/HTTPClient.ts#L36) - ## Methods ### fetch() -> **fetch**(`input`, `init`?): `Promise`\<`Response`\> +> **fetch**(`input`, `init?`): `Promise`\<`Response`\> + +Defined in: [src/utils/HTTPClient.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/HTTPClient.ts#L40) #### Parameters -• **input**: `string` \| `URL` \| `Request` +##### input -• **init?**: `RequestInit` & [`HTTPClientInit`](../interfaces/HTTPClientInit.md) +`string` | `URL` | `Request` + +##### init? + +`RequestInit` & [`HTTPClientInit`](../interfaces/HTTPClientInit.md) #### Returns `Promise`\<`Response`\> - -#### Defined in - -[src/utils/HTTPClient.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/HTTPClient.ts#L40) diff --git a/docs/api/classes/Innertube.md b/docs/api/classes/Innertube.md index 31e4a54e..c525a558 100644 --- a/docs/api/classes/Innertube.md +++ b/docs/api/classes/Innertube.md @@ -2,6 +2,8 @@ # Class: Innertube +Defined in: [src/Innertube.ts:64](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L64) + Provides access to various services and modules in the YouTube API. ## Example @@ -13,216 +15,230 @@ const innertube = await Innertube.create({ cache: new UniversalCache(true)}); ## Constructors -### new Innertube() +### Constructor -> **new Innertube**(`session`): [`Innertube`](Innertube.md) +> **new Innertube**(`session`): `Innertube` + +Defined in: [src/Innertube.ts:67](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L67) #### Parameters -• **session**: [`Session`](Session.md) +##### session + +[`Session`](Session.md) #### Returns -[`Innertube`](Innertube.md) - -#### Defined in - -[src/Innertube.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L67) +`Innertube` ## Accessors ### account -> `get` **account**(): [`AccountManager`](../namespaces/Managers/classes/AccountManager.md) +#### Get Signature + +> **get** **account**(): [`AccountManager`](../youtubei.js/namespaces/Managers/classes/AccountManager.md) + +Defined in: [src/Innertube.ts:609](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L609) An interface for managing and retrieving account information. -#### Returns +##### Returns -[`AccountManager`](../namespaces/Managers/classes/AccountManager.md) - -#### Defined in - -[src/Innertube.ts:609](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L609) +[`AccountManager`](../youtubei.js/namespaces/Managers/classes/AccountManager.md) *** ### actions -> `get` **actions**(): [`Actions`](Actions.md) +#### Get Signature + +> **get** **actions**(): [`Actions`](Actions.md) + +Defined in: [src/Innertube.ts:630](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L630) An internal class used to dispatch requests. -#### Returns +##### Returns [`Actions`](Actions.md) -#### Defined in - -[src/Innertube.ts:630](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L630) - *** ### interact -> `get` **interact**(): [`InteractionManager`](../namespaces/Managers/classes/InteractionManager.md) +#### Get Signature + +> **get** **interact**(): [`InteractionManager`](../youtubei.js/namespaces/Managers/classes/InteractionManager.md) + +Defined in: [src/Innertube.ts:623](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L623) An interface for directly interacting with certain YouTube features. -#### Returns +##### Returns -[`InteractionManager`](../namespaces/Managers/classes/InteractionManager.md) - -#### Defined in - -[src/Innertube.ts:623](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L623) +[`InteractionManager`](../youtubei.js/namespaces/Managers/classes/InteractionManager.md) *** ### kids -> `get` **kids**(): [`Kids`](../namespaces/Clients/classes/Kids.md) +#### Get Signature + +> **get** **kids**(): [`Kids`](../youtubei.js/namespaces/Clients/classes/Kids.md) + +Defined in: [src/Innertube.ts:602](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L602) An interface for interacting with YouTube Kids. -#### Returns +##### Returns -[`Kids`](../namespaces/Clients/classes/Kids.md) - -#### Defined in - -[src/Innertube.ts:602](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L602) +[`Kids`](../youtubei.js/namespaces/Clients/classes/Kids.md) *** ### music -> `get` **music**(): [`Music`](../namespaces/Clients/classes/Music.md) +#### Get Signature + +> **get** **music**(): [`Music`](../youtubei.js/namespaces/Clients/classes/Music.md) + +Defined in: [src/Innertube.ts:588](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L588) An interface for interacting with YouTube Music. -#### Returns +##### Returns -[`Music`](../namespaces/Clients/classes/Music.md) - -#### Defined in - -[src/Innertube.ts:588](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L588) +[`Music`](../youtubei.js/namespaces/Clients/classes/Music.md) *** ### playlist -> `get` **playlist**(): [`PlaylistManager`](../namespaces/Managers/classes/PlaylistManager.md) +#### Get Signature + +> **get** **playlist**(): [`PlaylistManager`](../youtubei.js/namespaces/Managers/classes/PlaylistManager.md) + +Defined in: [src/Innertube.ts:616](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L616) An interface for managing playlists. -#### Returns +##### Returns -[`PlaylistManager`](../namespaces/Managers/classes/PlaylistManager.md) - -#### Defined in - -[src/Innertube.ts:616](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L616) +[`PlaylistManager`](../youtubei.js/namespaces/Managers/classes/PlaylistManager.md) *** ### session -> `get` **session**(): [`Session`](Session.md) +#### Get Signature + +> **get** **session**(): [`Session`](Session.md) + +Defined in: [src/Innertube.ts:637](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L637) The session used by this instance. -#### Returns +##### Returns [`Session`](Session.md) -#### Defined in - -[src/Innertube.ts:637](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L637) - *** ### studio -> `get` **studio**(): [`Studio`](../namespaces/Clients/classes/Studio.md) +#### Get Signature + +> **get** **studio**(): [`Studio`](../youtubei.js/namespaces/Clients/classes/Studio.md) + +Defined in: [src/Innertube.ts:595](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L595) An interface for interacting with YouTube Studio. -#### Returns +##### Returns -[`Studio`](../namespaces/Clients/classes/Studio.md) - -#### Defined in - -[src/Innertube.ts:595](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L595) +[`Studio`](../youtubei.js/namespaces/Clients/classes/Studio.md) ## Methods ### call() -#### call(endpoint, args) +#### Call Signature > **call**\<`T`\>(`endpoint`, `args`): `Promise`\<`T`\> +Defined in: [src/Innertube.ts:579](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L579) + Utility method to call an endpoint without having to use [Actions](Actions.md). ##### Type Parameters -• **T** *extends* [`IParsedResponse`](../namespaces/APIResponseTypes/interfaces/IParsedResponse.md) +###### T + +`T` *extends* [`IParsedResponse`](../interfaces/IParsedResponse.md) ##### Parameters -• **endpoint**: [`NavigationEndpoint`](../namespaces/YTNodes/classes/NavigationEndpoint.md) +###### endpoint -• **args** +[`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md) -• **args.parse**: `true` +###### args + +###### parse + +`true` ##### Returns `Promise`\<`T`\> -##### Defined in +#### Call Signature -[src/Innertube.ts:579](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L579) +> **call**(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> -#### call(endpoint, args) +Defined in: [src/Innertube.ts:580](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L580) -> **call**(`endpoint`, `args`?): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> +Utility method to call an endpoint without having to use [Actions](Actions.md). ##### Parameters -• **endpoint**: [`NavigationEndpoint`](../namespaces/YTNodes/classes/NavigationEndpoint.md) +###### endpoint -• **args?** +[`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md) -• **args.parse?**: `false` +###### args? + +###### parse? + +`false` ##### Returns `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> -##### Defined in - -[src/Innertube.ts:580](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L580) - *** ### download() -> **download**(`video_id`, `options`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> +> **download**(`video_id`, `options?`): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> -Downloads a given video. If all you need the direct download link, see [getStreamingData](Innertube.md#getstreamingdata). -If you wish to retrieve the video info too, have a look at [getBasicInfo](Innertube.md#getbasicinfo) or [getInfo](Innertube.md#getinfo). +Defined in: [src/Innertube.ts:477](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L477) + +Downloads a given video. If all you need the direct download link, see [getStreamingData](#getstreamingdata). +If you wish to retrieve the video info too, have a look at [getBasicInfo](#getbasicinfo) or [getInfo](#getinfo). #### Parameters -• **video\_id**: `string` +##### video\_id + +`string` The video id. -• **options?**: [`DownloadOptions`](../namespaces/Types/interfaces/DownloadOptions.md) +##### options? + +[`DownloadOptions`](../youtubei.js/namespaces/Types/interfaces/DownloadOptions.md) Download options. @@ -230,404 +246,402 @@ Download options. `Promise`\<`ReadableStream`\<`Uint8Array`\>\> -#### Defined in - -[src/Innertube.ts:477](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L477) - *** ### getAttestationChallenge() -> **getAttestationChallenge**(`engagement_type`, `ids`?): `Promise`\<[`IGetChallengeResponse`](../namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md)\> +> **getAttestationChallenge**(`engagement_type`, `ids?`): `Promise`\<[`IGetChallengeResponse`](../type-aliases/IGetChallengeResponse.md)\> + +Defined in: [src/Innertube.ts:565](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L565) Fetches an attestation challenge. #### Parameters -• **engagement\_type**: [`EngagementType`](../namespaces/Types/type-aliases/EngagementType.md) +##### engagement\_type -• **ids?**: `Record`\<`string`, `any`\>[] +[`EngagementType`](../youtubei.js/namespaces/Types/type-aliases/EngagementType.md) + +##### ids? + +`Record`\<`string`, `any`\>[] #### Returns -`Promise`\<[`IGetChallengeResponse`](../namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md)\> - -#### Defined in - -[src/Innertube.ts:565](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L565) +`Promise`\<[`IGetChallengeResponse`](../type-aliases/IGetChallengeResponse.md)\> *** ### getBasicInfo() -> **getBasicInfo**(`video_id`, `options`?): `Promise`\<[`VideoInfo`](../namespaces/YT/classes/VideoInfo.md)\> +> **getBasicInfo**(`video_id`, `options?`): `Promise`\<[`VideoInfo`](../youtubei.js/namespaces/YT/classes/VideoInfo.md)\> + +Defined in: [src/Innertube.ts:124](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L124) #### Parameters -• **video\_id**: `string` +##### video\_id -• **options?**: [`GetVideoInfoOptions`](../namespaces/Types/interfaces/GetVideoInfoOptions.md) +`string` + +##### options? + +[`GetVideoInfoOptions`](../youtubei.js/namespaces/Types/interfaces/GetVideoInfoOptions.md) #### Returns -`Promise`\<[`VideoInfo`](../namespaces/YT/classes/VideoInfo.md)\> - -#### Defined in - -[src/Innertube.ts:124](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L124) +`Promise`\<[`VideoInfo`](../youtubei.js/namespaces/YT/classes/VideoInfo.md)\> *** ### getChannel() -> **getChannel**(`id`): `Promise`\<[`Channel`](../namespaces/YT/classes/Channel.md)\> +> **getChannel**(`id`): `Promise`\<[`Channel`](../youtubei.js/namespaces/YT/classes/Channel.md)\> + +Defined in: [src/Innertube.ts:391](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L391) #### Parameters -• **id**: `string` +##### id + +`string` #### Returns -`Promise`\<[`Channel`](../namespaces/YT/classes/Channel.md)\> - -#### Defined in - -[src/Innertube.ts:391](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L391) +`Promise`\<[`Channel`](../youtubei.js/namespaces/YT/classes/Channel.md)\> *** ### getChannelsFeed() -> **getChannelsFeed**(): `Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> +> **getChannelsFeed**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> + +Defined in: [src/Innertube.ts:385](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L385) #### Returns -`Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Defined in - -[src/Innertube.ts:385](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L385) +`Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> *** ### getComments() -> **getComments**(`video_id`, `sort_by`?, `comment_id`?): `Promise`\<[`Comments`](../namespaces/YT/classes/Comments.md)\> +> **getComments**(`video_id`, `sort_by?`, `comment_id?`): `Promise`\<[`Comments`](../youtubei.js/namespaces/YT/classes/Comments.md)\> + +Defined in: [src/Innertube.ts:306](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L306) #### Parameters -• **video\_id**: `string` +##### video\_id -• **sort\_by?**: `"TOP_COMMENTS"` \| `"NEWEST_FIRST"` +`string` -• **comment\_id?**: `string` +##### sort\_by? + +`"TOP_COMMENTS"` | `"NEWEST_FIRST"` + +##### comment\_id? + +`string` #### Returns -`Promise`\<[`Comments`](../namespaces/YT/classes/Comments.md)\> - -#### Defined in - -[src/Innertube.ts:306](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L306) +`Promise`\<[`Comments`](../youtubei.js/namespaces/YT/classes/Comments.md)\> *** ### getCourses() -> **getCourses**(): `Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> +> **getCourses**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> + +Defined in: [src/Innertube.ts:373](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L373) #### Returns -`Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Defined in - -[src/Innertube.ts:373](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L373) +`Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> *** ### getGuide() -> **getGuide**(): `Promise`\<[`Guide`](../namespaces/YT/classes/Guide.md)\> +> **getGuide**(): `Promise`\<[`Guide`](../youtubei.js/namespaces/YT/classes/Guide.md)\> + +Defined in: [src/Innertube.ts:350](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L350) #### Returns -`Promise`\<[`Guide`](../namespaces/YT/classes/Guide.md)\> - -#### Defined in - -[src/Innertube.ts:350](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L350) +`Promise`\<[`Guide`](../youtubei.js/namespaces/YT/classes/Guide.md)\> *** ### getHashtag() -> **getHashtag**(`hashtag`): `Promise`\<[`HashtagFeed`](../namespaces/YT/classes/HashtagFeed.md)\> +> **getHashtag**(`hashtag`): `Promise`\<[`HashtagFeed`](../youtubei.js/namespaces/YT/classes/HashtagFeed.md)\> + +Defined in: [src/Innertube.ts:436](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L436) #### Parameters -• **hashtag**: `string` +##### hashtag + +`string` #### Returns -`Promise`\<[`HashtagFeed`](../namespaces/YT/classes/HashtagFeed.md)\> - -#### Defined in - -[src/Innertube.ts:436](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L436) +`Promise`\<[`HashtagFeed`](../youtubei.js/namespaces/YT/classes/HashtagFeed.md)\> *** ### getHistory() -> **getHistory**(): `Promise`\<[`History`](../namespaces/YT/classes/History.md)\> +> **getHistory**(): `Promise`\<[`History`](../youtubei.js/namespaces/YT/classes/History.md)\> + +Defined in: [src/Innertube.ts:361](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L361) #### Returns -`Promise`\<[`History`](../namespaces/YT/classes/History.md)\> - -#### Defined in - -[src/Innertube.ts:361](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L361) +`Promise`\<[`History`](../youtubei.js/namespaces/YT/classes/History.md)\> *** ### getHomeFeed() -> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../namespaces/YT/classes/HomeFeed.md)\> +> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../youtubei.js/namespaces/YT/classes/HomeFeed.md)\> + +Defined in: [src/Innertube.ts:344](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L344) #### Returns -`Promise`\<[`HomeFeed`](../namespaces/YT/classes/HomeFeed.md)\> - -#### Defined in - -[src/Innertube.ts:344](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L344) +`Promise`\<[`HomeFeed`](../youtubei.js/namespaces/YT/classes/HomeFeed.md)\> *** ### getInfo() -> **getInfo**(`target`, `options`?): `Promise`\<[`VideoInfo`](../namespaces/YT/classes/VideoInfo.md)\> +> **getInfo**(`target`, `options?`): `Promise`\<[`VideoInfo`](../youtubei.js/namespaces/YT/classes/VideoInfo.md)\> + +Defined in: [src/Innertube.ts:75](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L75) #### Parameters -• **target**: `string` \| [`NavigationEndpoint`](../namespaces/YTNodes/classes/NavigationEndpoint.md) +##### target -• **options?**: [`GetVideoInfoOptions`](../namespaces/Types/interfaces/GetVideoInfoOptions.md) +`string` | [`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md) + +##### options? + +[`GetVideoInfoOptions`](../youtubei.js/namespaces/Types/interfaces/GetVideoInfoOptions.md) #### Returns -`Promise`\<[`VideoInfo`](../namespaces/YT/classes/VideoInfo.md)\> - -#### Defined in - -[src/Innertube.ts:75](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L75) +`Promise`\<[`VideoInfo`](../youtubei.js/namespaces/YT/classes/VideoInfo.md)\> *** ### getLibrary() -> **getLibrary**(): `Promise`\<[`Library`](../namespaces/YT/classes/Library.md)\> +> **getLibrary**(): `Promise`\<[`Library`](../youtubei.js/namespaces/YT/classes/Library.md)\> + +Defined in: [src/Innertube.ts:355](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L355) #### Returns -`Promise`\<[`Library`](../namespaces/YT/classes/Library.md)\> - -#### Defined in - -[src/Innertube.ts:355](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L355) +`Promise`\<[`Library`](../youtubei.js/namespaces/YT/classes/Library.md)\> *** ### getNotifications() -> **getNotifications**(): `Promise`\<[`NotificationsMenu`](../namespaces/YT/classes/NotificationsMenu.md)\> +> **getNotifications**(): `Promise`\<[`NotificationsMenu`](../youtubei.js/namespaces/YT/classes/NotificationsMenu.md)\> + +Defined in: [src/Innertube.ts:403](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L403) #### Returns -`Promise`\<[`NotificationsMenu`](../namespaces/YT/classes/NotificationsMenu.md)\> - -#### Defined in - -[src/Innertube.ts:403](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L403) +`Promise`\<[`NotificationsMenu`](../youtubei.js/namespaces/YT/classes/NotificationsMenu.md)\> *** ### getPlaylist() -> **getPlaylist**(`id`): `Promise`\<[`Playlist`](../namespaces/YT/classes/Playlist.md)\> +> **getPlaylist**(`id`): `Promise`\<[`Playlist`](../youtubei.js/namespaces/YT/classes/Playlist.md)\> + +Defined in: [src/Innertube.ts:423](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L423) #### Parameters -• **id**: `string` +##### id + +`string` #### Returns -`Promise`\<[`Playlist`](../namespaces/YT/classes/Playlist.md)\> - -#### Defined in - -[src/Innertube.ts:423](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L423) +`Promise`\<[`Playlist`](../youtubei.js/namespaces/YT/classes/Playlist.md)\> *** ### getPlaylists() -> **getPlaylists**(): `Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> +> **getPlaylists**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> + +Defined in: [src/Innertube.ts:417](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L417) Retrieves the user's playlists. #### Returns -`Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Defined in - -[src/Innertube.ts:417](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L417) +`Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> *** ### getPost() -> **getPost**(`post_id`, `channel_id`): `Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> +> **getPost**(`post_id`, `channel_id`): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> + +Defined in: [src/Innertube.ts:497](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L497) Gets a post page given a post id and the channel id #### Parameters -• **post\_id**: `string` +##### post\_id -• **channel\_id**: `string` +`string` + +##### channel\_id + +`string` #### Returns -`Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Defined in - -[src/Innertube.ts:497](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L497) +`Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> *** ### getPostComments() -> **getPostComments**(`post_id`, `channel_id`, `sort_by`?): `Promise`\<[`Comments`](../namespaces/YT/classes/Comments.md)\> +> **getPostComments**(`post_id`, `channel_id`, `sort_by?`): `Promise`\<[`Comments`](../youtubei.js/namespaces/YT/classes/Comments.md)\> + +Defined in: [src/Innertube.ts:518](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L518) Gets the comments of a post. #### Parameters -• **post\_id**: `string` +##### post\_id -• **channel\_id**: `string` +`string` -• **sort\_by?**: `"TOP_COMMENTS"` \| `"NEWEST_FIRST"` +##### channel\_id + +`string` + +##### sort\_by? + +`"TOP_COMMENTS"` | `"NEWEST_FIRST"` #### Returns -`Promise`\<[`Comments`](../namespaces/YT/classes/Comments.md)\> - -#### Defined in - -[src/Innertube.ts:518](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L518) +`Promise`\<[`Comments`](../youtubei.js/namespaces/YT/classes/Comments.md)\> *** ### getSearchSuggestions() -> **getSearchSuggestions**(`query`, `previous_query`?): `Promise`\<`string`[]\> +> **getSearchSuggestions**(`query`, `previous_query?`): `Promise`\<`string`[]\> + +Defined in: [src/Innertube.ts:277](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L277) #### Parameters -• **query**: `string` +##### query -• **previous\_query?**: `string` +`string` + +##### previous\_query? + +`string` #### Returns `Promise`\<`string`[]\> -#### Defined in - -[src/Innertube.ts:277](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L277) - *** ### getShortsVideoInfo() -> **getShortsVideoInfo**(`video_id`, `client`?): `Promise`\<[`ShortFormVideoInfo`](../namespaces/YTShorts/classes/ShortFormVideoInfo.md)\> +> **getShortsVideoInfo**(`video_id`, `client?`): `Promise`\<[`ShortFormVideoInfo`](../youtubei.js/namespaces/YTShorts/classes/ShortFormVideoInfo.md)\> + +Defined in: [src/Innertube.ts:166](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L166) #### Parameters -• **video\_id**: `string` +##### video\_id -• **client?**: [`InnerTubeClient`](../namespaces/Types/type-aliases/InnerTubeClient.md) +`string` + +##### client? + +[`InnerTubeClient`](../youtubei.js/namespaces/Types/type-aliases/InnerTubeClient.md) #### Returns -`Promise`\<[`ShortFormVideoInfo`](../namespaces/YTShorts/classes/ShortFormVideoInfo.md)\> - -#### Defined in - -[src/Innertube.ts:166](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L166) +`Promise`\<[`ShortFormVideoInfo`](../youtubei.js/namespaces/YTShorts/classes/ShortFormVideoInfo.md)\> *** ### getStreamingData() -> **getStreamingData**(`video_id`, `options`): `Promise`\<[`Format`](../namespaces/Misc/classes/Format.md)\> +> **getStreamingData**(`video_id`, `options`): `Promise`\<[`Format`](../youtubei.js/namespaces/Misc/classes/Format.md)\> -An alternative to [download](Innertube.md#download). +Defined in: [src/Innertube.ts:462](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L462) + +An alternative to [download](#download). Returns deciphered streaming data. -If you wish to retrieve the video info too, have a look at [getBasicInfo](Innertube.md#getbasicinfo) or [getInfo](Innertube.md#getinfo). +If you wish to retrieve the video info too, have a look at [getBasicInfo](#getbasicinfo) or [getInfo](#getinfo). #### Parameters -• **video\_id**: `string` +##### video\_id + +`string` The video id. -• **options**: [`FormatOptions`](../namespaces/Types/interfaces/FormatOptions.md) = `{}` +##### options + +[`FormatOptions`](../youtubei.js/namespaces/Types/interfaces/FormatOptions.md) = `{}` Format options. #### Returns -`Promise`\<[`Format`](../namespaces/Misc/classes/Format.md)\> - -#### Defined in - -[src/Innertube.ts:462](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L462) +`Promise`\<[`Format`](../youtubei.js/namespaces/Misc/classes/Format.md)\> *** ### getSubscriptionsFeed() -> **getSubscriptionsFeed**(): `Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> +> **getSubscriptionsFeed**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> + +Defined in: [src/Innertube.ts:379](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L379) #### Returns -`Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Defined in - -[src/Innertube.ts:379](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L379) +`Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> *** ### getTrending() -> **getTrending**(): `Promise`\<[`TabbedFeed`](../namespaces/Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> +> **getTrending**(): `Promise`\<[`TabbedFeed`](../youtubei.js/namespaces/Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> + +Defined in: [src/Innertube.ts:367](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L367) #### Returns -`Promise`\<[`TabbedFeed`](../namespaces/Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Defined in - -[src/Innertube.ts:367](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L367) +`Promise`\<[`TabbedFeed`](../youtubei.js/namespaces/Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\> *** @@ -635,68 +649,68 @@ Format options. > **getUnseenNotificationsCount**(): `Promise`\<`number`\> +Defined in: [src/Innertube.ts:408](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L408) + #### Returns `Promise`\<`number`\> -#### Defined in - -[src/Innertube.ts:408](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L408) - *** ### resolveURL() -> **resolveURL**(`url`): `Promise`\<[`NavigationEndpoint`](../namespaces/YTNodes/classes/NavigationEndpoint.md)\> +> **resolveURL**(`url`): `Promise`\<[`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md)\> + +Defined in: [src/Innertube.ts:485](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L485) Resolves the given URL. #### Parameters -• **url**: `string` +##### url + +`string` #### Returns -`Promise`\<[`NavigationEndpoint`](../namespaces/YTNodes/classes/NavigationEndpoint.md)\> - -#### Defined in - -[src/Innertube.ts:485](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L485) +`Promise`\<[`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md)\> *** ### search() -> **search**(`query`, `filters`): `Promise`\<[`Search`](../namespaces/YT/classes/Search.md)\> +> **search**(`query`, `filters`): `Promise`\<[`Search`](../youtubei.js/namespaces/YT/classes/Search.md)\> + +Defined in: [src/Innertube.ts:201](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L201) #### Parameters -• **query**: `string` +##### query -• **filters**: [`SearchFilters`](../namespaces/Types/type-aliases/SearchFilters.md) = `{}` +`string` + +##### filters + +[`SearchFilters`](../youtubei.js/namespaces/Types/type-aliases/SearchFilters.md) = `{}` #### Returns -`Promise`\<[`Search`](../namespaces/YT/classes/Search.md)\> - -#### Defined in - -[src/Innertube.ts:201](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L201) +`Promise`\<[`Search`](../youtubei.js/namespaces/YT/classes/Search.md)\> *** ### create() -> `static` **create**(`config`): `Promise`\<[`Innertube`](Innertube.md)\> +> `static` **create**(`config`): `Promise`\<`Innertube`\> + +Defined in: [src/Innertube.ts:71](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/Innertube.ts#L71) #### Parameters -• **config**: [`SessionOptions`](../type-aliases/SessionOptions.md) = `{}` +##### config + +[`SessionOptions`](../type-aliases/SessionOptions.md) = `{}` #### Returns -`Promise`\<[`Innertube`](Innertube.md)\> - -#### Defined in - -[src/Innertube.ts:71](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/Innertube.ts#L71) +`Promise`\<`Innertube`\> diff --git a/docs/api/classes/ItemSectionContinuation.md b/docs/api/classes/ItemSectionContinuation.md index e9a4c57b..d3067a53 100644 --- a/docs/api/classes/ItemSectionContinuation.md +++ b/docs/api/classes/ItemSectionContinuation.md @@ -2,41 +2,41 @@ # Class: ItemSectionContinuation +Defined in: [src/parser/continuations.ts:9](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L9) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new ItemSectionContinuation() +### Constructor -> **new ItemSectionContinuation**(`data`): [`ItemSectionContinuation`](ItemSectionContinuation.md) +> **new ItemSectionContinuation**(`data`): `ItemSectionContinuation` + +Defined in: [src/parser/continuations.ts:15](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L15) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`ItemSectionContinuation`](ItemSectionContinuation.md) +`ItemSectionContinuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L15) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### contents -> **contents**: [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> -#### Defined in - -[src/parser/continuations.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L12) +Defined in: [src/parser/continuations.ts:12](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L12) *** @@ -44,9 +44,7 @@ > `optional` **continuation**: `string` -#### Defined in - -[src/parser/continuations.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L13) +Defined in: [src/parser/continuations.ts:13](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L13) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,13 +64,11 @@ > `readonly` `static` **type**: `"itemSectionContinuation"` = `'itemSectionContinuation'` +Defined in: [src/parser/continuations.ts:10](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L10) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L10) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -82,17 +76,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -108,11 +110,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -120,17 +118,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is ItemSectionContinuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -142,11 +148,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -154,17 +156,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -176,35 +186,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -214,8 +228,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/LiveChatContinuation.md b/docs/api/classes/LiveChatContinuation.md index 8030563f..6277412c 100644 --- a/docs/api/classes/LiveChatContinuation.md +++ b/docs/api/classes/LiveChatContinuation.md @@ -2,51 +2,49 @@ # Class: LiveChatContinuation +Defined in: [src/parser/continuations.ts:156](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L156) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new LiveChatContinuation() +### Constructor -> **new LiveChatContinuation**(`data`): [`LiveChatContinuation`](LiveChatContinuation.md) +> **new LiveChatContinuation**(`data`): `LiveChatContinuation` + +Defined in: [src/parser/continuations.ts:174](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L174) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`LiveChatContinuation`](LiveChatContinuation.md) +`LiveChatContinuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:174](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L174) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### action\_panel -> **action\_panel**: `null` \| [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +> **action\_panel**: [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) \| `null` -#### Defined in - -[src/parser/continuations.ts:160](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L160) +Defined in: [src/parser/continuations.ts:160](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L160) *** ### actions -> **actions**: [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **actions**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> -#### Defined in - -[src/parser/continuations.ts:159](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L159) +Defined in: [src/parser/continuations.ts:159](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L159) *** @@ -54,9 +52,7 @@ > **continuation**: [`Continuation`](Continuation.md) -#### Defined in - -[src/parser/continuations.ts:171](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L171) +Defined in: [src/parser/continuations.ts:171](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L171) *** @@ -64,49 +60,55 @@ > **emojis**: `object`[] -#### Defined in +Defined in: [src/parser/continuations.ts:165](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L165) -[src/parser/continuations.ts:165](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L165) +#### emoji\_id + +> **emoji\_id**: `string` + +#### image + +> **image**: [`Thumbnail`](../youtubei.js/namespaces/Misc/classes/Thumbnail.md)[] + +#### search\_terms + +> **search\_terms**: `string`[] + +#### shortcuts + +> **shortcuts**: `string`[] *** ### header -> **header**: `null` \| [`LiveChatHeader`](../namespaces/YTNodes/classes/LiveChatHeader.md) +> **header**: [`LiveChatHeader`](../youtubei.js/namespaces/YTNodes/classes/LiveChatHeader.md) \| `null` -#### Defined in - -[src/parser/continuations.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L162) +Defined in: [src/parser/continuations.ts:162](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L162) *** ### item\_list -> **item\_list**: `null` \| [`LiveChatItemList`](../namespaces/YTNodes/classes/LiveChatItemList.md) +> **item\_list**: [`LiveChatItemList`](../youtubei.js/namespaces/YTNodes/classes/LiveChatItemList.md) \| `null` -#### Defined in - -[src/parser/continuations.ts:161](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L161) +Defined in: [src/parser/continuations.ts:161](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L161) *** ### participants\_list -> **participants\_list**: `null` \| [`LiveChatParticipantsList`](../namespaces/YTNodes/classes/LiveChatParticipantsList.md) +> **participants\_list**: [`LiveChatParticipantsList`](../youtubei.js/namespaces/YTNodes/classes/LiveChatParticipantsList.md) \| `null` -#### Defined in - -[src/parser/continuations.ts:163](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L163) +Defined in: [src/parser/continuations.ts:163](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L163) *** ### popout\_message -> **popout\_message**: `null` \| [`Message`](../namespaces/YTNodes/classes/Message.md) +> **popout\_message**: [`Message`](../youtubei.js/namespaces/YTNodes/classes/Message.md) \| `null` -#### Defined in - -[src/parser/continuations.ts:164](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L164) +Defined in: [src/parser/continuations.ts:164](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L164) *** @@ -114,13 +116,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -128,9 +128,7 @@ > **viewer\_name**: `string` -#### Defined in - -[src/parser/continuations.ts:172](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L172) +Defined in: [src/parser/continuations.ts:172](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L172) *** @@ -138,13 +136,11 @@ > `readonly` `static` **type**: `"liveChatContinuation"` = `'liveChatContinuation'` +Defined in: [src/parser/continuations.ts:157](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L157) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:157](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L157) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -152,17 +148,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -178,11 +182,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -190,17 +190,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatContinuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -212,11 +220,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -224,17 +228,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -246,35 +258,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -284,8 +300,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/MusicPlaylistShelfContinuation.md b/docs/api/classes/MusicPlaylistShelfContinuation.md index a18d7778..9f9ceef3 100644 --- a/docs/api/classes/MusicPlaylistShelfContinuation.md +++ b/docs/api/classes/MusicPlaylistShelfContinuation.md @@ -2,41 +2,41 @@ # Class: MusicPlaylistShelfContinuation +Defined in: [src/parser/continuations.ts:80](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L80) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new MusicPlaylistShelfContinuation() +### Constructor -> **new MusicPlaylistShelfContinuation**(`data`): [`MusicPlaylistShelfContinuation`](MusicPlaylistShelfContinuation.md) +> **new MusicPlaylistShelfContinuation**(`data`): `MusicPlaylistShelfContinuation` + +Defined in: [src/parser/continuations.ts:86](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L86) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`MusicPlaylistShelfContinuation`](MusicPlaylistShelfContinuation.md) +`MusicPlaylistShelfContinuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:86](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L86) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### contents -> **contents**: `null` \| [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null` -#### Defined in - -[src/parser/continuations.ts:84](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L84) +Defined in: [src/parser/continuations.ts:84](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L84) *** @@ -44,9 +44,7 @@ > **continuation**: `string` -#### Defined in - -[src/parser/continuations.ts:83](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L83) +Defined in: [src/parser/continuations.ts:83](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L83) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,13 +64,11 @@ > `readonly` `static` **type**: `"musicPlaylistShelfContinuation"` = `'musicPlaylistShelfContinuation'` +Defined in: [src/parser/continuations.ts:81](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L81) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L81) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -82,17 +76,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -108,11 +110,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -120,17 +118,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is MusicPlaylistShelfContinuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -142,11 +148,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -154,17 +156,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -176,35 +186,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -214,8 +228,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/MusicShelfContinuation.md b/docs/api/classes/MusicShelfContinuation.md index 6e0b1b8f..aed6bf4b 100644 --- a/docs/api/classes/MusicShelfContinuation.md +++ b/docs/api/classes/MusicShelfContinuation.md @@ -2,41 +2,41 @@ # Class: MusicShelfContinuation +Defined in: [src/parser/continuations.ts:93](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L93) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new MusicShelfContinuation() +### Constructor -> **new MusicShelfContinuation**(`data`): [`MusicShelfContinuation`](MusicShelfContinuation.md) +> **new MusicShelfContinuation**(`data`): `MusicShelfContinuation` + +Defined in: [src/parser/continuations.ts:99](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L99) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`MusicShelfContinuation`](MusicShelfContinuation.md) +`MusicShelfContinuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:99](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L99) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### contents -> **contents**: [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> -#### Defined in - -[src/parser/continuations.ts:97](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L97) +Defined in: [src/parser/continuations.ts:97](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L97) *** @@ -44,9 +44,7 @@ > **continuation**: `string` -#### Defined in - -[src/parser/continuations.ts:96](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L96) +Defined in: [src/parser/continuations.ts:96](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L96) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,13 +64,11 @@ > `readonly` `static` **type**: `"musicShelfContinuation"` = `'musicShelfContinuation'` +Defined in: [src/parser/continuations.ts:94](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L94) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L94) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -82,17 +76,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -108,11 +110,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -120,17 +118,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is MusicShelfContinuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -142,11 +148,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -154,17 +156,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -176,35 +186,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -214,8 +228,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/NavigateAction.md b/docs/api/classes/NavigateAction.md index 0a8d06d7..c4f90338 100644 --- a/docs/api/classes/NavigateAction.md +++ b/docs/api/classes/NavigateAction.md @@ -2,41 +2,41 @@ # Class: NavigateAction +Defined in: [src/parser/continuations.ts:24](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L24) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new NavigateAction() +### Constructor -> **new NavigateAction**(`data`): [`NavigateAction`](NavigateAction.md) +> **new NavigateAction**(`data`): `NavigateAction` + +Defined in: [src/parser/continuations.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L29) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`NavigateAction`](NavigateAction.md) +`NavigateAction` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### endpoint -> **endpoint**: [`NavigationEndpoint`](../namespaces/YTNodes/classes/NavigationEndpoint.md) +> **endpoint**: [`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md) -#### Defined in - -[src/parser/continuations.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L27) +Defined in: [src/parser/continuations.ts:27](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L27) *** @@ -44,13 +44,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -58,13 +56,11 @@ > `readonly` `static` **type**: `"navigateAction"` = `'navigateAction'` +Defined in: [src/parser/continuations.ts:25](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L25) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L25) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -72,17 +68,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -98,11 +102,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -110,17 +110,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is NavigateAction & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -132,11 +140,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -144,17 +148,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -166,35 +178,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -204,8 +220,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/OAuth2.md b/docs/api/classes/OAuth2.md index d5697ce4..8ca9e73f 100644 --- a/docs/api/classes/OAuth2.md +++ b/docs/api/classes/OAuth2.md @@ -2,23 +2,25 @@ # Class: OAuth2 +Defined in: [src/core/OAuth2.ts:35](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L35) + ## Constructors -### new OAuth2() +### Constructor -> **new OAuth2**(`session`): [`OAuth2`](OAuth2.md) +> **new OAuth2**(`session`): `OAuth2` + +Defined in: [src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L46) #### Parameters -• **session**: [`Session`](Session.md) +##### session + +[`Session`](Session.md) #### Returns -[`OAuth2`](OAuth2.md) - -#### Defined in - -[src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L46) +`OAuth2` ## Properties @@ -26,9 +28,7 @@ > **AUTH\_SERVER\_CODE\_URL**: `URL` -#### Defined in - -[src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L39) +Defined in: [src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L39) *** @@ -36,9 +36,7 @@ > **AUTH\_SERVER\_REVOKE\_TOKEN\_URL**: `URL` -#### Defined in - -[src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L41) +Defined in: [src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L41) *** @@ -46,29 +44,23 @@ > **AUTH\_SERVER\_TOKEN\_URL**: `URL` -#### Defined in - -[src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L40) +Defined in: [src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L40) *** ### client\_id -> **client\_id**: `undefined` \| [`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md) +> **client\_id**: [`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md) \| `undefined` -#### Defined in - -[src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L43) +Defined in: [src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L43) *** ### oauth2\_tokens -> **oauth2\_tokens**: `undefined` \| [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) +> **oauth2\_tokens**: [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) \| `undefined` -#### Defined in - -[src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L44) +Defined in: [src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L44) *** @@ -76,9 +68,7 @@ > **YTTV\_URL**: `URL` -#### Defined in - -[src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L38) +Defined in: [src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L38) ## Methods @@ -86,119 +76,107 @@ > **cacheCredentials**(): `Promise`\<`void`\> +Defined in: [src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L105) + #### Returns `Promise`\<`void`\> -#### Defined in - -[src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L105) - *** ### getClientID() > **getClientID**(): `Promise`\<[`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md)\> +Defined in: [src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L268) + #### Returns `Promise`\<[`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md)\> -#### Defined in - -[src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L268) - *** ### getDeviceAndUserCode() > **getDeviceAndUserCode**(): `Promise`\<[`DeviceAndUserCode`](../type-aliases/DeviceAndUserCode.md)\> +Defined in: [src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L236) + #### Returns `Promise`\<[`DeviceAndUserCode`](../type-aliases/DeviceAndUserCode.md)\> -#### Defined in - -[src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L236) - *** ### init() -> **init**(`tokens`?): `Promise`\<`void`\> +> **init**(`tokens?`): `Promise`\<`void`\> + +Defined in: [src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L54) #### Parameters -• **tokens?**: [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) +##### tokens? + +[`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) #### Returns `Promise`\<`void`\> -#### Defined in - -[src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L54) - *** ### pollForAccessToken() > **pollForAccessToken**(`device_and_user_code`): `void` +Defined in: [src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L130) + #### Parameters -• **device\_and\_user\_code**: [`DeviceAndUserCode`](../type-aliases/DeviceAndUserCode.md) +##### device\_and\_user\_code + +[`DeviceAndUserCode`](../type-aliases/DeviceAndUserCode.md) #### Returns `void` -#### Defined in - -[src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L130) - *** ### refreshAccessToken() > **refreshAccessToken**(): `Promise`\<`void`\> +Defined in: [src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L197) + #### Returns `Promise`\<`void`\> -#### Defined in - -[src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L197) - *** ### removeCache() > **removeCache**(): `Promise`\<`void`\> +Defined in: [src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L126) + #### Returns `Promise`\<`void`\> -#### Defined in - -[src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L126) - *** ### revokeCredentials() -> **revokeCredentials**(): `Promise`\<`undefined` \| `Response`\> +> **revokeCredentials**(): `Promise`\<`Response` \| `undefined`\> + +Defined in: [src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L185) #### Returns -`Promise`\<`undefined` \| `Response`\> - -#### Defined in - -[src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L185) +`Promise`\<`Response` \| `undefined`\> *** @@ -206,46 +184,44 @@ > **setTokens**(`tokens`): `void` +Defined in: [src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L85) + #### Parameters -• **tokens**: [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) +##### tokens + +[`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) #### Returns `void` -#### Defined in - -[src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L85) - *** ### shouldRefreshToken() > **shouldRefreshToken**(): `boolean` +Defined in: [src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L313) + #### Returns `boolean` -#### Defined in - -[src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L313) - *** ### validateTokens() > **validateTokens**(`tokens`): `boolean` +Defined in: [src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L319) + #### Parameters -• **tokens**: [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) +##### tokens + +[`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) #### Returns `boolean` - -#### Defined in - -[src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L319) diff --git a/docs/api/classes/Platform.md b/docs/api/classes/Platform.md index ebf46381..4e7a3d32 100644 --- a/docs/api/classes/Platform.md +++ b/docs/api/classes/Platform.md @@ -2,29 +2,31 @@ # Class: Platform +Defined in: [src/utils/Utils.ts:15](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Utils.ts#L15) + ## Constructors -### new Platform() +### Constructor -> **new Platform**(): [`Platform`](Platform.md) +> **new Platform**(): `Platform` #### Returns -[`Platform`](Platform.md) +`Platform` ## Accessors ### shim -> `get` `static` **shim**(): [`PlatformShim`](../namespaces/Types/interfaces/PlatformShim.md) +#### Get Signature -#### Returns +> **get** `static` **shim**(): [`PlatformShim`](../youtubei.js/namespaces/Types/interfaces/PlatformShim.md) -[`PlatformShim`](../namespaces/Types/interfaces/PlatformShim.md) +Defined in: [src/utils/Utils.ts:20](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Utils.ts#L20) -#### Defined in +##### Returns -[src/utils/Utils.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L20) +[`PlatformShim`](../youtubei.js/namespaces/Types/interfaces/PlatformShim.md) ## Methods @@ -32,14 +34,14 @@ > `static` **load**(`platform`): `void` +Defined in: [src/utils/Utils.ts:16](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Utils.ts#L16) + #### Parameters -• **platform**: [`PlatformShim`](../namespaces/Types/interfaces/PlatformShim.md) +##### platform + +[`PlatformShim`](../youtubei.js/namespaces/Types/interfaces/PlatformShim.md) #### Returns `void` - -#### Defined in - -[src/utils/Utils.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L16) diff --git a/docs/api/classes/Player.md b/docs/api/classes/Player.md index 4811a719..6c4bd055 100644 --- a/docs/api/classes/Player.md +++ b/docs/api/classes/Player.md @@ -2,39 +2,43 @@ # Class: Player +Defined in: [src/core/Player.ts:37](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L37) + Represents YouTube's player script. This is required to decipher signatures. ## Constructors -### new Player() +### Constructor -> **new Player**(`player_id`, `signature_timestamp`, `data`?): [`Player`](Player.md) +> **new Player**(`player_id`, `signature_timestamp`, `data?`): `Player` + +Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L40) #### Parameters -• **player\_id**: `string` +##### player\_id -• **signature\_timestamp**: `number` +`string` -• **data?**: [`BuildScriptResult`](../namespaces/Types/interfaces/BuildScriptResult.md) +##### signature\_timestamp + +`number` + +##### data? + +[`BuildScriptResult`](../youtubei.js/namespaces/Types/interfaces/BuildScriptResult.md) #### Returns -[`Player`](Player.md) - -#### Defined in - -[src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L40) +`Player` ## Properties ### data? -> `optional` **data**: [`BuildScriptResult`](../namespaces/Types/interfaces/BuildScriptResult.md) +> `optional` **data**: [`BuildScriptResult`](../youtubei.js/namespaces/Types/interfaces/BuildScriptResult.md) -#### Defined in - -[src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L40) +Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L40) *** @@ -42,9 +46,7 @@ Represents YouTube's player script. This is required to decipher signatures. > **player\_id**: `string` -#### Defined in - -[src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L40) +Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L40) *** @@ -52,9 +54,7 @@ Represents YouTube's player script. This is required to decipher signatures. > `optional` **po\_token**: `string` -#### Defined in - -[src/core/Player.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L38) +Defined in: [src/core/Player.ts:38](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L38) *** @@ -62,140 +62,154 @@ Represents YouTube's player script. This is required to decipher signatures. > **signature\_timestamp**: `number` -#### Defined in - -[src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L40) +Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L40) ## Accessors ### url -> `get` **url**(): `string` +#### Get Signature -#### Returns +> **get** **url**(): `string` + +Defined in: [src/core/Player.ts:284](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L284) + +##### Returns `string` -#### Defined in - -[src/core/Player.ts:284](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L284) - *** ### LIBRARY\_VERSION -> `get` `static` **LIBRARY\_VERSION**(): `number` +#### Get Signature -#### Returns +> **get** `static` **LIBRARY\_VERSION**(): `number` + +Defined in: [src/core/Player.ts:288](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L288) + +##### Returns `number` -#### Defined in - -[src/core/Player.ts:288](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L288) - ## Methods ### cache() -> **cache**(`cache`?): `Promise`\<`void`\> +> **cache**(`cache?`): `Promise`\<`void`\> + +Defined in: [src/core/Player.ts:270](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L270) #### Parameters -• **cache?**: [`ICache`](../namespaces/Types/interfaces/ICache.md) +##### cache? + +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) #### Returns `Promise`\<`void`\> -#### Defined in - -[src/core/Player.ts:270](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L270) - *** ### decipher() -> **decipher**(`url`?, `signature_cipher`?, `cipher`?, `this_response_nsig_cache`?): `Promise`\<`string`\> +> **decipher**(`url?`, `signature_cipher?`, `cipher?`, `this_response_nsig_cache?`): `Promise`\<`string`\> + +Defined in: [src/core/Player.ts:134](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L134) #### Parameters -• **url?**: `string` +##### url? -• **signature\_cipher?**: `string` +`string` -• **cipher?**: `string` +##### signature\_cipher? -• **this\_response\_nsig\_cache?**: `Map`\<`string`, `string`\> +`string` + +##### cipher? + +`string` + +##### this\_response\_nsig\_cache? + +`Map`\<`string`, `string`\> #### Returns `Promise`\<`string`\> -#### Defined in - -[src/core/Player.ts:134](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L134) - *** ### create() -> `static` **create**(`cache`, `fetch`, `po_token`?, `player_id`?): `Promise`\<[`Player`](Player.md)\> +> `static` **create**(`cache`, `fetch`, `po_token?`, `player_id?`): `Promise`\<`Player`\> + +Defined in: [src/core/Player.ts:42](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L42) #### Parameters -• **cache**: `undefined` \| [`ICache`](../namespaces/Types/interfaces/ICache.md) +##### cache -• **fetch** = `Platform.shim.fetch` +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) | `undefined` -• **po\_token?**: `string` +##### fetch -• **player\_id?**: `string` +\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \} + +##### po\_token? + +`string` + +##### player\_id? + +`string` #### Returns -`Promise`\<[`Player`](Player.md)\> - -#### Defined in - -[src/core/Player.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L42) +`Promise`\<`Player`\> *** ### fromCache() -> `static` **fromCache**(`cache`, `player_id`): `Promise`\<`null` \| [`Player`](Player.md)\> +> `static` **fromCache**(`cache`, `player_id`): `Promise`\<`Player` \| `null`\> + +Defined in: [src/core/Player.ts:243](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L243) #### Parameters -• **cache**: [`ICache`](../namespaces/Types/interfaces/ICache.md) +##### cache -• **player\_id**: `string` +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) + +##### player\_id + +`string` #### Returns -`Promise`\<`null` \| [`Player`](Player.md)\> - -#### Defined in - -[src/core/Player.ts:243](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L243) +`Promise`\<`Player` \| `null`\> *** ### fromSource() -> `static` **fromSource**(`player_id`, `options`): `Promise`\<[`Player`](Player.md)\> +> `static` **fromSource**(`player_id`, `options`): `Promise`\<`Player`\> + +Defined in: [src/core/Player.ts:264](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Player.ts#L264) #### Parameters -• **player\_id**: `string` +##### player\_id -• **options**: `PlayerInitializationOptions` +`string` + +##### options + +`PlayerInitializationOptions` #### Returns -`Promise`\<[`Player`](Player.md)\> - -#### Defined in - -[src/core/Player.ts:264](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Player.ts#L264) +`Promise`\<`Player`\> diff --git a/docs/api/classes/PlaylistPanelContinuation.md b/docs/api/classes/PlaylistPanelContinuation.md index 0f46f76e..02264a1e 100644 --- a/docs/api/classes/PlaylistPanelContinuation.md +++ b/docs/api/classes/PlaylistPanelContinuation.md @@ -2,41 +2,41 @@ # Class: PlaylistPanelContinuation +Defined in: [src/parser/continuations.ts:125](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L125) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new PlaylistPanelContinuation() +### Constructor -> **new PlaylistPanelContinuation**(`data`): [`PlaylistPanelContinuation`](PlaylistPanelContinuation.md) +> **new PlaylistPanelContinuation**(`data`): `PlaylistPanelContinuation` + +Defined in: [src/parser/continuations.ts:131](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L131) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`PlaylistPanelContinuation`](PlaylistPanelContinuation.md) +`PlaylistPanelContinuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:131](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L131) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### contents -> **contents**: [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> -#### Defined in - -[src/parser/continuations.ts:129](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L129) +Defined in: [src/parser/continuations.ts:129](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L129) *** @@ -44,9 +44,7 @@ > **continuation**: `string` -#### Defined in - -[src/parser/continuations.ts:128](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L128) +Defined in: [src/parser/continuations.ts:128](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L128) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,13 +64,11 @@ > `readonly` `static` **type**: `"playlistPanelContinuation"` = `'playlistPanelContinuation'` +Defined in: [src/parser/continuations.ts:126](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L126) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L126) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -82,17 +76,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -108,11 +110,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -120,17 +118,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistPanelContinuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -142,11 +148,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -154,17 +156,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -176,35 +186,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -214,8 +228,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/ReloadContinuationItemsCommand.md b/docs/api/classes/ReloadContinuationItemsCommand.md index ccdf3c45..89b879dd 100644 --- a/docs/api/classes/ReloadContinuationItemsCommand.md +++ b/docs/api/classes/ReloadContinuationItemsCommand.md @@ -2,41 +2,41 @@ # Class: ReloadContinuationItemsCommand +Defined in: [src/parser/continuations.ts:50](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L50) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new ReloadContinuationItemsCommand() +### Constructor -> **new ReloadContinuationItemsCommand**(`data`): [`ReloadContinuationItemsCommand`](ReloadContinuationItemsCommand.md) +> **new ReloadContinuationItemsCommand**(`data`): `ReloadContinuationItemsCommand` + +Defined in: [src/parser/continuations.ts:57](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L57) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`ReloadContinuationItemsCommand`](ReloadContinuationItemsCommand.md) +`ReloadContinuationItemsCommand` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:57](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L57) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### contents -> **contents**: `null` \| [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null` -#### Defined in - -[src/parser/continuations.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L54) +Defined in: [src/parser/continuations.ts:54](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L54) *** @@ -44,9 +44,7 @@ > `optional` **slot**: `string` -#### Defined in - -[src/parser/continuations.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L55) +Defined in: [src/parser/continuations.ts:55](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L55) *** @@ -54,9 +52,7 @@ > **target\_id**: `string` -#### Defined in - -[src/parser/continuations.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L53) +Defined in: [src/parser/continuations.ts:53](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L53) *** @@ -64,13 +60,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -78,13 +72,11 @@ > `readonly` `static` **type**: `"reloadContinuationItemsCommand"` = `'reloadContinuationItemsCommand'` +Defined in: [src/parser/continuations.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L51) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -92,17 +84,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -118,11 +118,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -130,17 +126,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is ReloadContinuationItemsCommand & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -152,11 +156,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -164,17 +164,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -186,35 +194,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -224,8 +236,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/SectionListContinuation.md b/docs/api/classes/SectionListContinuation.md index b4cc5684..2160a23e 100644 --- a/docs/api/classes/SectionListContinuation.md +++ b/docs/api/classes/SectionListContinuation.md @@ -2,41 +2,41 @@ # Class: SectionListContinuation +Defined in: [src/parser/continuations.ts:65](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L65) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new SectionListContinuation() +### Constructor -> **new SectionListContinuation**(`data`): [`SectionListContinuation`](SectionListContinuation.md) +> **new SectionListContinuation**(`data`): `SectionListContinuation` + +Defined in: [src/parser/continuations.ts:71](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L71) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`SectionListContinuation`](SectionListContinuation.md) +`SectionListContinuation` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:71](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L71) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### contents -> **contents**: `null` \| [`ObservedArray`](../namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../namespaces/Helpers/classes/YTNode.md)\> +> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null` -#### Defined in - -[src/parser/continuations.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L69) +Defined in: [src/parser/continuations.ts:69](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L69) *** @@ -44,9 +44,7 @@ > **continuation**: `string` -#### Defined in - -[src/parser/continuations.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L68) +Defined in: [src/parser/continuations.ts:68](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L68) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,13 +64,11 @@ > `readonly` `static` **type**: `"sectionListContinuation"` = `'sectionListContinuation'` +Defined in: [src/parser/continuations.ts:66](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L66) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:66](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L66) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -82,17 +76,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -108,11 +110,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -120,17 +118,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is SectionListContinuation & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -142,11 +148,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -154,17 +156,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -176,35 +186,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -214,8 +228,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/Session.md b/docs/api/classes/Session.md index b6bbf999..d4d92fbd 100644 --- a/docs/api/classes/Session.md +++ b/docs/api/classes/Session.md @@ -2,6 +2,8 @@ # Class: Session +Defined in: [src/core/Session.ts:251](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L251) + Represents an InnerTube session. This holds all the data needed to make requests to YouTube. ## Extends @@ -10,43 +12,61 @@ Represents an InnerTube session. This holds all the data needed to make requests ## Constructors -### new Session() +### Constructor -> **new Session**(`context`, `api_key`, `api_version`, `account_index`, `config_data`?, `player`?, `cookie`?, `fetch`?, `cache`?, `po_token`?): [`Session`](Session.md) +> **new Session**(`context`, `api_key`, `api_version`, `account_index`, `config_data?`, `player?`, `cookie?`, `fetch?`, `cache?`, `po_token?`): `Session` + +Defined in: [src/core/Session.ts:258](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L258) #### Parameters -• **context**: [`Context`](../type-aliases/Context.md) +##### context -• **api\_key**: `string` +[`Context`](../type-aliases/Context.md) -• **api\_version**: `string` +##### api\_key -• **account\_index**: `number` +`string` -• **config\_data?**: `string` +##### api\_version -• **player?**: [`Player`](Player.md) +`string` -• **cookie?**: `string` +##### account\_index -• **fetch?** +`number` -• **cache?**: [`ICache`](../namespaces/Types/interfaces/ICache.md) +##### config\_data? -• **po\_token?**: `string` +`string` + +##### player? + +[`Player`](Player.md) + +##### cookie? + +`string` + +##### fetch? + +\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \} + +##### cache? + +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) + +##### po\_token? + +`string` #### Returns -[`Session`](Session.md) +`Session` #### Overrides -[`EventEmitter`](EventEmitter.md).[`constructor`](EventEmitter.md#constructors) - -#### Defined in - -[src/core/Session.ts:258](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L258) +[`EventEmitter`](EventEmitter.md).[`constructor`](EventEmitter.md#constructor) ## Properties @@ -54,9 +74,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > **account\_index**: `number` -#### Defined in - -[src/core/Session.ts:262](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L262) +Defined in: [src/core/Session.ts:262](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L262) *** @@ -64,9 +82,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > **actions**: [`Actions`](Actions.md) -#### Defined in - -[src/core/Session.ts:255](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L255) +Defined in: [src/core/Session.ts:255](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L255) *** @@ -74,9 +90,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > **api\_key**: `string` -#### Defined in - -[src/core/Session.ts:260](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L260) +Defined in: [src/core/Session.ts:260](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L260) *** @@ -84,19 +98,15 @@ Represents an InnerTube session. This holds all the data needed to make requests > **api\_version**: `string` -#### Defined in - -[src/core/Session.ts:261](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L261) +Defined in: [src/core/Session.ts:261](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L261) *** ### cache? -> `optional` **cache**: [`ICache`](../namespaces/Types/interfaces/ICache.md) +> `optional` **cache**: [`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) -#### Defined in - -[src/core/Session.ts:267](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L267) +Defined in: [src/core/Session.ts:267](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L267) *** @@ -104,9 +114,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > `optional` **config\_data**: `string` -#### Defined in - -[src/core/Session.ts:263](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L263) +Defined in: [src/core/Session.ts:263](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L263) *** @@ -114,9 +122,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > **context**: [`Context`](../type-aliases/Context.md) -#### Defined in - -[src/core/Session.ts:259](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L259) +Defined in: [src/core/Session.ts:259](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L259) *** @@ -124,9 +130,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > `optional` **cookie**: `string` -#### Defined in - -[src/core/Session.ts:265](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L265) +Defined in: [src/core/Session.ts:265](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L265) *** @@ -134,9 +138,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > **http**: [`HTTPClient`](HTTPClient.md) -#### Defined in - -[src/core/Session.ts:253](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L253) +Defined in: [src/core/Session.ts:253](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L253) *** @@ -144,9 +146,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > **logged\_in**: `boolean` -#### Defined in - -[src/core/Session.ts:254](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L254) +Defined in: [src/core/Session.ts:254](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L254) *** @@ -154,9 +154,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > **oauth**: [`OAuth2`](OAuth2.md) -#### Defined in - -[src/core/Session.ts:252](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L252) +Defined in: [src/core/Session.ts:252](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L252) *** @@ -164,9 +162,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > `optional` **player**: [`Player`](Player.md) -#### Defined in - -[src/core/Session.ts:264](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L264) +Defined in: [src/core/Session.ts:264](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L264) *** @@ -174,9 +170,7 @@ Represents an InnerTube session. This holds all the data needed to make requests > `optional` **po\_token**: `string` -#### Defined in - -[src/core/Session.ts:268](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L268) +Defined in: [src/core/Session.ts:268](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L268) *** @@ -184,57 +178,57 @@ Represents an InnerTube session. This holds all the data needed to make requests > `optional` **user\_agent**: `string` -#### Defined in - -[src/core/Session.ts:256](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L256) +Defined in: [src/core/Session.ts:256](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L256) ## Accessors ### client\_name -> `get` **client\_name**(): `string` +#### Get Signature -#### Returns +> **get** **client\_name**(): `string` + +Defined in: [src/core/Session.ts:688](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L688) + +##### Returns `string` -#### Defined in - -[src/core/Session.ts:688](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L688) - *** ### client\_version -> `get` **client\_version**(): `string` +#### Get Signature -#### Returns +> **get** **client\_version**(): `string` + +Defined in: [src/core/Session.ts:684](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L684) + +##### Returns `string` -#### Defined in - -[src/core/Session.ts:684](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L684) - *** ### lang -> `get` **lang**(): `string` +#### Get Signature -#### Returns +> **get** **lang**(): `string` + +Defined in: [src/core/Session.ts:692](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L692) + +##### Returns `string` -#### Defined in - -[src/core/Session.ts:692](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L692) - ## Methods ### addEventListener() -> **addEventListener**(`type`, `callback`, `options`?): `void` +> **addEventListener**(`type`, `callback`, `options?`): `void` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8256 Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched. @@ -254,11 +248,17 @@ The event listener is appended to target's event listener list and is not append #### Parameters -• **type**: `string` +##### type -• **callback**: `null` \| `EventListenerOrEventListenerObject` +`string` -• **options?**: `boolean` \| `AddEventListenerOptions` +##### callback + +`EventListenerOrEventListenerObject` | `null` + +##### options? + +`boolean` | `AddEventListenerOptions` #### Returns @@ -268,23 +268,23 @@ The event listener is appended to target's event listener list and is not append [`EventEmitter`](EventEmitter.md).[`addEventListener`](EventEmitter.md#addeventlistener) -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8256 - *** ### dispatchEvent() > **dispatchEvent**(`event`): `boolean` +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8262 + Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) #### Parameters -• **event**: `Event` +##### event + +`Event` #### Returns @@ -294,21 +294,23 @@ Dispatches a synthetic event event to target and returns true if either event's [`EventEmitter`](EventEmitter.md).[`dispatchEvent`](EventEmitter.md#dispatchevent) -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8262 - *** ### emit() > **emit**(`type`, ...`args`): `void` +Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L10) + #### Parameters -• **type**: `string` +##### type -• ...**args**: `any`[] +`string` + +##### args + +...`any`[] #### Returns @@ -318,21 +320,23 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 [`EventEmitter`](EventEmitter.md).[`emit`](EventEmitter.md#emit) -#### Defined in - -[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L10) - *** ### off() > **off**(`type`, `listener`): `void` +Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/EventEmitterLike.ts#L40) + #### Parameters -• **type**: `string` +##### type -• **listener** +`string` + +##### listener + +(...`args`) => `void` #### Returns @@ -342,23 +346,25 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 [`EventEmitter`](EventEmitter.md).[`off`](EventEmitter.md#off) -#### Defined in - -[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L40) - *** ### on() -#### on(type, listener) +#### Call Signature > **on**(`type`, `listener`): `void` +Defined in: [src/core/Session.ts:278](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L278) + ##### Parameters -• **type**: `"auth"` +###### type -• **listener**: [`OAuth2AuthEventHandler`](../type-aliases/OAuth2AuthEventHandler.md) +`"auth"` + +###### listener + +[`OAuth2AuthEventHandler`](../type-aliases/OAuth2AuthEventHandler.md) ##### Returns @@ -368,19 +374,21 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 [`EventEmitter`](EventEmitter.md).[`on`](EventEmitter.md#on) -##### Defined in - -[src/core/Session.ts:278](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L278) - -#### on(type, listener) +#### Call Signature > **on**(`type`, `listener`): `void` +Defined in: [src/core/Session.ts:279](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L279) + ##### Parameters -• **type**: `"auth-pending"` +###### type -• **listener**: [`OAuth2AuthPendingEventHandler`](../type-aliases/OAuth2AuthPendingEventHandler.md) +`"auth-pending"` + +###### listener + +[`OAuth2AuthPendingEventHandler`](../type-aliases/OAuth2AuthPendingEventHandler.md) ##### Returns @@ -390,19 +398,21 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 `EventEmitter.on` -##### Defined in - -[src/core/Session.ts:279](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L279) - -#### on(type, listener) +#### Call Signature > **on**(`type`, `listener`): `void` +Defined in: [src/core/Session.ts:280](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L280) + ##### Parameters -• **type**: `"auth-error"` +###### type -• **listener**: [`OAuth2AuthErrorEventHandler`](../type-aliases/OAuth2AuthErrorEventHandler.md) +`"auth-error"` + +###### listener + +[`OAuth2AuthErrorEventHandler`](../type-aliases/OAuth2AuthErrorEventHandler.md) ##### Returns @@ -412,19 +422,21 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 `EventEmitter.on` -##### Defined in - -[src/core/Session.ts:280](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L280) - -#### on(type, listener) +#### Call Signature > **on**(`type`, `listener`): `void` +Defined in: [src/core/Session.ts:281](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L281) + ##### Parameters -• **type**: `"update-credentials"` +###### type -• **listener**: [`OAuth2AuthEventHandler`](../type-aliases/OAuth2AuthEventHandler.md) +`"update-credentials"` + +###### listener + +[`OAuth2AuthEventHandler`](../type-aliases/OAuth2AuthEventHandler.md) ##### Returns @@ -434,23 +446,25 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 `EventEmitter.on` -##### Defined in - -[src/core/Session.ts:281](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L281) - *** ### once() -#### once(type, listener) +#### Call Signature > **once**(`type`, `listener`): `void` +Defined in: [src/core/Session.ts:287](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L287) + ##### Parameters -• **type**: `"auth"` +###### type -• **listener**: [`OAuth2AuthEventHandler`](../type-aliases/OAuth2AuthEventHandler.md) +`"auth"` + +###### listener + +[`OAuth2AuthEventHandler`](../type-aliases/OAuth2AuthEventHandler.md) ##### Returns @@ -460,19 +474,21 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 [`EventEmitter`](EventEmitter.md).[`once`](EventEmitter.md#once) -##### Defined in - -[src/core/Session.ts:287](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L287) - -#### once(type, listener) +#### Call Signature > **once**(`type`, `listener`): `void` +Defined in: [src/core/Session.ts:288](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L288) + ##### Parameters -• **type**: `"auth-pending"` +###### type -• **listener**: [`OAuth2AuthPendingEventHandler`](../type-aliases/OAuth2AuthPendingEventHandler.md) +`"auth-pending"` + +###### listener + +[`OAuth2AuthPendingEventHandler`](../type-aliases/OAuth2AuthPendingEventHandler.md) ##### Returns @@ -482,19 +498,21 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 `EventEmitter.once` -##### Defined in - -[src/core/Session.ts:288](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L288) - -#### once(type, listener) +#### Call Signature > **once**(`type`, `listener`): `void` +Defined in: [src/core/Session.ts:289](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L289) + ##### Parameters -• **type**: `"auth-error"` +###### type -• **listener**: [`OAuth2AuthErrorEventHandler`](../type-aliases/OAuth2AuthErrorEventHandler.md) +`"auth-error"` + +###### listener + +[`OAuth2AuthErrorEventHandler`](../type-aliases/OAuth2AuthErrorEventHandler.md) ##### Returns @@ -504,15 +522,13 @@ node\_modules/typescript/lib/lib.dom.d.ts:8262 `EventEmitter.once` -##### Defined in - -[src/core/Session.ts:289](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L289) - *** ### removeEventListener() -> **removeEventListener**(`type`, `callback`, `options`?): `void` +> **removeEventListener**(`type`, `callback`, `options?`): `void` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8268 Removes the event listener in target's event listener list with the same type, callback, and options. @@ -520,11 +536,17 @@ Removes the event listener in target's event listener list with the same type, c #### Parameters -• **type**: `string` +##### type -• **callback**: `null` \| `EventListenerOrEventListenerObject` +`string` -• **options?**: `boolean` \| `EventListenerOptions` +##### callback + +`EventListenerOrEventListenerObject` | `null` + +##### options? + +`boolean` | `EventListenerOptions` #### Returns @@ -534,152 +556,158 @@ Removes the event listener in target's event listener list with the same type, c [`EventEmitter`](EventEmitter.md).[`removeEventListener`](EventEmitter.md#removeeventlistener) -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8268 - *** ### signIn() -> **signIn**(`credentials`?): `Promise`\<`void`\> +> **signIn**(`credentials?`): `Promise`\<`void`\> + +Defined in: [src/core/Session.ts:651](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L651) #### Parameters -• **credentials?**: [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) +##### credentials? + +[`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) #### Returns `Promise`\<`void`\> -#### Defined in - -[src/core/Session.ts:651](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L651) - *** ### signOut() -> **signOut**(): `Promise`\<`undefined` \| `Response`\> +> **signOut**(): `Promise`\<`Response` \| `undefined`\> + +Defined in: [src/core/Session.ts:674](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L674) Signs out of the current account and revokes the credentials. #### Returns -`Promise`\<`undefined` \| `Response`\> - -#### Defined in - -[src/core/Session.ts:674](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L674) +`Promise`\<`Response` \| `undefined`\> *** ### create() -> `static` **create**(`options`): `Promise`\<[`Session`](Session.md)\> +> `static` **create**(`options`): `Promise`\<`Session`\> + +Defined in: [src/core/Session.ts:295](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L295) #### Parameters -• **options**: [`SessionOptions`](../type-aliases/SessionOptions.md) = `{}` +##### options + +[`SessionOptions`](../type-aliases/SessionOptions.md) = `{}` #### Returns -`Promise`\<[`Session`](Session.md)\> - -#### Defined in - -[src/core/Session.ts:295](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L295) +`Promise`\<`Session`\> *** ### fromCache() -> `static` **fromCache**(`cache`, `session_args`): `Promise`\<`null` \| [`SessionData`](../type-aliases/SessionData.md)\> +> `static` **fromCache**(`cache`, `session_args`): `Promise`\<[`SessionData`](../type-aliases/SessionData.md) \| `null`\> + +Defined in: [src/core/Session.ts:327](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L327) Retrieves session data from cache. #### Parameters -• **cache**: [`ICache`](../namespaces/Types/interfaces/ICache.md) +##### cache + +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) A valid cache implementation. -• **session\_args**: [`SessionArgs`](../type-aliases/SessionArgs.md) +##### session\_args + +[`SessionArgs`](../type-aliases/SessionArgs.md) User provided session arguments. #### Returns -`Promise`\<`null` \| [`SessionData`](../type-aliases/SessionData.md)\> - -#### Defined in - -[src/core/Session.ts:327](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L327) +`Promise`\<[`SessionData`](../type-aliases/SessionData.md) \| `null`\> *** ### getSessionData() -> `static` **getSessionData**(`lang`, `location`, `account_index`, `visitor_data`, `user_agent`, `enable_safety_mode`, `generate_session_locally`, `device_category`, `client_name`, `tz`, `fetch`, `on_behalf_of_user`?, `cache`?, `enable_session_cache`?, `po_token`?, `retrieve_innertube_config`?): `Promise`\<`object`\> +> `static` **getSessionData**(`lang`, `location`, `account_index`, `visitor_data`, `user_agent`, `enable_safety_mode`, `generate_session_locally`, `device_category`, `client_name`, `tz`, `fetch`, `on_behalf_of_user?`, `cache?`, `enable_session_cache?`, `po_token?`, `retrieve_innertube_config?`): `Promise`\<\{ `account_index`: `number`; `api_key`: `string`; `api_version`: `string`; `config_data?`: `string`; `context`: [`Context`](../type-aliases/Context.md); \}\> + +Defined in: [src/core/Session.ts:376](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L376) #### Parameters -• **lang**: `string` = `''` +##### lang -• **location**: `string` = `''` +`string` = `''` -• **account\_index**: `number` = `0` +##### location -• **visitor\_data**: `string` = `''` - -• **user\_agent**: `string` = `...` - -• **enable\_safety\_mode**: `boolean` = `false` - -• **generate\_session\_locally**: `boolean` = `false` - -• **device\_category**: [`DeviceCategory`](../namespaces/Utils/type-aliases/DeviceCategory.md) = `'desktop'` - -• **client\_name**: [`ClientType`](../enumerations/ClientType.md) = `ClientType.WEB` - -• **tz**: `string` = `...` - -• **fetch** = `Platform.shim.fetch` - -• **on\_behalf\_of\_user?**: `string` - -• **cache?**: [`ICache`](../namespaces/Types/interfaces/ICache.md) - -• **enable\_session\_cache?**: `boolean` = `true` - -• **po\_token?**: `string` - -• **retrieve\_innertube\_config?**: `boolean` = `true` - -#### Returns - -`Promise`\<`object`\> +`string` = `''` ##### account\_index -> **account\_index**: `number` +`number` = `0` -##### api\_key +##### visitor\_data -> **api\_key**: `string` +`string` = `''` -##### api\_version +##### user\_agent -> **api\_version**: `string` +`string` = `...` -##### config\_data? +##### enable\_safety\_mode -> `optional` **config\_data**: `string` +`boolean` = `false` -##### context +##### generate\_session\_locally -> **context**: [`Context`](../type-aliases/Context.md) +`boolean` = `false` -#### Defined in +##### device\_category -[src/core/Session.ts:376](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L376) +[`DeviceCategory`](../youtubei.js/namespaces/Utils/type-aliases/DeviceCategory.md) = `'desktop'` + +##### client\_name + +[`ClientType`](../enumerations/ClientType.md) = `ClientType.WEB` + +##### tz + +`string` = `...` + +##### fetch + +\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \} + +##### on\_behalf\_of\_user? + +`string` + +##### cache? + +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) + +##### enable\_session\_cache? + +`boolean` = `true` + +##### po\_token? + +`string` + +##### retrieve\_innertube\_config? + +`boolean` = `true` + +#### Returns + +`Promise`\<\{ `account_index`: `number`; `api_key`: `string`; `api_version`: `string`; `config_data?`: `string`; `context`: [`Context`](../type-aliases/Context.md); \}\> diff --git a/docs/api/classes/ShowMiniplayerCommand.md b/docs/api/classes/ShowMiniplayerCommand.md index e448baf2..7e4ff19e 100644 --- a/docs/api/classes/ShowMiniplayerCommand.md +++ b/docs/api/classes/ShowMiniplayerCommand.md @@ -2,41 +2,41 @@ # Class: ShowMiniplayerCommand +Defined in: [src/parser/continuations.ts:35](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L35) + ## Extends -- [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) ## Constructors -### new ShowMiniplayerCommand() +### Constructor -> **new ShowMiniplayerCommand**(`data`): [`ShowMiniplayerCommand`](ShowMiniplayerCommand.md) +> **new ShowMiniplayerCommand**(`data`): `ShowMiniplayerCommand` + +Defined in: [src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L41) #### Parameters -• **data**: [`RawNode`](../namespaces/APIResponseTypes/type-aliases/RawNode.md) +##### data + +[`RawNode`](../type-aliases/RawNode.md) #### Returns -[`ShowMiniplayerCommand`](ShowMiniplayerCommand.md) +`ShowMiniplayerCommand` #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`constructor`](../namespaces/Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor) ## Properties ### miniplayer\_command -> **miniplayer\_command**: [`NavigationEndpoint`](../namespaces/YTNodes/classes/NavigationEndpoint.md) +> **miniplayer\_command**: [`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md) -#### Defined in - -[src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L38) +Defined in: [src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L38) *** @@ -44,9 +44,7 @@ > **show\_premium\_branding**: `boolean` -#### Defined in - -[src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L39) +Defined in: [src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L39) *** @@ -54,13 +52,11 @@ > `readonly` **type**: `string` +Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8) + #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type) *** @@ -68,13 +64,11 @@ > `readonly` `static` **type**: `"showMiniplayerCommand"` = `'showMiniplayerCommand'` +Defined in: [src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L36) + #### Overrides -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`type`](../namespaces/Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/continuations.ts#L36) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1) ## Methods @@ -82,17 +76,25 @@ > **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> +Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29) + Cast to one of the given types. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The types to cast to @@ -108,11 +110,7 @@ If the node is not of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`as`](../namespaces/Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as) *** @@ -120,17 +118,25 @@ If the node is not of the given type > **hasKey**\<`T`, `R`\>(`key`): `this is ShowMiniplayerCommand & { [k in string]: R }` +Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41) + Check for a key without asserting the type. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check @@ -142,11 +148,7 @@ Whether the node has the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`hasKey`](../namespaces/Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey) *** @@ -154,17 +156,25 @@ Whether the node has the key > **is**\<`T`, `K`\>(...`types`): `this is InstanceType` +Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19) + Check if the node is of the given type. #### Type Parameters -• **T** *extends* [`YTNode`](../namespaces/Helpers/classes/YTNode.md) +##### T -• **K** *extends* [`YTNodeConstructor`](../namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] +`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) + +##### K + +`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] #### Parameters -• ...**types**: `K` +##### types + +...`K` The type to check @@ -176,35 +186,39 @@ whether the node is of the given type #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`is`](../namespaces/Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is) *** ### key() -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../namespaces/Helpers/classes/Maybe.md) +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) + +Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51) Assert that the node has the given key and return it. #### Type Parameters -• **T** *extends* `string` +##### T -• **R** = `any` +`T` *extends* `string` + +##### R + +`R` = `any` #### Parameters -• **key**: `T` +##### key + +`T` The key to check #### Returns -[`Maybe`](../namespaces/Helpers/classes/Maybe.md) +[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md) The value of the key wrapped in a Maybe @@ -214,8 +228,4 @@ If the node does not have the key #### Inherited from -[`YTNode`](../namespaces/Helpers/classes/YTNode.md).[`key`](../namespaces/Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) +[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key) diff --git a/docs/api/classes/UniversalCache.md b/docs/api/classes/UniversalCache.md index 2918e1ad..04bc18d4 100644 --- a/docs/api/classes/UniversalCache.md +++ b/docs/api/classes/UniversalCache.md @@ -2,69 +2,73 @@ # Class: UniversalCache +Defined in: [src/utils/Cache.ts:4](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Cache.ts#L4) + ## Implements -- [`ICache`](../namespaces/Types/interfaces/ICache.md) +- [`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) ## Constructors -### new UniversalCache() +### Constructor -> **new UniversalCache**(`persistent`, `persistent_directory`?): [`UniversalCache`](UniversalCache.md) +> **new UniversalCache**(`persistent`, `persistent_directory?`): `UniversalCache` + +Defined in: [src/utils/Cache.ts:6](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Cache.ts#L6) #### Parameters -• **persistent**: `boolean` +##### persistent -• **persistent\_directory?**: `string` +`boolean` + +##### persistent\_directory? + +`string` #### Returns -[`UniversalCache`](UniversalCache.md) - -#### Defined in - -[src/utils/Cache.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Cache.ts#L6) +`UniversalCache` ## Accessors ### cache\_dir -> `get` **cache\_dir**(): `string` +#### Get Signature -#### Returns +> **get** **cache\_dir**(): `string` + +Defined in: [src/utils/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Cache.ts#L9) + +##### Returns `string` #### Implementation of -[`ICache`](../namespaces/Types/interfaces/ICache.md).[`cache_dir`](../namespaces/Types/interfaces/ICache.md#cache_dir) - -#### Defined in - -[src/utils/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Cache.ts#L9) +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md).[`cache_dir`](../youtubei.js/namespaces/Types/interfaces/ICache.md#cache_dir) ## Methods ### get() -> **get**(`key`): `Promise`\<`undefined` \| `ArrayBuffer`\> +> **get**(`key`): `Promise`\<`ArrayBuffer` \| `undefined`\> + +Defined in: [src/utils/Cache.ts:12](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Cache.ts#L12) #### Parameters -• **key**: `string` +##### key + +`string` #### Returns -`Promise`\<`undefined` \| `ArrayBuffer`\> +`Promise`\<`ArrayBuffer` \| `undefined`\> #### Implementation of -[`ICache`](../namespaces/Types/interfaces/ICache.md).[`get`](../namespaces/Types/interfaces/ICache.md#get) - -#### Defined in - -[src/utils/Cache.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Cache.ts#L12) +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md).[`get`](../youtubei.js/namespaces/Types/interfaces/ICache.md#get) *** @@ -72,9 +76,13 @@ > **remove**(`key`): `Promise`\<`void`\> +Defined in: [src/utils/Cache.ts:18](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Cache.ts#L18) + #### Parameters -• **key**: `string` +##### key + +`string` #### Returns @@ -82,11 +90,7 @@ #### Implementation of -[`ICache`](../namespaces/Types/interfaces/ICache.md).[`remove`](../namespaces/Types/interfaces/ICache.md#remove) - -#### Defined in - -[src/utils/Cache.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Cache.ts#L18) +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md).[`remove`](../youtubei.js/namespaces/Types/interfaces/ICache.md#remove) *** @@ -94,11 +98,17 @@ > **set**(`key`, `value`): `Promise`\<`void`\> +Defined in: [src/utils/Cache.ts:15](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/Cache.ts#L15) + #### Parameters -• **key**: `string` +##### key -• **value**: `ArrayBuffer` +`string` + +##### value + +`ArrayBuffer` #### Returns @@ -106,8 +116,4 @@ #### Implementation of -[`ICache`](../namespaces/Types/interfaces/ICache.md).[`set`](../namespaces/Types/interfaces/ICache.md#set) - -#### Defined in - -[src/utils/Cache.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Cache.ts#L15) +[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md).[`set`](../youtubei.js/namespaces/Types/interfaces/ICache.md#set) diff --git a/docs/api/enumerations/ClientType.md b/docs/api/enumerations/ClientType.md index 22a09a5e..1cbcb0fa 100644 --- a/docs/api/enumerations/ClientType.md +++ b/docs/api/enumerations/ClientType.md @@ -2,15 +2,15 @@ # Enumeration: ClientType +Defined in: [src/core/Session.ts:22](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L22) + ## Enumeration Members ### ANDROID > **ANDROID**: `"ANDROID"` -#### Defined in - -[src/core/Session.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L28) +Defined in: [src/core/Session.ts:28](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L28) *** @@ -18,9 +18,7 @@ > **ANDROID\_CREATOR**: `"ANDROID_CREATOR"` -#### Defined in - -[src/core/Session.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L30) +Defined in: [src/core/Session.ts:30](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L30) *** @@ -28,9 +26,7 @@ > **ANDROID\_MUSIC**: `"ANDROID_MUSIC"` -#### Defined in - -[src/core/Session.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L29) +Defined in: [src/core/Session.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L29) *** @@ -38,9 +34,7 @@ > **IOS**: `"iOS"` -#### Defined in - -[src/core/Session.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L27) +Defined in: [src/core/Session.ts:27](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L27) *** @@ -48,9 +42,7 @@ > **KIDS**: `"WEB_KIDS"` -#### Defined in - -[src/core/Session.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L25) +Defined in: [src/core/Session.ts:25](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L25) *** @@ -58,9 +50,7 @@ > **MUSIC**: `"WEB_REMIX"` -#### Defined in - -[src/core/Session.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L26) +Defined in: [src/core/Session.ts:26](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L26) *** @@ -68,9 +58,7 @@ > **MWEB**: `"MWEB"` -#### Defined in - -[src/core/Session.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L24) +Defined in: [src/core/Session.ts:24](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L24) *** @@ -78,9 +66,7 @@ > **TV**: `"TVHTML5"` -#### Defined in - -[src/core/Session.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L31) +Defined in: [src/core/Session.ts:31](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L31) *** @@ -88,9 +74,7 @@ > **TV\_EMBEDDED**: `"TVHTML5_SIMPLY_EMBEDDED_PLAYER"` -#### Defined in - -[src/core/Session.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L33) +Defined in: [src/core/Session.ts:33](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L33) *** @@ -98,9 +82,7 @@ > **TV\_SIMPLY**: `"TVHTML5_SIMPLY"` -#### Defined in - -[src/core/Session.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L32) +Defined in: [src/core/Session.ts:32](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L32) *** @@ -108,9 +90,7 @@ > **WEB**: `"WEB"` -#### Defined in - -[src/core/Session.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L23) +Defined in: [src/core/Session.ts:23](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L23) *** @@ -118,9 +98,7 @@ > **WEB\_CREATOR**: `"WEB_CREATOR"` -#### Defined in - -[src/core/Session.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L35) +Defined in: [src/core/Session.ts:35](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L35) *** @@ -128,6 +106,4 @@ > **WEB\_EMBEDDED**: `"WEB_EMBEDDED_PLAYER"` -#### Defined in - -[src/core/Session.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L34) +Defined in: [src/core/Session.ts:34](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L34) diff --git a/docs/api/interfaces/ApiResponse.md b/docs/api/interfaces/ApiResponse.md index 639bbc09..dec7ff1a 100644 --- a/docs/api/interfaces/ApiResponse.md +++ b/docs/api/interfaces/ApiResponse.md @@ -2,15 +2,15 @@ # Interface: ApiResponse +Defined in: [src/core/Actions.ts:18](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L18) + ## Properties ### data -> **data**: [`IRawResponse`](../namespaces/APIResponseTypes/interfaces/IRawResponse.md) +> **data**: [`IRawResponse`](IRawResponse.md) -#### Defined in - -[src/core/Actions.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L21) +Defined in: [src/core/Actions.ts:21](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L21) *** @@ -18,9 +18,7 @@ > **status\_code**: `number` -#### Defined in - -[src/core/Actions.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L20) +Defined in: [src/core/Actions.ts:20](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L20) *** @@ -28,6 +26,4 @@ > **success**: `boolean` -#### Defined in - -[src/core/Actions.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L19) +Defined in: [src/core/Actions.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L19) diff --git a/docs/api/interfaces/HTTPClientInit.md b/docs/api/interfaces/HTTPClientInit.md index 016f524a..8c7e21c8 100644 --- a/docs/api/interfaces/HTTPClientInit.md +++ b/docs/api/interfaces/HTTPClientInit.md @@ -2,12 +2,12 @@ # Interface: HTTPClientInit +Defined in: [src/utils/HTTPClient.ts:13](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/HTTPClient.ts#L13) + ## Properties ### baseURL? > `optional` **baseURL**: `string` -#### Defined in - -[src/utils/HTTPClient.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/HTTPClient.ts#L14) +Defined in: [src/utils/HTTPClient.ts:14](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/utils/HTTPClient.ts#L14) diff --git a/docs/api/namespaces/APIResponseTypes/README.md b/docs/api/namespaces/APIResponseTypes/README.md deleted file mode 100644 index 2ddf58ad..00000000 --- a/docs/api/namespaces/APIResponseTypes/README.md +++ /dev/null @@ -1,63 +0,0 @@ -[youtubei.js](../../README.md) / APIResponseTypes - -# APIResponseTypes - -## Index - -### Interfaces - -- [IBotguardChallenge](interfaces/IBotguardChallenge.md) -- [IEndpoint](interfaces/IEndpoint.md) -- [IParsedResponse](interfaces/IParsedResponse.md) -- [IPlayabilityStatus](interfaces/IPlayabilityStatus.md) -- [IPlaybackTracking](interfaces/IPlaybackTracking.md) -- [IPlayerConfig](interfaces/IPlayerConfig.md) -- [IRawBotguardChallenge](interfaces/IRawBotguardChallenge.md) -- [IRawPlayerConfig](interfaces/IRawPlayerConfig.md) -- [IRawResponse](interfaces/IRawResponse.md) -- [IRawTrustedResource](interfaces/IRawTrustedResource.md) -- [IStreamingData](interfaces/IStreamingData.md) -- [ITrustedResource](interfaces/ITrustedResource.md) - -### Type Aliases - -- [AddToPlaylistServiceRequest](type-aliases/AddToPlaylistServiceRequest.md) -- [BrowseRequest](type-aliases/BrowseRequest.md) -- [BrowseRequestSupportedMetadata](type-aliases/BrowseRequestSupportedMetadata.md) -- [ContinuationRequest](type-aliases/ContinuationRequest.md) -- [CreateCommentRequest](type-aliases/CreateCommentRequest.md) -- [CreatePlaylistServiceRequest](type-aliases/CreatePlaylistServiceRequest.md) -- [DeletePlaylistServiceRequest](type-aliases/DeletePlaylistServiceRequest.md) -- [FeedbackContext](type-aliases/FeedbackContext.md) -- [FeedbackRequest](type-aliases/FeedbackRequest.md) -- [FormData](type-aliases/FormData.md) -- [GetAccountsListInnertubeRequest](type-aliases/GetAccountsListInnertubeRequest.md) -- [GetKidsBlocklistPickerRequest](type-aliases/GetKidsBlocklistPickerRequest.md) -- [IBrowseResponse](type-aliases/IBrowseResponse.md) -- [IGetChallengeResponse](type-aliases/IGetChallengeResponse.md) -- [IGetNotificationsMenuResponse](type-aliases/IGetNotificationsMenuResponse.md) -- [IGetTranscriptResponse](type-aliases/IGetTranscriptResponse.md) -- [IGuideResponse](type-aliases/IGuideResponse.md) -- [INextResponse](type-aliases/INextResponse.md) -- [InlineSettingStatus](type-aliases/InlineSettingStatus.md) -- [IPlayerResponse](type-aliases/IPlayerResponse.md) -- [IResolveURLResponse](type-aliases/IResolveURLResponse.md) -- [ISearchResponse](type-aliases/ISearchResponse.md) -- [IUpdatedMetadataResponse](type-aliases/IUpdatedMetadataResponse.md) -- [LikeRequest](type-aliases/LikeRequest.md) -- [LikeTarget](type-aliases/LikeTarget.md) -- [LiveChatItemContextMenuRequest](type-aliases/LiveChatItemContextMenuRequest.md) -- [ModifyChannelNotificationPreferenceRequest](type-aliases/ModifyChannelNotificationPreferenceRequest.md) -- [NextNavendpoint](type-aliases/NextNavendpoint.md) -- [PerformCommentActionRequest](type-aliases/PerformCommentActionRequest.md) -- [PlaylistEditRequest](type-aliases/PlaylistEditRequest.md) -- [PlaylistPrivacyStatus](type-aliases/PlaylistPrivacyStatus.md) -- [RawData](type-aliases/RawData.md) -- [RawNode](type-aliases/RawNode.md) -- [ReelWatchRequest](type-aliases/ReelWatchRequest.md) -- [SearchRequest](type-aliases/SearchRequest.md) -- [ShareEntityServiceRequest](type-aliases/ShareEntityServiceRequest.md) -- [SubscribeRequest](type-aliases/SubscribeRequest.md) -- [UnsubscribeRequest](type-aliases/UnsubscribeRequest.md) -- [WatchNextRequest](type-aliases/WatchNextRequest.md) -- [WatchRequest](type-aliases/WatchRequest.md) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IBotguardChallenge.md b/docs/api/namespaces/APIResponseTypes/interfaces/IBotguardChallenge.md deleted file mode 100644 index 17ec6928..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IBotguardChallenge.md +++ /dev/null @@ -1,53 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IBotguardChallenge - -# Interface: IBotguardChallenge - -## Properties - -### client\_experiments\_state\_blob - -> **client\_experiments\_state\_blob**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:96](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L96) - -*** - -### global\_name - -> **global\_name**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:95](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L95) - -*** - -### interpreter\_hash - -> **interpreter\_hash**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:93](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L93) - -*** - -### interpreter\_url - -> **interpreter\_url**: [`ITrustedResource`](ITrustedResource.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:92](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L92) - -*** - -### program - -> **program**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L94) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IEndpoint.md b/docs/api/namespaces/APIResponseTypes/interfaces/IEndpoint.md deleted file mode 100644 index 0ef6fc56..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IEndpoint.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IEndpoint - -# Interface: IEndpoint\ - -## Type Parameters - -• **T** = `any` - -## Methods - -### buildRequest() - -> **buildRequest**(): `T` - -#### Returns - -`T` - -#### Defined in - -[src/parser/types/CommandEndpoints.ts:3](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L3) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/parser/types/CommandEndpoints.ts:2](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L2) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md b/docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md deleted file mode 100644 index 3807f84b..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md +++ /dev/null @@ -1,521 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IParsedResponse - -# Interface: IParsedResponse - -## Properties - -### actions? - -> `optional` **actions**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L29) - -*** - -### actions\_memo? - -> `optional` **actions\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L30) - -*** - -### alerts? - -> `optional` **alerts**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Alert`](../../YTNodes/classes/Alert.md) \| [`AlertWithButton`](../../YTNodes/classes/AlertWithButton.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L53) - -*** - -### annotations? - -> `optional` **annotations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:65](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L65) - -*** - -### background? - -> `optional` **background**: [`MusicThumbnail`](../../YTNodes/classes/MusicThumbnail.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L26) - -*** - -### bg\_challenge? - -> `optional` **bg\_challenge**: [`IBotguardChallenge`](IBotguardChallenge.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L28) - -*** - -### captions? - -> `optional` **captions**: [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:63](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L63) - -*** - -### cards? - -> `optional` **cards**: [`CardCollection`](../../YTNodes/classes/CardCollection.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L68) - -*** - -### challenge? - -> `optional` **challenge**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L27) - -*** - -### contents? - -> `optional` **contents**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L31) - -*** - -### contents\_memo? - -> `optional` **contents\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L32) - -*** - -### continuation? - -> `optional` **continuation**: [`Continuation`](../../../classes/Continuation.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L46) - -*** - -### continuation\_contents? - -> `optional` **continuation\_contents**: [`ItemSectionContinuation`](../../../classes/ItemSectionContinuation.md) \| [`SectionListContinuation`](../../../classes/SectionListContinuation.md) \| [`LiveChatContinuation`](../../../classes/LiveChatContinuation.md) \| [`MusicPlaylistShelfContinuation`](../../../classes/MusicPlaylistShelfContinuation.md) \| [`MusicShelfContinuation`](../../../classes/MusicShelfContinuation.md) \| [`GridContinuation`](../../../classes/GridContinuation.md) \| [`PlaylistPanelContinuation`](../../../classes/PlaylistPanelContinuation.md) \| [`ContinuationCommand`](../../../classes/ContinuationCommand.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L47) - -*** - -### continuation\_contents\_memo? - -> `optional` **continuation\_contents\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L49) - -*** - -### continuation\_endpoint? - -> `optional` **continuation\_endpoint**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L81) - -*** - -### cpn\_info? - -> `optional` **cpn\_info**: `object` - -#### cpn? - -> `optional` **cpn**: `string` - -#### cpn\_source? - -> `optional` **cpn\_source**: `"CPN_SOURCE_TYPE_UNKNOWN"` \| `"CPN_SOURCE_TYPE_CLIENT"` \| `"CPN_SOURCE_TYPE_WATCH_SERVER"` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L69) - -*** - -### current\_video\_endpoint? - -> `optional` **current\_video\_endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:61](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L61) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:62](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L62) - -*** - -### endscreen? - -> `optional` **endscreen**: [`Endscreen`](../../YTNodes/classes/Endscreen.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L67) - -*** - -### engagement\_panels? - -> `optional` **engagement\_panels**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`EngagementPanelSectionList`](../../YTNodes/classes/EngagementPanelSectionList.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:76](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L76) - -*** - -### entries? - -> `optional` **entries**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/types/ParsedResponse.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L78) - -*** - -### entries\_memo? - -> `optional` **entries\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:79](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L79) - -*** - -### estimated\_results? - -> `optional` **estimated\_results**: `number` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L55) - -*** - -### header? - -> `optional` **header**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L33) - -*** - -### header\_memo? - -> `optional` **header\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L34) - -*** - -### items? - -> `optional` **items**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:77](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L77) - -*** - -### items\_memo? - -> `optional` **items\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L39) - -*** - -### live\_chat\_item\_context\_menu\_supported\_renderers? - -> `optional` **live\_chat\_item\_context\_menu\_supported\_renderers**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L37) - -*** - -### live\_chat\_item\_context\_menu\_supported\_renderers\_memo? - -> `optional` **live\_chat\_item\_context\_menu\_supported\_renderers\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L38) - -*** - -### metadata? - -> `optional` **metadata**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L50) - -*** - -### microformat? - -> `optional` **microformat**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L51) - -*** - -### on\_response\_received\_actions? - -> `optional` **on\_response\_received\_actions**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L40) - -*** - -### on\_response\_received\_actions\_memo? - -> `optional` **on\_response\_received\_actions\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L41) - -*** - -### on\_response\_received\_commands? - -> `optional` **on\_response\_received\_commands**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L44) - -*** - -### on\_response\_received\_commands\_memo? - -> `optional` **on\_response\_received\_commands\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L45) - -*** - -### on\_response\_received\_endpoints? - -> `optional` **on\_response\_received\_endpoints**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L42) - -*** - -### on\_response\_received\_endpoints\_memo? - -> `optional` **on\_response\_received\_endpoints\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L43) - -*** - -### overlay? - -> `optional` **overlay**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:52](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L52) - -*** - -### playability\_status? - -> `optional` **playability\_status**: [`IPlayabilityStatus`](IPlayabilityStatus.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:58](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L58) - -*** - -### playback\_tracking? - -> `optional` **playback\_tracking**: [`IPlaybackTracking`](IPlaybackTracking.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:57](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L57) - -*** - -### player\_config? - -> `optional` **player\_config**: [`IPlayerConfig`](IPlayerConfig.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:60](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L60) - -*** - -### player\_overlays? - -> `optional` **player\_overlays**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/types/ParsedResponse.ts:56](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L56) - -*** - -### player\_response? - -> `optional` **player\_response**: [`IPlayerResponse`](../type-aliases/IPlayerResponse.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:82](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L82) - -*** - -### refinements? - -> `optional` **refinements**: `string`[] - -#### Defined in - -[src/parser/types/ParsedResponse.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L54) - -*** - -### sidebar? - -> `optional` **sidebar**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L35) - -*** - -### sidebar\_memo? - -> `optional` **sidebar\_memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L36) - -*** - -### storyboards? - -> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:66](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L66) - -*** - -### streaming\_data? - -> `optional` **streaming\_data**: [`IStreamingData`](IStreamingData.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L59) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:80](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L80) - -*** - -### video\_details? - -> `optional` **video\_details**: [`VideoDetails`](../../Misc/classes/VideoDetails.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L64) - -*** - -### watch\_next\_response? - -> `optional` **watch\_next\_response**: [`INextResponse`](../type-aliases/INextResponse.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:83](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L83) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md b/docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md deleted file mode 100644 index a8be0ab2..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md +++ /dev/null @@ -1,53 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IPlayabilityStatus - -# Interface: IPlayabilityStatus - -## Properties - -### audio\_only\_playability - -> **audio\_only\_playability**: `null` \| [`AudioOnlyPlayability`](../../YTNodes/classes/AudioOnlyPlayability.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:106](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L106) - -*** - -### embeddable - -> **embeddable**: `boolean` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:107](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L107) - -*** - -### error\_screen - -> **error\_screen**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/types/ParsedResponse.ts:105](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L105) - -*** - -### reason - -> **reason**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:108](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L108) - -*** - -### status - -> **status**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:104](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L104) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md b/docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md deleted file mode 100644 index 102afb47..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IPlaybackTracking - -# Interface: IPlaybackTracking - -## Properties - -### videostats\_playback\_url - -> **videostats\_playback\_url**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:101](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L101) - -*** - -### videostats\_watchtime\_url - -> **videostats\_watchtime\_url**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:100](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L100) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md b/docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md deleted file mode 100644 index db36669f..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md +++ /dev/null @@ -1,73 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IPlayerConfig - -# Interface: IPlayerConfig - -## Properties - -### audio\_config - -> **audio\_config**: `object` - -#### enable\_per\_format\_loudness - -> **enable\_per\_format\_loudness**: `boolean` - -#### loudness\_db? - -> `optional` **loudness\_db**: `number` - -#### perceptual\_loudness\_db? - -> `optional` **perceptual\_loudness\_db**: `number` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L112) - -*** - -### media\_common\_config - -> **media\_common\_config**: `object` - -#### dynamic\_readahead\_config - -> **dynamic\_readahead\_config**: `object` - -#### dynamic\_readahead\_config.max\_read\_ahead\_media\_time\_ms - -> **max\_read\_ahead\_media\_time\_ms**: `number` - -#### dynamic\_readahead\_config.min\_read\_ahead\_media\_time\_ms - -> **min\_read\_ahead\_media\_time\_ms**: `number` - -#### dynamic\_readahead\_config.read\_ahead\_growth\_rate\_ms - -> **read\_ahead\_growth\_rate\_ms**: `number` - -#### media\_ustreamer\_request\_config? - -> `optional` **media\_ustreamer\_request\_config**: `object` - -#### media\_ustreamer\_request\_config.video\_playback\_ustreamer\_config? - -> `optional` **video\_playback\_ustreamer\_config**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:120](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L120) - -*** - -### stream\_selection\_config - -> **stream\_selection\_config**: `object` - -#### max\_bitrate - -> **max\_bitrate**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:117](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L117) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IRawBotguardChallenge.md b/docs/api/namespaces/APIResponseTypes/interfaces/IRawBotguardChallenge.md deleted file mode 100644 index bf1efc0a..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IRawBotguardChallenge.md +++ /dev/null @@ -1,53 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IRawBotguardChallenge - -# Interface: IRawBotguardChallenge - -## Properties - -### clientExperimentsStateBlob - -> **clientExperimentsStateBlob**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1577](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1577) - -*** - -### globalName - -> **globalName**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1576](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1576) - -*** - -### interpreterHash - -> **interpreterHash**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1574](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1574) - -*** - -### interpreterUrl - -> **interpreterUrl**: [`IRawTrustedResource`](IRawTrustedResource.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1573](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1573) - -*** - -### program - -> **program**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1575](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1575) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md b/docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md deleted file mode 100644 index e3a457f3..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md +++ /dev/null @@ -1,73 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IRawPlayerConfig - -# Interface: IRawPlayerConfig - -## Properties - -### audioConfig - -> **audioConfig**: `object` - -#### enablePerFormatLoudness - -> **enablePerFormatLoudness**: `boolean` - -#### loudnessDb? - -> `optional` **loudnessDb**: `number` - -#### perceptualLoudnessDb? - -> `optional` **perceptualLoudnessDb**: `number` - -#### Defined in - -[src/parser/types/RawResponse.ts:1547](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1547) - -*** - -### mediaCommonConfig - -> **mediaCommonConfig**: `object` - -#### dynamicReadaheadConfig? - -> `optional` **dynamicReadaheadConfig**: `object` - -#### dynamicReadaheadConfig.maxReadAheadMediaTimeMs - -> **maxReadAheadMediaTimeMs**: `number` - -#### dynamicReadaheadConfig.minReadAheadMediaTimeMs - -> **minReadAheadMediaTimeMs**: `number` - -#### dynamicReadaheadConfig.readAheadGrowthRateMs - -> **readAheadGrowthRateMs**: `number` - -#### mediaUstreamerRequestConfig? - -> `optional` **mediaUstreamerRequestConfig**: `object` - -#### mediaUstreamerRequestConfig.videoPlaybackUstreamerConfig - -> **videoPlaybackUstreamerConfig**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1555](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1555) - -*** - -### streamSelectionConfig - -> **streamSelectionConfig**: `object` - -#### maxBitrate - -> **maxBitrate**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1552](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1552) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md b/docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md deleted file mode 100644 index 34b1c24e..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md +++ /dev/null @@ -1,497 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IRawResponse - -# Interface: IRawResponse - -## Indexable - - \[`key`: `string`\]: `any` - -## Properties - -### actions? - -> `optional` **actions**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1590](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1590) - -*** - -### alerts? - -> `optional` **alerts**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1598](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1598) - -*** - -### annotations? - -> `optional` **annotations**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1634](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1634) - -*** - -### background? - -> `optional` **background**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1582](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1582) - -*** - -### bgChallenge? - -> `optional` **bgChallenge**: [`IRawBotguardChallenge`](IRawBotguardChallenge.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1583](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1583) - -*** - -### captions? - -> `optional` **captions**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1632](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1632) - -*** - -### cards? - -> `optional` **cards**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1637](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1637) - -*** - -### challenge? - -> `optional` **challenge**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1584](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1584) - -*** - -### contents? - -> `optional` **contents**: [`RawData`](../type-aliases/RawData.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1585](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1585) - -*** - -### continuation? - -> `optional` **continuation**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1594](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1594) - -*** - -### continuationContents? - -> `optional` **continuationContents**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1589](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1589) - -*** - -### cpnInfo? - -> `optional` **cpnInfo**: `IYoutubeApiInnertubeCpnInfo` - -#### Defined in - -[src/parser/types/RawResponse.ts:1638](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1638) - -*** - -### currentVideoEndpoint? - -> `optional` **currentVideoEndpoint**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1628](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1628) - -*** - -### endpoint? - -> `optional` **endpoint**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1631](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1631) - -*** - -### endscreen? - -> `optional` **endscreen**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1636](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1636) - -*** - -### engagementPanels? - -> `optional` **engagementPanels**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1642](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1642) - -*** - -### entries? - -> `optional` **entries**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1643](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1643) - -*** - -### estimatedResults? - -> `optional` **estimatedResults**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1600](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1600) - -*** - -### frameworkUpdates? - -> `optional` **frameworkUpdates**: `any` - -#### Defined in - -[src/parser/types/RawResponse.ts:1641](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1641) - -*** - -### header? - -> `optional` **header**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1592](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1592) - -*** - -### items? - -> `optional` **items**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1640](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1640) - -*** - -### liveChatItemContextMenuSupportedRenderers? - -> `optional` **liveChatItemContextMenuSupportedRenderers**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1591](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1591) - -*** - -### metadata? - -> `optional` **metadata**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1595](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1595) - -*** - -### microformat? - -> `optional` **microformat**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1596](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1596) - -*** - -### onResponseReceivedActions? - -> `optional` **onResponseReceivedActions**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1586](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1586) - -*** - -### onResponseReceivedCommands? - -> `optional` **onResponseReceivedCommands**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1588](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1588) - -*** - -### onResponseReceivedEndpoints? - -> `optional` **onResponseReceivedEndpoints**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1587](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1587) - -*** - -### overlay? - -> `optional` **overlay**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1597](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1597) - -*** - -### playabilityStatus? - -> `optional` **playabilityStatus**: `object` - -#### audioOnlyPlayability? - -> `optional` **audioOnlyPlayability**: [`RawNode`](../type-aliases/RawNode.md) - -#### errorScreen? - -> `optional` **errorScreen**: [`RawNode`](../type-aliases/RawNode.md) - -#### playableInEmbed? - -> `optional` **playableInEmbed**: `boolean` - -#### reason? - -> `optional` **reason**: `string` - -#### status - -> **status**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1610](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1610) - -*** - -### playbackTracking? - -> `optional` **playbackTracking**: `object` - -#### videostatsPlaybackUrl - -> **videostatsPlaybackUrl**: `object` - -#### videostatsPlaybackUrl.baseUrl - -> **baseUrl**: `string` - -#### videostatsWatchtimeUrl - -> **videostatsWatchtimeUrl**: `object` - -#### videostatsWatchtimeUrl.baseUrl - -> **baseUrl**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1602](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1602) - -*** - -### playerConfig? - -> `optional` **playerConfig**: [`IRawPlayerConfig`](IRawPlayerConfig.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1625](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1625) - -*** - -### playerOverlays? - -> `optional` **playerOverlays**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1601](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1601) - -*** - -### playerResponse? - -> `optional` **playerResponse**: [`IRawResponse`](IRawResponse.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1626](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1626) - -*** - -### playlistId? - -> `optional` **playlistId**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1630](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1630) - -*** - -### refinements? - -> `optional` **refinements**: `string`[] - -#### Defined in - -[src/parser/types/RawResponse.ts:1599](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1599) - -*** - -### responseContext? - -> `optional` **responseContext**: `IYoutubeApiInnertubeResponseContext` - -#### Defined in - -[src/parser/types/RawResponse.ts:1581](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1581) - -*** - -### sidebar? - -> `optional` **sidebar**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1593](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1593) - -*** - -### storyboards? - -> `optional` **storyboards**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1635](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1635) - -*** - -### streamingData? - -> `optional` **streamingData**: `object` - -#### adaptiveFormats - -> **adaptiveFormats**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### dashManifestUrl? - -> `optional` **dashManifestUrl**: `string` - -#### expiresInSeconds - -> **expiresInSeconds**: `string` - -#### formats - -> **formats**: [`RawNode`](../type-aliases/RawNode.md)[] - -#### hlsManifestUrl? - -> `optional` **hlsManifestUrl**: `string` - -#### serverAbrStreamingUrl? - -> `optional` **serverAbrStreamingUrl**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1617](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1617) - -*** - -### targetId? - -> `optional` **targetId**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1639](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1639) - -*** - -### unseenCount? - -> `optional` **unseenCount**: `number` - -#### Defined in - -[src/parser/types/RawResponse.ts:1629](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1629) - -*** - -### videoDetails? - -> `optional` **videoDetails**: [`RawNode`](../type-aliases/RawNode.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1633](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1633) - -*** - -### watchNextResponse? - -> `optional` **watchNextResponse**: [`IRawResponse`](IRawResponse.md) - -#### Defined in - -[src/parser/types/RawResponse.ts:1627](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1627) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IRawTrustedResource.md b/docs/api/namespaces/APIResponseTypes/interfaces/IRawTrustedResource.md deleted file mode 100644 index 9778aebf..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IRawTrustedResource.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IRawTrustedResource - -# Interface: IRawTrustedResource - -## Properties - -### privateDoNotAccessOrElseSafeScriptWrappedValue? - -> `optional` **privateDoNotAccessOrElseSafeScriptWrappedValue**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1569](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1569) - -*** - -### privateDoNotAccessOrElseTrustedResourceUrlWrappedValue? - -> `optional` **privateDoNotAccessOrElseTrustedResourceUrlWrappedValue**: `string` - -#### Defined in - -[src/parser/types/RawResponse.ts:1568](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1568) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md b/docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md deleted file mode 100644 index a1822fa1..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md +++ /dev/null @@ -1,63 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IStreamingData - -# Interface: IStreamingData - -## Properties - -### adaptive\_formats - -> **adaptive\_formats**: [`Format`](../../Misc/classes/Format.md)[] - -#### Defined in - -[src/parser/types/ParsedResponse.ts:135](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L135) - -*** - -### dash\_manifest\_url? - -> `optional` **dash\_manifest\_url**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:136](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L136) - -*** - -### expires - -> **expires**: `Date` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L133) - -*** - -### formats - -> **formats**: [`Format`](../../Misc/classes/Format.md)[] - -#### Defined in - -[src/parser/types/ParsedResponse.ts:134](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L134) - -*** - -### hls\_manifest\_url? - -> `optional` **hls\_manifest\_url**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L137) - -*** - -### server\_abr\_streaming\_url? - -> `optional` **server\_abr\_streaming\_url**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:138](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L138) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/ITrustedResource.md b/docs/api/namespaces/APIResponseTypes/interfaces/ITrustedResource.md deleted file mode 100644 index 0cc7c9d0..00000000 --- a/docs/api/namespaces/APIResponseTypes/interfaces/ITrustedResource.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / ITrustedResource - -# Interface: ITrustedResource - -## Properties - -### private\_do\_not\_access\_or\_else\_safe\_script\_wrapped\_value? - -> `optional` **private\_do\_not\_access\_or\_else\_safe\_script\_wrapped\_value**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:88](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L88) - -*** - -### private\_do\_not\_access\_or\_else\_trusted\_resource\_url\_wrapped\_value? - -> `optional` **private\_do\_not\_access\_or\_else\_trusted\_resource\_url\_wrapped\_value**: `string` - -#### Defined in - -[src/parser/types/ParsedResponse.ts:87](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L87) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md deleted file mode 100644 index 5766e8cf..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / AddToPlaylistServiceRequest - -# Type Alias: AddToPlaylistServiceRequest - -> **AddToPlaylistServiceRequest**: `object` - -## Type declaration - -### excludeWatchLater? - -> `optional` **excludeWatchLater**: `boolean` - -### params? - -> `optional` **params**: `string` - -### playlistId? - -> `optional` **playlistId**: `string` - -### videoIds? - -> `optional` **videoIds**: `string`[] - -## Defined in - -[src/parser/types/CommandEndpoints.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L55) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequest.md deleted file mode 100644 index e78db911..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequest.md +++ /dev/null @@ -1,39 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / BrowseRequest - -# Type Alias: BrowseRequest - -> **BrowseRequest**: `object` - -## Type declaration - -### browseId? - -> `optional` **browseId**: `string` - -### browseRequestSupportedMetadata? - -> `optional` **browseRequestSupportedMetadata**: [`BrowseRequestSupportedMetadata`](BrowseRequestSupportedMetadata.md) - -### formData? - -> `optional` **formData**: [`FormData`](FormData.md) - -### inlineSettingStatus? - -> `optional` **inlineSettingStatus**: [`InlineSettingStatus`](InlineSettingStatus.md) - -### params? - -> `optional` **params**: `string` - -### query? - -> `optional` **query**: `string` - -### subscriptionSettingsState? - -> `optional` **subscriptionSettingsState**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L6) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequestSupportedMetadata.md b/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequestSupportedMetadata.md deleted file mode 100644 index e70d24c3..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequestSupportedMetadata.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / BrowseRequestSupportedMetadata - -# Type Alias: BrowseRequestSupportedMetadata - -> **BrowseRequestSupportedMetadata**: `object` - -## Type declaration - -### downloadsBrowseParams - -> **downloadsBrowseParams**: `object` - -### downloadsBrowseParams.offlineFeatureSettingState - -> **offlineFeatureSettingState**: `object` - -### downloadsBrowseParams.offlineFeatureSettingState.isSdEnabled - -> **isSdEnabled**: `boolean` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L25) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/ContinuationRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/ContinuationRequest.md deleted file mode 100644 index 66b98cb2..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/ContinuationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / ContinuationRequest - -# Type Alias: ContinuationRequest - -> **ContinuationRequest**: `object` - -## Type declaration - -### continuation? - -> `optional` **continuation**: `string` - -### fetchCommentsParams? - -> `optional` **fetchCommentsParams**: `object` - -### fetchCommentsParams.continuation - -> **continuation**: `string` - -### formData? - -> `optional` **formData**: [`FormData`](FormData.md) - -### notificationsMenuRequestType? - -> `optional` **notificationsMenuRequestType**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:143](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L143) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md deleted file mode 100644 index 7c0241a0..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md +++ /dev/null @@ -1,63 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / CreateCommentRequest - -# Type Alias: CreateCommentRequest - -> **CreateCommentRequest**: `object` - -## Type declaration - -### accessRestrictions? - -> `optional` **accessRestrictions**: `object` - -### accessRestrictions.restriction - -> **restriction**: `"RESTRICTION_TYPE_EVERYONE"` \| `"RESTRICTION_TYPE_SPONSORS_ONLY"` - -### botguardResponse? - -> `optional` **botguardResponse**: `string` - -### commentText? - -> `optional` **commentText**: `string` - -### createCommentParams? - -> `optional` **createCommentParams**: `string` - -### imageAttachment? - -> `optional` **imageAttachment**: `object` - -### imageAttachment.encryptedBlobId - -> **encryptedBlobId**: `string` - -### pollAttachment? - -> `optional` **pollAttachment**: `object` - -### pollAttachment.choices - -> **choices**: `string`[] - -### sharedPostAttachment? - -> `optional` **sharedPostAttachment**: `object` - -### sharedPostAttachment.postId - -> **postId**: `string` - -### videoAttachment? - -> `optional` **videoAttachment**: `object` - -### videoAttachment.videoId - -> **videoId**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:179](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L179) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md deleted file mode 100644 index 5c325224..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / CreatePlaylistServiceRequest - -# Type Alias: CreatePlaylistServiceRequest - -> **CreatePlaylistServiceRequest**: `object` - -## Type declaration - -### description? - -> `optional` **description**: `string` - -### params? - -> `optional` **params**: `string` - -### privacyStatus? - -> `optional` **privacyStatus**: [`PlaylistPrivacyStatus`](PlaylistPrivacyStatus.md) - -### sourcePlaylistId? - -> `optional` **sourcePlaylistId**: `string` - -### title? - -> `optional` **title**: `string` - -### videoIds? - -> `optional` **videoIds**: `string`[] - -## Defined in - -[src/parser/types/CommandEndpoints.ts:104](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L104) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md deleted file mode 100644 index a43b8bd4..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / DeletePlaylistServiceRequest - -# Type Alias: DeletePlaylistServiceRequest - -> **DeletePlaylistServiceRequest**: `object` - -## Type declaration - -### playlistId? - -> `optional` **playlistId**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:113](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L113) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackContext.md b/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackContext.md deleted file mode 100644 index 925f8a0b..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackContext.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / FeedbackContext - -# Type Alias: FeedbackContext - -> **FeedbackContext**: `object` - -## Type declaration - -### cpn - -> **cpn**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L35) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackRequest.md deleted file mode 100644 index 69f9a216..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / FeedbackRequest - -# Type Alias: FeedbackRequest - -> **FeedbackRequest**: `object` - -## Type declaration - -### feedbackContext? - -> `optional` **feedbackContext**: [`FeedbackContext`](FeedbackContext.md) - -### feedbackTokens? - -> `optional` **feedbackTokens**: `string`[] - -### isFeedbackTokenUnencrypted? - -> `optional` **isFeedbackTokenUnencrypted**: `boolean` - -### shouldMerge? - -> `optional` **shouldMerge**: `boolean` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L39) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/FormData.md b/docs/api/namespaces/APIResponseTypes/type-aliases/FormData.md deleted file mode 100644 index 4437d3a9..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/FormData.md +++ /dev/null @@ -1,31 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / FormData - -# Type Alias: FormData - -> **FormData**: `object` - -## Type declaration - -### accountSettingsFormData - -> **accountSettingsFormData**: `object` - -### accountSettingsFormData.flagAudioDescriptionDefaultOn - -> **flagAudioDescriptionDefaultOn**: `boolean` - -### accountSettingsFormData.flagAutoCaptionsDefaultOn - -> **flagAutoCaptionsDefaultOn**: `boolean` - -### accountSettingsFormData.flagCaptionsDefaultOff - -> **flagCaptionsDefaultOff**: `boolean` - -### accountSettingsFormData.flagDisableInlinePreview - -> **flagDisableInlinePreview**: `boolean` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L16) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md deleted file mode 100644 index b07a9aaa..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md +++ /dev/null @@ -1,43 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / GetAccountsListInnertubeRequest - -# Type Alias: GetAccountsListInnertubeRequest - -> **GetAccountsListInnertubeRequest**: `object` - -## Type declaration - -### callCircumstance? - -> `optional` **callCircumstance**: `"SUPPLEMENTAL_USER"` \| `"SWITCHING_USERS_FULL"` - -### channelSwitcherQuery? - -> `optional` **channelSwitcherQuery**: `string` - -### contentOwnerConfig? - -> `optional` **contentOwnerConfig**: `Record`\<`string`, `any`\> - -### nextNavendpoint? - -> `optional` **nextNavendpoint**: [`NextNavendpoint`](NextNavendpoint.md) - -### obfuscatedSelectedGaiaId? - -> `optional` **obfuscatedSelectedGaiaId**: `string` - -### requestType? - -> `optional` **requestType**: `string` - -### selectedSerializedDelegationContext? - -> `optional` **selectedSerializedDelegationContext**: `string` - -### triggerChannelCreation? - -> `optional` **triggerChannelCreation**: `boolean` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L162) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md deleted file mode 100644 index 6e19c528..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / GetKidsBlocklistPickerRequest - -# Type Alias: GetKidsBlocklistPickerRequest - -> **GetKidsBlocklistPickerRequest**: `object` - -## Type declaration - -### blockedForKidsContent? - -> `optional` **blockedForKidsContent**: `object` - -### blockedForKidsContent.external\_channel\_id - -> **external\_channel\_id**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:173](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L173) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md deleted file mode 100644 index 67a97dc5..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IBrowseResponse - -# Type Alias: IBrowseResponse - -> **IBrowseResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"background"` \| `"continuation_contents"` \| `"continuation_contents_memo"` \| `"on_response_received_actions"` \| `"on_response_received_actions_memo"` \| `"on_response_received_endpoints"` \| `"on_response_received_endpoints_memo"` \| `"contents"` \| `"contents_memo"` \| `"header"` \| `"header_memo"` \| `"metadata"` \| `"microformat"` \| `"alerts"` \| `"sidebar"` \| `"sidebar_memo"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:143](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L143) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md deleted file mode 100644 index e8018c72..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IGetChallengeResponse - -# Type Alias: IGetChallengeResponse - -> **IGetChallengeResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"challenge"` \| `"bg_challenge"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:150](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L150) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md deleted file mode 100644 index 290efaf1..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IGetNotificationsMenuResponse - -# Type Alias: IGetNotificationsMenuResponse - -> **IGetNotificationsMenuResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"actions"` \| `"actions_memo"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:147](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L147) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md deleted file mode 100644 index 9fa1249c..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IGetTranscriptResponse - -# Type Alias: IGetTranscriptResponse - -> **IGetTranscriptResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"actions"` \| `"actions_memo"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:146](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L146) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md deleted file mode 100644 index 9efe13c1..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IGuideResponse - -# Type Alias: IGuideResponse - -> **IGuideResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"items"` \| `"items_memo"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:149](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L149) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md deleted file mode 100644 index e4d47c76..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / INextResponse - -# Type Alias: INextResponse - -> **INextResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"contents"` \| `"contents_memo"` \| `"continuation_contents"` \| `"continuation_contents_memo"` \| `"current_video_endpoint"` \| `"on_response_received_endpoints"` \| `"on_response_received_endpoints_memo"` \| `"player_overlays"` \| `"engagement_panels"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:142](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L142) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md deleted file mode 100644 index 9cc7d048..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IPlayerResponse - -# Type Alias: IPlayerResponse - -> **IPlayerResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"captions"` \| `"cards"` \| `"endscreen"` \| `"microformat"` \| `"annotations"` \| `"playability_status"` \| `"streaming_data"` \| `"player_config"` \| `"playback_tracking"` \| `"storyboards"` \| `"video_details"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:141](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L141) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md deleted file mode 100644 index c82fb7c7..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IResolveURLResponse - -# Type Alias: IResolveURLResponse - -> **IResolveURLResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"endpoint"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:145](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L145) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md deleted file mode 100644 index 642b7689..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / ISearchResponse - -# Type Alias: ISearchResponse - -> **ISearchResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"header"` \| `"header_memo"` \| `"contents"` \| `"contents_memo"` \| `"on_response_received_commands"` \| `"continuation_contents"` \| `"continuation_contents_memo"` \| `"refinements"` \| `"estimated_results"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L144) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md deleted file mode 100644 index be716636..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / IUpdatedMetadataResponse - -# Type Alias: IUpdatedMetadataResponse - -> **IUpdatedMetadataResponse**: `Pick`\<[`IParsedResponse`](../interfaces/IParsedResponse.md), `"actions"` \| `"actions_memo"` \| `"continuation"`\> - -## Defined in - -[src/parser/types/ParsedResponse.ts:148](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/ParsedResponse.ts#L148) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md b/docs/api/namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md deleted file mode 100644 index 4ebd0d0f..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / InlineSettingStatus - -# Type Alias: InlineSettingStatus - -> **InlineSettingStatus**: `"INLINE_SETTING_STATUS_DISABLED"` \| `"INLINE_SETTING_STATUS_ON"` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L33) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/LikeRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/LikeRequest.md deleted file mode 100644 index 29d25343..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/LikeRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / LikeRequest - -# Type Alias: LikeRequest - -> **LikeRequest**: `object` - -## Type declaration - -### params? - -> `optional` **params**: `string` - -### target? - -> `optional` **target**: [`LikeTarget`](LikeTarget.md) - -## Defined in - -[src/parser/types/CommandEndpoints.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L50) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/LikeTarget.md b/docs/api/namespaces/APIResponseTypes/type-aliases/LikeTarget.md deleted file mode 100644 index d319f74d..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/LikeTarget.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / LikeTarget - -# Type Alias: LikeTarget - -> **LikeTarget**: `object` - -## Type declaration - -### videoId - -> **videoId**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L46) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md deleted file mode 100644 index 9ff731a8..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / LiveChatItemContextMenuRequest - -# Type Alias: LiveChatItemContextMenuRequest - -> **LiveChatItemContextMenuRequest**: `object` - -## Type declaration - -### params? - -> `optional` **params**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:152](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L152) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md deleted file mode 100644 index 32a06c06..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / ModifyChannelNotificationPreferenceRequest - -# Type Alias: ModifyChannelNotificationPreferenceRequest - -> **ModifyChannelNotificationPreferenceRequest**: `object` - -## Type declaration - -### params? - -> `optional` **params**: `string` - -### secondaryParams? - -> `optional` **secondaryParams**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:194](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L194) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/NextNavendpoint.md b/docs/api/namespaces/APIResponseTypes/type-aliases/NextNavendpoint.md deleted file mode 100644 index 6a0498e3..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/NextNavendpoint.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / NextNavendpoint - -# Type Alias: NextNavendpoint - -> **NextNavendpoint**: `object` - -## Type declaration - -### urlEndpoint - -> **urlEndpoint**: `object` - -### urlEndpoint.url - -> **url**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:156](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L156) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/PerformCommentActionRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/PerformCommentActionRequest.md deleted file mode 100644 index 3ff4c139..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/PerformCommentActionRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / PerformCommentActionRequest - -# Type Alias: PerformCommentActionRequest - -> **PerformCommentActionRequest**: `object` - -## Type declaration - -### actions? - -> `optional` **actions**: `Record`\<`string`, `any`\>[] - -## Defined in - -[src/parser/types/CommandEndpoints.ts:190](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L190) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistEditRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistEditRequest.md deleted file mode 100644 index 5b54b086..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistEditRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / PlaylistEditRequest - -# Type Alias: PlaylistEditRequest - -> **PlaylistEditRequest**: `object` - -## Type declaration - -### actions? - -> `optional` **actions**: `Record`\<`string`, `any`\>[] - -### params? - -> `optional` **params**: `string` - -### playlistId? - -> `optional` **playlistId**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:96](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L96) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistPrivacyStatus.md b/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistPrivacyStatus.md deleted file mode 100644 index ebb429bb..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistPrivacyStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / PlaylistPrivacyStatus - -# Type Alias: PlaylistPrivacyStatus - -> **PlaylistPrivacyStatus**: `"PUBLIC"` \| `"UNLISTED"` \| `"PRIVATE"` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:102](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L102) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/RawData.md b/docs/api/namespaces/APIResponseTypes/type-aliases/RawData.md deleted file mode 100644 index 2e765d97..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/RawData.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / RawData - -# Type Alias: RawData - -> **RawData**: [`RawNode`](RawNode.md) \| [`RawNode`](RawNode.md)[] - -## Defined in - -[src/parser/types/RawResponse.ts:2](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L2) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/RawNode.md b/docs/api/namespaces/APIResponseTypes/type-aliases/RawNode.md deleted file mode 100644 index 9fd5e8b1..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/RawNode.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / RawNode - -# Type Alias: RawNode - -> **RawNode**: `Record`\<`string`, `any`\> - -## Defined in - -[src/parser/types/RawResponse.ts:1](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/RawResponse.ts#L1) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/ReelWatchRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/ReelWatchRequest.md deleted file mode 100644 index e486085e..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/ReelWatchRequest.md +++ /dev/null @@ -1,43 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / ReelWatchRequest - -# Type Alias: ReelWatchRequest - -> **ReelWatchRequest**: `object` - -## Type declaration - -### disablePlayerResponse? - -> `optional` **disablePlayerResponse**: `boolean` - -### inputType? - -> `optional` **inputType**: `string` - -### params? - -> `optional` **params**: `string` - -### playerRequest? - -> `optional` **playerRequest**: `object` - -### playerRequest.contentCheckOk? - -> `optional` **contentCheckOk**: `boolean` - -### playerRequest.params? - -> `optional` **params**: `string` - -### playerRequest.racyCheckOk? - -> `optional` **racyCheckOk**: `boolean` - -### playerRequest.videoId - -> **videoId**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:84](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L84) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/SearchRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/SearchRequest.md deleted file mode 100644 index 77bc61d0..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/SearchRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / SearchRequest - -# Type Alias: SearchRequest - -> **SearchRequest**: `object` - -## Type declaration - -### params? - -> `optional` **params**: `string` - -### query? - -> `optional` **query**: `string` - -### suggestStats? - -> `optional` **suggestStats**: `unknown` - -### webSearchboxStatsUrl? - -> `optional` **webSearchboxStatsUrl**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:117](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L117) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/ShareEntityServiceRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/ShareEntityServiceRequest.md deleted file mode 100644 index 4bf2ee0b..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/ShareEntityServiceRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / ShareEntityServiceRequest - -# Type Alias: ShareEntityServiceRequest - -> **ShareEntityServiceRequest**: `object` - -## Type declaration - -### clientParams? - -> `optional` **clientParams**: `string` - -### serializedSharedEntity? - -> `optional` **serializedSharedEntity**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:138](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L138) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/SubscribeRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/SubscribeRequest.md deleted file mode 100644 index 21a0bc01..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/SubscribeRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / SubscribeRequest - -# Type Alias: SubscribeRequest - -> **SubscribeRequest**: `object` - -## Type declaration - -### botguardResponse? - -> `optional` **botguardResponse**: `string` - -### channelIds? - -> `optional` **channelIds**: `string`[] - -### clientFeature? - -> `optional` **clientFeature**: `string` - -### params? - -> `optional` **params**: `string` - -### siloName? - -> `optional` **siloName**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:124](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L124) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/UnsubscribeRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/UnsubscribeRequest.md deleted file mode 100644 index c82a4bbc..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/UnsubscribeRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / UnsubscribeRequest - -# Type Alias: UnsubscribeRequest - -> **UnsubscribeRequest**: `object` - -## Type declaration - -### channelIds? - -> `optional` **channelIds**: `string`[] - -### params? - -> `optional` **params**: `string` - -### siloName? - -> `optional` **siloName**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:132](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L132) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/WatchNextRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/WatchNextRequest.md deleted file mode 100644 index cbd82b97..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/WatchNextRequest.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / WatchNextRequest - -# Type Alias: WatchNextRequest - -> **WatchNextRequest**: `object` - -## Type declaration - -### contentCheckOk? - -> `optional` **contentCheckOk**: `boolean` - -### params? - -> `optional` **params**: `string` - -### playlistId? - -> `optional` **playlistId**: `string` - -### playlistIndex? - -> `optional` **playlistIndex**: `number` - -### racyCheckOk? - -> `optional` **racyCheckOk**: `boolean` - -### videoId? - -> `optional` **videoId**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:75](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L75) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/WatchRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/WatchRequest.md deleted file mode 100644 index 9e85b1cf..00000000 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/WatchRequest.md +++ /dev/null @@ -1,51 +0,0 @@ -[youtubei.js](../../../README.md) / [APIResponseTypes](../README.md) / WatchRequest - -# Type Alias: WatchRequest - -> **WatchRequest**: `object` - -## Type declaration - -### contentCheckOk? - -> `optional` **contentCheckOk**: `boolean` - -### disablePlayerResponse? - -> `optional` **disablePlayerResponse**: `boolean` - -### overrideMutedAtStart? - -> `optional` **overrideMutedAtStart**: `boolean` - -### params? - -> `optional` **params**: `string` - -### playerRequest? - -> `optional` **playerRequest**: `Record`\<`string`, `any`\> - -### playlistId? - -> `optional` **playlistId**: `string` - -### playlistIndex? - -> `optional` **playlistIndex**: `number` - -### racyCheckOk? - -> `optional` **racyCheckOk**: `boolean` - -### startTimeSecs? - -> `optional` **startTimeSecs**: `string` - -### videoId? - -> `optional` **videoId**: `string` - -## Defined in - -[src/parser/types/CommandEndpoints.ts:62](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/types/CommandEndpoints.ts#L62) diff --git a/docs/api/namespaces/BinarySerializer/functions/deserialize.md b/docs/api/namespaces/BinarySerializer/functions/deserialize.md deleted file mode 100644 index 5f379e36..00000000 --- a/docs/api/namespaces/BinarySerializer/functions/deserialize.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [BinarySerializer](../README.md) / deserialize - -# Function: deserialize() - -> **deserialize**\<`T`\>(`buffer`): `T` - -## Type Parameters - -• **T** - -## Parameters - -• **buffer**: `Uint8Array` - -## Returns - -`T` - -## Defined in - -[src/utils/BinarySerializer.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/BinarySerializer.ts#L23) diff --git a/docs/api/namespaces/BinarySerializer/functions/serialize.md b/docs/api/namespaces/BinarySerializer/functions/serialize.md deleted file mode 100644 index fea5607e..00000000 --- a/docs/api/namespaces/BinarySerializer/functions/serialize.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [BinarySerializer](../README.md) / serialize - -# Function: serialize() - -> **serialize**(`data`): `ArrayBuffer` - -## Parameters - -• **data**: `any` - -## Returns - -`ArrayBuffer` - -## Defined in - -[src/utils/BinarySerializer.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/BinarySerializer.ts#L6) diff --git a/docs/api/namespaces/BinarySerializer/variables/MAGIC_HEADER.md b/docs/api/namespaces/BinarySerializer/variables/MAGIC_HEADER.md deleted file mode 100644 index 545c2dbe..00000000 --- a/docs/api/namespaces/BinarySerializer/variables/MAGIC_HEADER.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [BinarySerializer](../README.md) / MAGIC\_HEADER - -# Variable: MAGIC\_HEADER - -> `const` **MAGIC\_HEADER**: `5849684` = `0x594254` - -## Defined in - -[src/utils/BinarySerializer.ts:3](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/BinarySerializer.ts#L3) diff --git a/docs/api/namespaces/BinarySerializer/variables/VERSION.md b/docs/api/namespaces/BinarySerializer/variables/VERSION.md deleted file mode 100644 index 921244b3..00000000 --- a/docs/api/namespaces/BinarySerializer/variables/VERSION.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [BinarySerializer](../README.md) / VERSION - -# Variable: VERSION - -> `const` **VERSION**: `1` = `1` - -## Defined in - -[src/utils/BinarySerializer.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/BinarySerializer.ts#L4) diff --git a/docs/api/namespaces/Clients/classes/Kids.md b/docs/api/namespaces/Clients/classes/Kids.md deleted file mode 100644 index 2ef6ac78..00000000 --- a/docs/api/namespaces/Clients/classes/Kids.md +++ /dev/null @@ -1,116 +0,0 @@ -[youtubei.js](../../../README.md) / [Clients](../README.md) / Kids - -# Class: Kids - -## Constructors - -### new Kids() - -> **new Kids**(`session`): [`Kids`](Kids.md) - -#### Parameters - -• **session**: [`Session`](../../../classes/Session.md) - -#### Returns - -[`Kids`](Kids.md) - -#### Defined in - -[src/core/clients/Kids.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L12) - -## Methods - -### blockChannel() - -> **blockChannel**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)[]\> - -Retrieves the list of supervised accounts that the signed-in user has -access to, and blocks the given channel for each of them. - -#### Parameters - -• **channel\_id**: `string` - -The channel id to block. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)[]\> - -A list of API responses. - -#### Defined in - -[src/core/clients/Kids.ts:79](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L79) - -*** - -### getChannel() - -> **getChannel**(`channel_id`): `Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\> - -#### Parameters - -• **channel\_id**: `string` - -#### Returns - -`Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\> - -#### Defined in - -[src/core/clients/Kids.ts:61](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L61) - -*** - -### getHomeFeed() - -> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\> - -#### Returns - -`Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\> - -#### Defined in - -[src/core/clients/Kids.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L67) - -*** - -### getInfo() - -> **getInfo**(`video_id`, `options`?): `Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\> - -#### Parameters - -• **video\_id**: `string` - -• **options?**: `Omit`\<[`GetVideoInfoOptions`](../../Types/interfaces/GetVideoInfoOptions.md), `"client"`\> - -#### Returns - -`Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\> - -#### Defined in - -[src/core/clients/Kids.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L22) - -*** - -### search() - -> **search**(`query`): `Promise`\<[`Search`](../../YTKids/classes/Search.md)\> - -#### Parameters - -• **query**: `string` - -#### Returns - -`Promise`\<[`Search`](../../YTKids/classes/Search.md)\> - -#### Defined in - -[src/core/clients/Kids.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L16) diff --git a/docs/api/namespaces/Clients/classes/Music.md b/docs/api/namespaces/Clients/classes/Music.md deleted file mode 100644 index 09a161c4..00000000 --- a/docs/api/namespaces/Clients/classes/Music.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [Clients](../README.md) / Music - -# Class: Music - -## Constructors - -### new Music() - -> **new Music**(`session`): [`Music`](Music.md) - -#### Parameters - -• **session**: [`Session`](../../../classes/Session.md) - -#### Returns - -[`Music`](Music.md) - -#### Defined in - -[src/core/clients/Music.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L37) - -## Methods - -### getAlbum() - -> **getAlbum**(`album_id`): `Promise`\<[`Album`](../../YTMusic/classes/Album.md)\> - -#### Parameters - -• **album\_id**: `string` - -#### Returns - -`Promise`\<[`Album`](../../YTMusic/classes/Album.md)\> - -#### Defined in - -[src/core/clients/Music.ts:186](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L186) - -*** - -### getArtist() - -> **getArtist**(`artist_id`): `Promise`\<[`Artist`](../../YTMusic/classes/Artist.md)\> - -#### Parameters - -• **artist\_id**: `string` - -#### Returns - -`Promise`\<[`Artist`](../../YTMusic/classes/Artist.md)\> - -#### Defined in - -[src/core/clients/Music.ts:176](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L176) - -*** - -### getExplore() - -> **getExplore**(): `Promise`\<[`Explore`](../../YTMusic/classes/Explore.md)\> - -#### Returns - -`Promise`\<[`Explore`](../../YTMusic/classes/Explore.md)\> - -#### Defined in - -[src/core/clients/Music.ts:163](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L163) - -*** - -### getHomeFeed() - -> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../../YTMusic/classes/HomeFeed.md)\> - -#### Returns - -`Promise`\<[`HomeFeed`](../../YTMusic/classes/HomeFeed.md)\> - -#### Defined in - -[src/core/clients/Music.ts:157](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L157) - -*** - -### getInfo() - -> **getInfo**(`target`, `options`?): `Promise`\<[`TrackInfo`](../../YTMusic/classes/TrackInfo.md)\> - -Retrieves track info. Passing a list item of type MusicTwoRowItem automatically starts a radio. - -#### Parameters - -• **target**: `string` \| [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) \| [`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md) \| [`MusicTwoRowItem`](../../YTNodes/classes/MusicTwoRowItem.md) - -Video id or a list item. - -• **options?**: `Omit`\<[`GetVideoInfoOptions`](../../Types/interfaces/GetVideoInfoOptions.md), `"client"`\> - -Options for fetching video info. - -#### Returns - -`Promise`\<[`TrackInfo`](../../YTMusic/classes/TrackInfo.md)\> - -#### Defined in - -[src/core/clients/Music.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L47) - -*** - -### getLibrary() - -> **getLibrary**(): `Promise`\<[`Library`](../../YTMusic/classes/Library.md)\> - -#### Returns - -`Promise`\<[`Library`](../../YTMusic/classes/Library.md)\> - -#### Defined in - -[src/core/clients/Music.ts:170](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L170) - -*** - -### getLyrics() - -> **getLyrics**(`video_id`): `Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\> - -#### Parameters - -• **video\_id**: `string` - -#### Returns - -`Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\> - -#### Defined in - -[src/core/clients/Music.ts:267](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L267) - -*** - -### getPlaylist() - -> **getPlaylist**(`playlist_id`): `Promise`\<[`Playlist`](../../YTMusic/classes/Playlist.md)\> - -#### Parameters - -• **playlist\_id**: `string` - -#### Returns - -`Promise`\<[`Playlist`](../../YTMusic/classes/Playlist.md)\> - -#### Defined in - -[src/core/clients/Music.ts:196](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L196) - -*** - -### getRecap() - -> **getRecap**(): `Promise`\<[`Recap`](../../YTMusic/classes/Recap.md)\> - -#### Returns - -`Promise`\<[`Recap`](../../YTMusic/classes/Recap.md)\> - -#### Defined in - -[src/core/clients/Music.ts:293](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L293) - -*** - -### getRelated() - -> **getRelated**(`video_id`): `Promise`\<[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`Message`](../../YTNodes/classes/Message.md)\> - -#### Parameters - -• **video\_id**: `string` - -#### Returns - -`Promise`\<[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`Message`](../../YTNodes/classes/Message.md)\> - -#### Defined in - -[src/core/clients/Music.ts:246](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L246) - -*** - -### getSearchSuggestions() - -> **getSearchSuggestions**(`input`): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchSuggestionsSection`](../../YTNodes/classes/SearchSuggestionsSection.md)\>\> - -#### Parameters - -• **input**: `string` - -#### Returns - -`Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchSuggestionsSection`](../../YTNodes/classes/SearchSuggestionsSection.md)\>\> - -#### Defined in - -[src/core/clients/Music.ts:299](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L299) - -*** - -### getUpNext() - -> **getUpNext**(`video_id`, `automix`): `Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\> - -#### Parameters - -• **video\_id**: `string` - -• **automix**: `boolean` = `true` - -#### Returns - -`Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\> - -#### Defined in - -[src/core/clients/Music.ts:206](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L206) - -*** - -### search() - -> **search**(`query`, `filters`): `Promise`\<[`Search`](../../YTMusic/classes/Search.md)\> - -#### Parameters - -• **query**: `string` - -• **filters**: [`MusicSearchFilters`](../../Types/type-aliases/MusicSearchFilters.md) = `{}` - -#### Returns - -`Promise`\<[`Search`](../../YTMusic/classes/Search.md)\> - -#### Defined in - -[src/core/clients/Music.ts:135](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L135) diff --git a/docs/api/namespaces/Clients/classes/Studio.md b/docs/api/namespaces/Clients/classes/Studio.md deleted file mode 100644 index f4c68685..00000000 --- a/docs/api/namespaces/Clients/classes/Studio.md +++ /dev/null @@ -1,89 +0,0 @@ -[youtubei.js](../../../README.md) / [Clients](../README.md) / Studio - -# Class: Studio - -## Constructors - -### new Studio() - -> **new Studio**(`session`): [`Studio`](Studio.md) - -#### Parameters - -• **session**: [`Session`](../../../classes/Session.md) - -#### Returns - -[`Studio`](Studio.md) - -#### Defined in - -[src/core/clients/Studio.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Studio.ts#L25) - -## Methods - -### updateVideoMetadata() - -> **updateVideoMetadata**(`video_id`, `metadata`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Updates the metadata of a video. - -#### Parameters - -• **video\_id**: `string` - -• **metadata**: `Partial`\<`object`\> - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Example - -```ts -const videoId = 'abcdefg'; -const thumbnail = fs.readFileSync('./my_awesome_thumbnail.jpg'); - -const response = await yt.studio.updateVideoMetadata(videoId, { - tags: [ 'astronomy', 'NASA', 'APOD' ], - title: 'Artemis Mission', - description: 'A nicely written description...', - category: 27, - license: 'creative_commons', - thumbnail, - // ... -}); -``` - -#### Defined in - -[src/core/clients/Studio.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Studio.ts#L47) - -*** - -### upload() - -> **upload**(`file`, `metadata`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Uploads a video to YouTube. - -#### Parameters - -• **file**: `BodyInit` - -• **metadata**: `Partial`\<`object`\> = `{}` - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Example - -```ts -const file = fs.readFileSync('./my_awesome_video.mp4'); -const response = await yt.studio.upload(file.buffer, { title: 'Wow!' }); -``` - -#### Defined in - -[src/core/clients/Studio.ts:150](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Studio.ts#L150) diff --git a/docs/api/namespaces/Constants/variables/OAUTH.md b/docs/api/namespaces/Constants/variables/OAUTH.md deleted file mode 100644 index 33ba16b3..00000000 --- a/docs/api/namespaces/Constants/variables/OAUTH.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Constants](../README.md) / OAUTH - -# Variable: OAUTH - -> `const` **OAUTH**: `object` - -## Type declaration - -### REGEX - -> `readonly` **REGEX**: `object` - -### REGEX.CLIENT\_IDENTITY - -> `readonly` **CLIENT\_IDENTITY**: `RegExp` - -### REGEX.TV\_SCRIPT - -> `readonly` **TV\_SCRIPT**: `RegExp` - -## Defined in - -[src/utils/Constants.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Constants.ts#L19) diff --git a/docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md b/docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md deleted file mode 100644 index 095f3be9..00000000 --- a/docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Constants](../README.md) / SUPPORTED\_CLIENTS - -# Variable: SUPPORTED\_CLIENTS - -> `const` **SUPPORTED\_CLIENTS**: `string`[] - -## Defined in - -[src/utils/Constants.ts:127](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Constants.ts#L127) diff --git a/docs/api/namespaces/FormatUtils/functions/chooseFormat.md b/docs/api/namespaces/FormatUtils/functions/chooseFormat.md deleted file mode 100644 index af20f6b3..00000000 --- a/docs/api/namespaces/FormatUtils/functions/chooseFormat.md +++ /dev/null @@ -1,25 +0,0 @@ -[youtubei.js](../../../README.md) / [FormatUtils](../README.md) / chooseFormat - -# Function: chooseFormat() - -> **chooseFormat**(`options`, `streaming_data`?): [`Format`](../../Misc/classes/Format.md) - -Selects the format that best matches the given options. - -## Parameters - -• **options**: [`FormatOptions`](../../Types/interfaces/FormatOptions.md) - -Options - -• **streaming\_data?**: [`IStreamingData`](../../APIResponseTypes/interfaces/IStreamingData.md) - -Streaming data - -## Returns - -[`Format`](../../Misc/classes/Format.md) - -## Defined in - -[src/utils/FormatUtils.ts:138](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/FormatUtils.ts#L138) diff --git a/docs/api/namespaces/FormatUtils/functions/download.md b/docs/api/namespaces/FormatUtils/functions/download.md deleted file mode 100644 index 38fc95df..00000000 --- a/docs/api/namespaces/FormatUtils/functions/download.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [FormatUtils](../README.md) / download - -# Function: download() - -> **download**(`options`, `actions`, `playability_status`?, `streaming_data`?, `player`?, `cpn`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -## Parameters - -• **options**: [`DownloadOptions`](../../Types/interfaces/DownloadOptions.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **playability\_status?**: [`IPlayabilityStatus`](../../APIResponseTypes/interfaces/IPlayabilityStatus.md) - -• **streaming\_data?**: [`IStreamingData`](../../APIResponseTypes/interfaces/IStreamingData.md) - -• **player?**: [`Player`](../../../classes/Player.md) - -• **cpn?**: `string` - -## Returns - -`Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -## Defined in - -[src/utils/FormatUtils.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/FormatUtils.ts#L10) diff --git a/docs/api/namespaces/FormatUtils/functions/toDash.md b/docs/api/namespaces/FormatUtils/functions/toDash.md deleted file mode 100644 index 5ebf1c20..00000000 --- a/docs/api/namespaces/FormatUtils/functions/toDash.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [FormatUtils](../README.md) / toDash - -# Function: toDash() - -> **toDash**(`streaming_data`?, `is_post_live_dvr`?, `url_transformer`?, `format_filter`?, `cpn`?, `player`?, `actions`?, `storyboards`?, `caption_tracks`?, `options`?): `Promise`\<`string`\> - -## Parameters - -• **streaming\_data?**: [`IStreamingData`](../../APIResponseTypes/interfaces/IStreamingData.md) - -• **is\_post\_live\_dvr?**: `boolean` = `false` - -• **url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) = `...` - -• **format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) - -• **cpn?**: `string` - -• **player?**: [`Player`](../../../classes/Player.md) - -• **actions?**: [`Actions`](../../../classes/Actions.md) - -• **storyboards?**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) - -• **caption\_tracks?**: `CaptionTrackData`[] - -• **options?**: `StreamingInfoOptions` - -## Returns - -`Promise`\<`string`\> - -## Defined in - -[src/utils/DashManifest.tsx:290](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/DashManifest.tsx#L290) diff --git a/docs/api/namespaces/Generator/functions/camelToSnake.md b/docs/api/namespaces/Generator/functions/camelToSnake.md deleted file mode 100644 index f829e769..00000000 --- a/docs/api/namespaces/Generator/functions/camelToSnake.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / camelToSnake - -# Function: camelToSnake() - -> **camelToSnake**(`str`): `string` - -## Parameters - -• **str**: `string` - -## Returns - -`string` - -## Defined in - -[src/parser/generator.ts:82](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L82) diff --git a/docs/api/namespaces/Generator/functions/generateTypescriptClass.md b/docs/api/namespaces/Generator/functions/generateTypescriptClass.md deleted file mode 100644 index 46547d2c..00000000 --- a/docs/api/namespaces/Generator/functions/generateTypescriptClass.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / generateTypescriptClass - -# Function: generateTypescriptClass() - -> **generateTypescriptClass**(`classname`, `key_info`): `string` - -Generate a typescript class based on the key info - -## Parameters - -• **classname**: `string` - -The name of the class - -• **key\_info**: [`KeyInfo`](../type-aliases/KeyInfo.md) - -The key info, as returned by [introspect](introspect.md) - -## Returns - -`string` - -Typescript class file - -## Defined in - -[src/parser/generator.ts:495](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L495) diff --git a/docs/api/namespaces/Generator/functions/introspect.md b/docs/api/namespaces/Generator/functions/introspect.md deleted file mode 100644 index 23c5ef36..00000000 --- a/docs/api/namespaces/Generator/functions/introspect.md +++ /dev/null @@ -1,31 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / introspect - -# Function: introspect() - -> **introspect**(`classdata`): `object` - -Introspect an example of a class in order to determine its key info and dependencies - -## Parameters - -• **classdata**: `unknown` - -The example of the class - -## Returns - -`object` - -The key info and any unimplemented dependencies - -### key\_info - -> **key\_info**: readonly [`string`, [`InferenceType`](../type-aliases/InferenceType.md)][] - -### unimplemented\_dependencies - -> **unimplemented\_dependencies**: [`string`, `any`][] - -## Defined in - -[src/parser/generator.ts:376](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L376) diff --git a/docs/api/namespaces/Generator/functions/isIgnoredKey.md b/docs/api/namespaces/Generator/functions/isIgnoredKey.md deleted file mode 100644 index 15366726..00000000 --- a/docs/api/namespaces/Generator/functions/isIgnoredKey.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / isIgnoredKey - -# Function: isIgnoredKey() - -> **isIgnoredKey**(`key`): `boolean` - -Is this key ignored by the parser? - -## Parameters - -• **key**: `string` \| `symbol` - -The key to check - -## Returns - -`boolean` - -Whether or not the key is ignored - -## Defined in - -[src/parser/generator.ts:400](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L400) diff --git a/docs/api/namespaces/Generator/functions/isMiscType.md b/docs/api/namespaces/Generator/functions/isMiscType.md deleted file mode 100644 index 775e8d21..00000000 --- a/docs/api/namespaces/Generator/functions/isMiscType.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / isMiscType - -# Function: isMiscType() - -> **isMiscType**(`key`, `value`): [`MiscInferenceType`](../type-aliases/MiscInferenceType.md) \| `false` - -Check if the given value is a misc type. - -## Parameters - -• **key**: `string` - -The key of the value - -• **value**: `unknown` - -The value to check - -## Returns - -[`MiscInferenceType`](../type-aliases/MiscInferenceType.md) \| `false` - -If it is a misc type, return the InferenceType. Otherwise, return false. - -## Defined in - -[src/parser/generator.ts:163](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L163) diff --git a/docs/api/namespaces/Generator/functions/isRenderer.md b/docs/api/namespaces/Generator/functions/isRenderer.md deleted file mode 100644 index cf37945c..00000000 --- a/docs/api/namespaces/Generator/functions/isRenderer.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / isRenderer - -# Function: isRenderer() - -> **isRenderer**(`value`): `string` \| `false` - -Check if the given value is a renderer - -## Parameters - -• **value**: `unknown` - -The value to check - -## Returns - -`string` \| `false` - -If it is a renderer, return the class name. Otherwise, return false. - -## Defined in - -[src/parser/generator.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L202) diff --git a/docs/api/namespaces/Generator/functions/isRendererList.md b/docs/api/namespaces/Generator/functions/isRendererList.md deleted file mode 100644 index 1e0d68e0..00000000 --- a/docs/api/namespaces/Generator/functions/isRendererList.md +++ /dev/null @@ -1,24 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / isRendererList - -# Function: isRendererList() - -> **isRendererList**(`value`): `false` \| `object` - -Checks if the given value is an array of renderers - -## Parameters - -• **value**: `unknown` - -The value to check - -## Returns - -`false` \| `object` - -If it is a renderer list, return an object with keys being the classnames, and values being an example of that class. -Otherwise, return false. - -## Defined in - -[src/parser/generator.ts:141](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L141) diff --git a/docs/api/namespaces/Generator/functions/mergeKeyInfo.md b/docs/api/namespaces/Generator/functions/mergeKeyInfo.md deleted file mode 100644 index 4e16bf0c..00000000 --- a/docs/api/namespaces/Generator/functions/mergeKeyInfo.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / mergeKeyInfo - -# Function: mergeKeyInfo() - -> **mergeKeyInfo**(`key_info`, `new_key_info`): `object` - -Merges two sets of key info, resolving any conflicts - -## Parameters - -• **key\_info**: [`KeyInfo`](../type-aliases/KeyInfo.md) - -The current key info - -• **new\_key\_info**: [`KeyInfo`](../type-aliases/KeyInfo.md) - -The new key info - -## Returns - -`object` - -The merged key info - -### changed\_keys - -> **changed\_keys**: [`string`, [`InferenceType`](../type-aliases/InferenceType.md)][] - -### resolved\_key\_info - -> **resolved\_key\_info**: [`string`, [`InferenceType`](../type-aliases/InferenceType.md)][] - -## Defined in - -[src/parser/generator.ts:734](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L734) diff --git a/docs/api/namespaces/Generator/functions/parse.md b/docs/api/namespaces/Generator/functions/parse.md deleted file mode 100644 index cfa29efe..00000000 --- a/docs/api/namespaces/Generator/functions/parse.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / parse - -# Function: parse() - -> **parse**(`key`, `inference_type`, `data`, `key_path`): `any` - -Parse a value from a given key path using the given inference type - -## Parameters - -• **key**: `string` - -The key to parse - -• **inference\_type**: [`InferenceType`](../type-aliases/InferenceType.md) - -The inference type to parse - -• **data**: `unknown` - -The data to parse from - -• **key\_path**: `string`[] = `...` - -The path to the key (excluding the key itself) - -## Returns - -`any` - -The parsed value - -## Defined in - -[src/parser/generator.ts:681](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L681) diff --git a/docs/api/namespaces/Generator/functions/toParser.md b/docs/api/namespaces/Generator/functions/toParser.md deleted file mode 100644 index cdd0e646..00000000 --- a/docs/api/namespaces/Generator/functions/toParser.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / toParser - -# Function: toParser() - -> **toParser**(`key`, `inference_type`, `key_path`, `indentation`): `string` - -Generate statements to parse a given inference type - -## Parameters - -• **key**: `string` - -The key to parse - -• **inference\_type**: [`InferenceType`](../type-aliases/InferenceType.md) - -The inference type to parse - -• **key\_path**: `string`[] = `...` - -The path to the key (excluding the key itself) - -• **indentation**: `number` = `1` - -The indentation level (used for objects) - -## Returns - -`string` - -Statement to parse the given key - -## Defined in - -[src/parser/generator.ts:578](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L578) diff --git a/docs/api/namespaces/Generator/functions/toTypeDeclaration.md b/docs/api/namespaces/Generator/functions/toTypeDeclaration.md deleted file mode 100644 index e7526bff..00000000 --- a/docs/api/namespaces/Generator/functions/toTypeDeclaration.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / toTypeDeclaration - -# Function: toTypeDeclaration() - -> **toTypeDeclaration**(`inference_type`, `indentation`): `string` - -For a given inference type, get the typescript type declaration - -## Parameters - -• **inference\_type**: [`InferenceType`](../type-aliases/InferenceType.md) - -The inference type to get the declaration for - -• **indentation**: `number` = `0` - -The indentation level (used for objects) - -## Returns - -`string` - -Typescript type declaration - -## Defined in - -[src/parser/generator.ts:520](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L520) diff --git a/docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md b/docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md deleted file mode 100644 index 4b5c5a82..00000000 --- a/docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md +++ /dev/null @@ -1,33 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / ObjectInferenceType - -# Interface: ObjectInferenceType - -## Properties - -### keys - -> **keys**: [`KeyInfo`](../type-aliases/KeyInfo.md) - -#### Defined in - -[src/parser/generator.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L39) - -*** - -### optional - -> **optional**: `boolean` - -#### Defined in - -[src/parser/generator.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L40) - -*** - -### type - -> **type**: `"object"` - -#### Defined in - -[src/parser/generator.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L38) diff --git a/docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md b/docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md deleted file mode 100644 index 8e3d283f..00000000 --- a/docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md +++ /dev/null @@ -1,33 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / PrimitiveInferenceType - -# Interface: PrimitiveInferenceType - -## Properties - -### optional - -> **optional**: `boolean` - -#### Defined in - -[src/parser/generator.ts:52](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L52) - -*** - -### type - -> **type**: `"primitive"` - -#### Defined in - -[src/parser/generator.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L50) - -*** - -### typeof - -> **typeof**: (`"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"symbol"` \| `"undefined"` \| `"function"` \| `"unknown"` \| `"never"`)[] - -#### Defined in - -[src/parser/generator.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L51) diff --git a/docs/api/namespaces/Generator/interfaces/RendererInferenceType.md b/docs/api/namespaces/Generator/interfaces/RendererInferenceType.md deleted file mode 100644 index 5793e446..00000000 --- a/docs/api/namespaces/Generator/interfaces/RendererInferenceType.md +++ /dev/null @@ -1,33 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / RendererInferenceType - -# Interface: RendererInferenceType - -## Properties - -### optional - -> **optional**: `boolean` - -#### Defined in - -[src/parser/generator.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L46) - -*** - -### renderers - -> **renderers**: `string`[] - -#### Defined in - -[src/parser/generator.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L45) - -*** - -### type - -> **type**: `"renderer"` - -#### Defined in - -[src/parser/generator.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L44) diff --git a/docs/api/namespaces/Generator/type-aliases/ArrayInferenceType.md b/docs/api/namespaces/Generator/type-aliases/ArrayInferenceType.md deleted file mode 100644 index a12689ec..00000000 --- a/docs/api/namespaces/Generator/type-aliases/ArrayInferenceType.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / ArrayInferenceType - -# Type Alias: ArrayInferenceType - -> **ArrayInferenceType**: `object` \| `object` \| `object` - -## Defined in - -[src/parser/generator.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L55) diff --git a/docs/api/namespaces/Generator/type-aliases/InferenceType.md b/docs/api/namespaces/Generator/type-aliases/InferenceType.md deleted file mode 100644 index 42f687c3..00000000 --- a/docs/api/namespaces/Generator/type-aliases/InferenceType.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / InferenceType - -# Type Alias: InferenceType - -> **InferenceType**: [`RendererInferenceType`](../interfaces/RendererInferenceType.md) \| [`MiscInferenceType`](MiscInferenceType.md) \| [`ObjectInferenceType`](../interfaces/ObjectInferenceType.md) \| [`PrimitiveInferenceType`](../interfaces/PrimitiveInferenceType.md) \| [`ArrayInferenceType`](ArrayInferenceType.md) - -## Defined in - -[src/parser/generator.ts:72](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L72) diff --git a/docs/api/namespaces/Generator/type-aliases/KeyInfo.md b/docs/api/namespaces/Generator/type-aliases/KeyInfo.md deleted file mode 100644 index 208d8ae0..00000000 --- a/docs/api/namespaces/Generator/type-aliases/KeyInfo.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / KeyInfo - -# Type Alias: KeyInfo - -> **KeyInfo**: readonly [`string`, [`InferenceType`](InferenceType.md)][] - -## Defined in - -[src/parser/generator.ts:74](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L74) diff --git a/docs/api/namespaces/Generator/type-aliases/MiscInferenceType.md b/docs/api/namespaces/Generator/type-aliases/MiscInferenceType.md deleted file mode 100644 index c27a205c..00000000 --- a/docs/api/namespaces/Generator/type-aliases/MiscInferenceType.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / MiscInferenceType - -# Type Alias: MiscInferenceType - -> **MiscInferenceType**: `object` \| `object` \| `object` \| `object` - -## Defined in - -[src/parser/generator.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/generator.ts#L15) diff --git a/docs/api/namespaces/Helpers/classes/Maybe.md b/docs/api/namespaces/Helpers/classes/Maybe.md deleted file mode 100644 index 33ac43a1..00000000 --- a/docs/api/namespaces/Helpers/classes/Maybe.md +++ /dev/null @@ -1,605 +0,0 @@ -[youtubei.js](../../../README.md) / [Helpers](../README.md) / Maybe - -# Class: Maybe - -A wrapper class that provides type-safe access to a value. - -## Constructors - -### new Maybe() - -> **new Maybe**(`value`): [`Maybe`](Maybe.md) - -#### Parameters - -• **value**: `any` - -#### Returns - -[`Maybe`](Maybe.md) - -#### Defined in - -[src/parser/helpers.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L67) - -## Accessors - -### typeof - -> `get` **typeof**(): `"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"symbol"` \| `"undefined"` \| `"object"` \| `"function"` - -#### Returns - -`"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"symbol"` \| `"undefined"` \| `"object"` \| `"function"` - -#### Defined in - -[src/parser/helpers.ts:82](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L82) - -## Methods - -### ~~any()~~ - -> **any**(): `any` - -#### Returns - -`any` - -#### Deprecated - -This call is not meant to be used outside of debugging. Please use the specific type getter instead. - -#### Defined in - -[src/parser/helpers.ts:278](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L278) - -*** - -### array() - -> **array**(): `any`[] - -Get the value as an array. - -#### Returns - -`any`[] - -the value as any[]. - -#### Throws - -If the value is not an array. - -#### Defined in - -[src/parser/helpers.ts:166](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L166) - -*** - -### arrayOfMaybe() - -> **arrayOfMaybe**(): [`Maybe`](Maybe.md)[] - -More typesafe variant of [Maybe#array](Maybe.md#array). - -#### Returns - -[`Maybe`](Maybe.md)[] - -a proxied array which returns all the values as [Maybe](Maybe.md). - -#### Throws - -If the value is not an array - -#### Defined in - -[src/parser/helpers.ts:178](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L178) - -*** - -### bigint() - -> **bigint**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -[src/parser/helpers.ts:102](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L102) - -*** - -### boolean() - -> **boolean**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:110](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L110) - -*** - -### function() - -> **function**(): `Function` - -#### Returns - -`Function` - -#### Defined in - -[src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L153) - -*** - -### instanceof() - -> **instanceof**\<`T`\>(`type`): `T` - -Get the node as an instance of the given class. - -#### Type Parameters - -• **T** *extends* `object` - -#### Parameters - -• **type**: [`Constructor`](../interfaces/Constructor.md)\<`T`\> - -The type to check. - -#### Returns - -`T` - -the value as the given type. - -#### Throws - -If the node is not of the given type. - -#### Defined in - -[src/parser/helpers.ts:289](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L289) - -*** - -### isArray() - -> **isArray**(): `boolean` - -Check whether the value is an array. - -#### Returns - -`boolean` - -whether the value is an array. - -#### Defined in - -[src/parser/helpers.ts:194](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L194) - -*** - -### isBigint() - -> **isBigint**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:106](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L106) - -*** - -### isBoolean() - -> **isBoolean**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:114](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L114) - -*** - -### isFunction() - -> **isFunction**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:157](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L157) - -*** - -### isInstanceof() - -> **isInstanceof**\<`T`\>(`type`): `this is Maybe & T` - -Check if the node is an instance of the given class. - -#### Type Parameters - -• **T** *extends* `object` - -#### Parameters - -• **type**: [`Constructor`](../interfaces/Constructor.md)\<`T`\> - -The type to check. - -#### Returns - -`this is Maybe & T` - -Whether the node is an instance of the given type. - -#### Defined in - -[src/parser/helpers.ts:301](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L301) - -*** - -### isNode() - -> **isNode**(): `boolean` - -Check if the value is a YTNode. - -#### Returns - -`boolean` - -Whether the value is a YTNode. - -#### Defined in - -[src/parser/helpers.ts:214](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L214) - -*** - -### isNodeOfType() - -> **isNodeOfType**\<`T`, `K`\>(...`types`): `boolean` - -Check if the value is a YTNode of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -the type(s) to check. - -#### Returns - -`boolean` - -Whether the value is a YTNode of the given type. - -#### Defined in - -[src/parser/helpers.ts:233](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L233) - -*** - -### isNull() - -> **isNull**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:140](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L140) - -*** - -### isNumber() - -> **isNumber**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:98](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L98) - -*** - -### isObject() - -> **isObject**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:148](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L148) - -*** - -### isObserved() - -> **isObserved**(): `any` - -Check if the value is an ObservedArray. - -#### Returns - -`any` - -#### Defined in - -[src/parser/helpers.ts:251](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L251) - -*** - -### isParsed() - -> **isParsed**(): `boolean` - -Is the result a SuperParsedResult? - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:270](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L270) - -*** - -### isString() - -> **isString**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:90](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L90) - -*** - -### isSymbol() - -> **isSymbol**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:122](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L122) - -*** - -### isUndefined() - -> **isUndefined**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:130](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L130) - -*** - -### node() - -> **node**(): [`YTNode`](YTNode.md) - -Get the value as a YTNode. - -#### Returns - -[`YTNode`](YTNode.md) - -the value as a YTNode. - -#### Throws - -If the value is not a YTNode. - -#### Defined in - -[src/parser/helpers.ts:203](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L203) - -*** - -### nodeOfType() - -> **nodeOfType**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Get the value as a YTNode of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type(s) to cast to. - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to the given type. - -#### Throws - -If the node is not of the given type. - -#### Defined in - -[src/parser/helpers.ts:224](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L224) - -*** - -### null() - -> **null**(): `null` - -#### Returns - -`null` - -#### Defined in - -[src/parser/helpers.ts:134](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L134) - -*** - -### number() - -> **number**(): `number` - -#### Returns - -`number` - -#### Defined in - -[src/parser/helpers.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L94) - -*** - -### object() - -> **object**(): `object` - -#### Returns - -`object` - -#### Defined in - -[src/parser/helpers.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L144) - -*** - -### observed() - -> **observed**(): [`ObservedArray`](../type-aliases/ObservedArray.md)\<[`YTNode`](YTNode.md)\> - -Get the value as an ObservedArray. - -#### Returns - -[`ObservedArray`](../type-aliases/ObservedArray.md)\<[`YTNode`](YTNode.md)\> - -the value of the Maybe as a ObservedArray. - -#### Defined in - -[src/parser/helpers.ts:241](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L241) - -*** - -### parsed() - -> **parsed**(): [`SuperParsedResult`](SuperParsedResult.md)\<[`YTNode`](YTNode.md)\> - -Get the value of the Maybe as a SuperParsedResult. - -#### Returns - -[`SuperParsedResult`](SuperParsedResult.md)\<[`YTNode`](YTNode.md)\> - -the value as a SuperParsedResult. - -#### Throws - -If the value is not a SuperParsedResult. - -#### Defined in - -[src/parser/helpers.ts:260](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L260) - -*** - -### string() - -> **string**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/parser/helpers.ts:86](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L86) - -*** - -### symbol() - -> **symbol**(): `symbol` - -#### Returns - -`symbol` - -#### Defined in - -[src/parser/helpers.ts:118](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L118) - -*** - -### undefined() - -> **undefined**(): `undefined` - -#### Returns - -`undefined` - -#### Defined in - -[src/parser/helpers.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L126) diff --git a/docs/api/namespaces/Helpers/classes/SuperParsedResult.md b/docs/api/namespaces/Helpers/classes/SuperParsedResult.md deleted file mode 100644 index 0d6d498a..00000000 --- a/docs/api/namespaces/Helpers/classes/SuperParsedResult.md +++ /dev/null @@ -1,97 +0,0 @@ -[youtubei.js](../../../README.md) / [Helpers](../README.md) / SuperParsedResult - -# Class: SuperParsedResult\ - -Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] or null. - -## Type Parameters - -• **T** *extends* [`YTNode`](YTNode.md) = [`YTNode`](YTNode.md) - -## Constructors - -### new SuperParsedResult() - -> **new SuperParsedResult**\<`T`\>(`result`): [`SuperParsedResult`](SuperParsedResult.md)\<`T`\> - -#### Parameters - -• **result**: `null` \| `T` \| [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\> - -#### Returns - -[`SuperParsedResult`](SuperParsedResult.md)\<`T`\> - -#### Defined in - -[src/parser/helpers.ts:321](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L321) - -## Accessors - -### is\_array - -> `get` **is\_array**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:328](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L328) - -*** - -### is\_node - -> `get` **is\_node**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:331](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L331) - -*** - -### is\_null - -> `get` **is\_null**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/helpers.ts:325](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L325) - -## Methods - -### array() - -> **array**(): [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\> - -#### Returns - -[`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\> - -#### Defined in - -[src/parser/helpers.ts:335](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L335) - -*** - -### item() - -> **item**(): `T` - -#### Returns - -`T` - -#### Defined in - -[src/parser/helpers.ts:342](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L342) diff --git a/docs/api/namespaces/Helpers/interfaces/Constructor.md b/docs/api/namespaces/Helpers/interfaces/Constructor.md deleted file mode 100644 index ebb3b344..00000000 --- a/docs/api/namespaces/Helpers/interfaces/Constructor.md +++ /dev/null @@ -1,25 +0,0 @@ -[youtubei.js](../../../README.md) / [Helpers](../README.md) / Constructor - -# Interface: Constructor\ - -## Type Parameters - -• **T** - -## Constructors - -### new Constructor() - -> **new Constructor**(...`args`): `T` - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`T` - -#### Defined in - -[src/parser/helpers.ts:307](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L307) diff --git a/docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md b/docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md deleted file mode 100644 index 8eedab2b..00000000 --- a/docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [Helpers](../README.md) / YTNodeConstructor - -# Interface: YTNodeConstructor\ - -## Type Parameters - -• **T** *extends* [`YTNode`](../classes/YTNode.md) = [`YTNode`](../classes/YTNode.md) - -## Constructors - -### new YTNodeConstructor() - -> **new YTNodeConstructor**(`data`): `T` - -#### Parameters - -• **data**: `any` - -#### Returns - -`T` - -#### Defined in - -[src/parser/helpers.ts:311](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L311) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Defined in - -[src/parser/helpers.ts:312](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L312) diff --git a/docs/api/namespaces/JsHelpers/functions/getNodeSourceRange.md b/docs/api/namespaces/JsHelpers/functions/getNodeSourceRange.md deleted file mode 100644 index f1508558..00000000 --- a/docs/api/namespaces/JsHelpers/functions/getNodeSourceRange.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / getNodeSourceRange - -# Function: getNodeSourceRange() - -> **getNodeSourceRange**(`node`): [`number`, `number`] \| `null` - -Returns the source range of an ESTree node as a tuple of start and end positions. - -## Parameters - -• **node**: `undefined` \| `null` \| `Node` - -The ESTree node to extract the source range from. - -## Returns - -[`number`, `number`] \| `null` - -A tuple `[start, end]` representing the source range, or `null` if unavailable. - -## Defined in - -[src/utils/javascript/helpers.ts:130](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L130) diff --git a/docs/api/namespaces/JsHelpers/functions/memberBaseName.md b/docs/api/namespaces/JsHelpers/functions/memberBaseName.md deleted file mode 100644 index b60af1e5..00000000 --- a/docs/api/namespaces/JsHelpers/functions/memberBaseName.md +++ /dev/null @@ -1,25 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / memberBaseName - -# Function: memberBaseName() - -> **memberBaseName**(`memberExpression`, `source`): `string` \| `null` - -Retrieves the base identifier for a member expression chain. - -## Parameters - -• **memberExpression**: `MemberExpression` - -Member expression whose root should be resolved. - -• **source**: `string` - -Original source code for range lookups. - -## Returns - -`string` \| `null` - -## Defined in - -[src/utils/javascript/helpers.ts:193](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L193) diff --git a/docs/api/namespaces/JsHelpers/functions/memberToString.md b/docs/api/namespaces/JsHelpers/functions/memberToString.md deleted file mode 100644 index 457438d8..00000000 --- a/docs/api/namespaces/JsHelpers/functions/memberToString.md +++ /dev/null @@ -1,25 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / memberToString - -# Function: memberToString() - -> **memberToString**(`memberExpression`, `source`): `string` \| `null` - -Converts a member expression into its dot/bracket string form. - -## Parameters - -• **memberExpression**: `Node` - -Member expression node to stringify. - -• **source**: `string` - -Original source code for range lookups. - -## Returns - -`string` \| `null` - -## Defined in - -[src/utils/javascript/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L153) diff --git a/docs/api/namespaces/JsHelpers/type-aliases/AstVisitFn.md b/docs/api/namespaces/JsHelpers/type-aliases/AstVisitFn.md deleted file mode 100644 index 1fedcdbf..00000000 --- a/docs/api/namespaces/JsHelpers/type-aliases/AstVisitFn.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / AstVisitFn - -# Type Alias: AstVisitFn() - -> **AstVisitFn**: (`node`, `parent`, `ancestors`) => [`AstVisitResult`](AstVisitResult.md) - -## Parameters - -• **node**: `ESTree.Node` - -• **parent**: `ESTree.Node` \| `null` - -• **ancestors**: `ESTree.Node`[] - -## Returns - -[`AstVisitResult`](AstVisitResult.md) - -## Defined in - -[src/utils/javascript/helpers.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L26) diff --git a/docs/api/namespaces/JsHelpers/type-aliases/AstVisitResult.md b/docs/api/namespaces/JsHelpers/type-aliases/AstVisitResult.md deleted file mode 100644 index 94d9b57f..00000000 --- a/docs/api/namespaces/JsHelpers/type-aliases/AstVisitResult.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / AstVisitResult - -# Type Alias: AstVisitResult - -> **AstVisitResult**: `boolean` \| *typeof* [`WALK_STOP`](../variables/WALK_STOP.md) \| `void` - -## Defined in - -[src/utils/javascript/helpers.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L25) diff --git a/docs/api/namespaces/JsHelpers/type-aliases/AstVisitor.md b/docs/api/namespaces/JsHelpers/type-aliases/AstVisitor.md deleted file mode 100644 index 26a1f269..00000000 --- a/docs/api/namespaces/JsHelpers/type-aliases/AstVisitor.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / AstVisitor - -# Type Alias: AstVisitor - -> **AstVisitor**: [`AstVisitFn`](AstVisitFn.md) \| [`AstVisitObject`](../interfaces/AstVisitObject.md) - -## Defined in - -[src/utils/javascript/helpers.ts:52](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L52) diff --git a/docs/api/namespaces/JsHelpers/variables/WALK_STOP.md b/docs/api/namespaces/JsHelpers/variables/WALK_STOP.md deleted file mode 100644 index 65486c94..00000000 --- a/docs/api/namespaces/JsHelpers/variables/WALK_STOP.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / WALK\_STOP - -# Variable: WALK\_STOP - -> `const` **WALK\_STOP**: *typeof* [`WALK_STOP`](WALK_STOP.md) - -## Defined in - -[src/utils/javascript/helpers.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L4) diff --git a/docs/api/namespaces/JsHelpers/variables/indent.md b/docs/api/namespaces/JsHelpers/variables/indent.md deleted file mode 100644 index 0c015cbc..00000000 --- a/docs/api/namespaces/JsHelpers/variables/indent.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / indent - -# Variable: indent - -> `const` **indent**: `" "` = `' '` - -## Defined in - -[src/utils/javascript/helpers.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L23) diff --git a/docs/api/namespaces/JsHelpers/variables/jsBuiltIns.md b/docs/api/namespaces/JsHelpers/variables/jsBuiltIns.md deleted file mode 100644 index 15018e8c..00000000 --- a/docs/api/namespaces/JsHelpers/variables/jsBuiltIns.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [JsHelpers](../README.md) / jsBuiltIns - -# Variable: jsBuiltIns - -> `const` **jsBuiltIns**: `Set`\<`string`\> - -## Defined in - -[src/utils/javascript/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/helpers.ts#L6) diff --git a/docs/api/namespaces/JsMatchers/functions/nMatcher.md b/docs/api/namespaces/JsMatchers/functions/nMatcher.md deleted file mode 100644 index 3d969d27..00000000 --- a/docs/api/namespaces/JsMatchers/functions/nMatcher.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [JsMatchers](../README.md) / nMatcher - -# Function: nMatcher() - -> **nMatcher**(`node`): `false` \| `Identifier` - -## Parameters - -• **node**: `Node` - -## Returns - -`false` \| `Identifier` - -## Defined in - -[src/utils/javascript/matchers.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/matchers.ts#L53) diff --git a/docs/api/namespaces/JsMatchers/functions/sigMatcher.md b/docs/api/namespaces/JsMatchers/functions/sigMatcher.md deleted file mode 100644 index 81de626e..00000000 --- a/docs/api/namespaces/JsMatchers/functions/sigMatcher.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [JsMatchers](../README.md) / sigMatcher - -# Function: sigMatcher() - -> **sigMatcher**(`node`): `false` \| `CallExpression` - -## Parameters - -• **node**: `Node` - -## Returns - -`false` \| `CallExpression` - -## Defined in - -[src/utils/javascript/matchers.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/matchers.ts#L4) diff --git a/docs/api/namespaces/JsMatchers/functions/timestampMatcher.md b/docs/api/namespaces/JsMatchers/functions/timestampMatcher.md deleted file mode 100644 index c4b86f02..00000000 --- a/docs/api/namespaces/JsMatchers/functions/timestampMatcher.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [JsMatchers](../README.md) / timestampMatcher - -# Function: timestampMatcher() - -> **timestampMatcher**(`node`): `boolean` - -## Parameters - -• **node**: `Node` - -## Returns - -`boolean` - -## Defined in - -[src/utils/javascript/matchers.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/matchers.ts#L68) diff --git a/docs/api/namespaces/LZW/functions/compress.md b/docs/api/namespaces/LZW/functions/compress.md deleted file mode 100644 index b01f6149..00000000 --- a/docs/api/namespaces/LZW/functions/compress.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [LZW](../README.md) / compress - -# Function: compress() - -> **compress**(`input`): `string` - -Compresses a string using the LZW compression algorithm. - -## Parameters - -• **input**: `string` - -The data to compress. - -## Returns - -`string` - -## Defined in - -[src/utils/LZW.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/LZW.ts#L5) diff --git a/docs/api/namespaces/LZW/functions/decompress.md b/docs/api/namespaces/LZW/functions/decompress.md deleted file mode 100644 index 2f3e25e2..00000000 --- a/docs/api/namespaces/LZW/functions/decompress.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [LZW](../README.md) / decompress - -# Function: decompress() - -> **decompress**(`input`): `string` - -Decompresses data that was compressed using the LZW compression algorithm. - -## Parameters - -• **input**: `string` - -The data to be decompressed. - -## Returns - -`string` - -## Defined in - -[src/utils/LZW.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/LZW.ts#L40) diff --git a/docs/api/namespaces/Log/functions/debug.md b/docs/api/namespaces/Log/functions/debug.md deleted file mode 100644 index 70a9f2b3..00000000 --- a/docs/api/namespaces/Log/functions/debug.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Log](../README.md) / debug - -# Function: debug() - -> **debug**(`tag`?, ...`args`?): `void` - -## Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -## Returns - -`void` - -## Defined in - -[src/utils/Log.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Log.ts#L44) diff --git a/docs/api/namespaces/Log/functions/error.md b/docs/api/namespaces/Log/functions/error.md deleted file mode 100644 index b5912567..00000000 --- a/docs/api/namespaces/Log/functions/error.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Log](../README.md) / error - -# Function: error() - -> **error**(`tag`?, ...`args`?): `void` - -## Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -## Returns - -`void` - -## Defined in - -[src/utils/Log.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Log.ts#L42) diff --git a/docs/api/namespaces/Log/functions/info.md b/docs/api/namespaces/Log/functions/info.md deleted file mode 100644 index 427648ab..00000000 --- a/docs/api/namespaces/Log/functions/info.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Log](../README.md) / info - -# Function: info() - -> **info**(`tag`?, ...`args`?): `void` - -## Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -## Returns - -`void` - -## Defined in - -[src/utils/Log.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Log.ts#L43) diff --git a/docs/api/namespaces/Log/functions/setLevel.md b/docs/api/namespaces/Log/functions/setLevel.md deleted file mode 100644 index 39247d54..00000000 --- a/docs/api/namespaces/Log/functions/setLevel.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Log](../README.md) / setLevel - -# Function: setLevel() - -> **setLevel**(...`args`): `void` - -## Parameters - -• ...**args**: `number`[] - -## Returns - -`void` - -## Defined in - -[src/utils/Log.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Log.ts#L46) diff --git a/docs/api/namespaces/Log/functions/warn.md b/docs/api/namespaces/Log/functions/warn.md deleted file mode 100644 index 5f0d92c9..00000000 --- a/docs/api/namespaces/Log/functions/warn.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Log](../README.md) / warn - -# Function: warn() - -> **warn**(`tag`?, ...`args`?): `void` - -## Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -## Returns - -`void` - -## Defined in - -[src/utils/Log.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Log.ts#L41) diff --git a/docs/api/namespaces/Log/functions/warnOnce.md b/docs/api/namespaces/Log/functions/warnOnce.md deleted file mode 100644 index b12abfdf..00000000 --- a/docs/api/namespaces/Log/functions/warnOnce.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Log](../README.md) / warnOnce - -# Function: warnOnce() - -> **warnOnce**(`id`, ...`args`): `void` - -## Parameters - -• **id**: `string` - -• ...**args**: `any`[] - -## Returns - -`void` - -## Defined in - -[src/utils/Log.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Log.ts#L33) diff --git a/docs/api/namespaces/Managers/classes/AccountManager.md b/docs/api/namespaces/Managers/classes/AccountManager.md deleted file mode 100644 index ade304fc..00000000 --- a/docs/api/namespaces/Managers/classes/AccountManager.md +++ /dev/null @@ -1,77 +0,0 @@ -[youtubei.js](../../../README.md) / [Managers](../README.md) / AccountManager - -# Class: AccountManager - -## Constructors - -### new AccountManager() - -> **new AccountManager**(`actions`): [`AccountManager`](AccountManager.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`AccountManager`](AccountManager.md) - -#### Defined in - -[src/core/managers/AccountManager.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/AccountManager.ts#L13) - -## Methods - -### getInfo() - -#### getInfo(all) - -> **getInfo**(`all`): `Promise`\<[`AccountItem`](../../YTNodes/classes/AccountItem.md)[]\> - -Retrieves the list of channels belonging to the signed-in account. Only useful when signed in through cookie. If signed in through OAuth, you will get the active channel only. - -##### Parameters - -• **all**: `true` - -##### Returns - -`Promise`\<[`AccountItem`](../../YTNodes/classes/AccountItem.md)[]\> - -##### Defined in - -[src/core/managers/AccountManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/AccountManager.ts#L20) - -#### getInfo(all) - -> **getInfo**(`all`?): `Promise`\<[`AccountInfo`](../../YT/classes/AccountInfo.md)\> - -Retrieves the active channel info for the signed-in account. Throws error if `on_behalf_of_user` was used to create the Innertube instance; use `getInfo(true)` instead. - -##### Parameters - -• **all?**: `false` - -##### Returns - -`Promise`\<[`AccountInfo`](../../YT/classes/AccountInfo.md)\> - -##### Defined in - -[src/core/managers/AccountManager.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/AccountManager.ts#L24) - -*** - -### getSettings() - -> **getSettings**(): `Promise`\<[`Settings`](../../YT/classes/Settings.md)\> - -Gets YouTube settings. - -#### Returns - -`Promise`\<[`Settings`](../../YT/classes/Settings.md)\> - -#### Defined in - -[src/core/managers/AccountManager.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/AccountManager.ts#L50) diff --git a/docs/api/namespaces/Managers/classes/InteractionManager.md b/docs/api/namespaces/Managers/classes/InteractionManager.md deleted file mode 100644 index 896d7abd..00000000 --- a/docs/api/namespaces/Managers/classes/InteractionManager.md +++ /dev/null @@ -1,234 +0,0 @@ -[youtubei.js](../../../README.md) / [Managers](../README.md) / InteractionManager - -# Class: InteractionManager - -## Constructors - -### new InteractionManager() - -> **new InteractionManager**(`actions`): [`InteractionManager`](InteractionManager.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`InteractionManager`](InteractionManager.md) - -#### Defined in - -[src/core/managers/InteractionManager.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L10) - -## Methods - -### comment() - -> **comment**(`video_id`, `text`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Posts a comment on a given video. - -#### Parameters - -• **video\_id**: `string` - -The video ID - -• **text**: `string` - -The comment text - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/InteractionManager.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L119) - -*** - -### dislike() - -> **dislike**(`video_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Dislikes a given video. - -#### Parameters - -• **video\_id**: `string` - -The video ID - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/InteractionManager.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L38) - -*** - -### like() - -> **like**(`video_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Likes a given video. - -#### Parameters - -• **video\_id**: `string` - -The video ID - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/InteractionManager.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L18) - -*** - -### removeRating() - -> **removeRating**(`video_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Removes a like/dislike. - -#### Parameters - -• **video\_id**: `string` - -The video ID - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/InteractionManager.ts:58](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L58) - -*** - -### setNotificationPreferences() - -> **setNotificationPreferences**(`channel_id`, `type`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Changes notification preferences for a given channel. -Only works with channels you are subscribed to. - -#### Parameters - -• **channel\_id**: `string` - -The channel ID. - -• **type**: `"PERSONALIZED"` \| `"ALL"` \| `"NONE"` - -The notification type. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/InteractionManager.ts:174](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L174) - -*** - -### subscribe() - -> **subscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Subscribes to the given channel. - -#### Parameters - -• **channel\_id**: `string` - -The channel ID - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/InteractionManager.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L78) - -*** - -### translate() - -> **translate**(`text`, `target_language`, `args`): `Promise`\<`object`\> - -Translates a given text using YouTube's comment translation feature. - -#### Parameters - -• **text**: `string` - -The text to translate - -• **target\_language**: `string` - -an ISO language code - -• **args** = `{}` - -optional arguments - -• **args.comment\_id?**: `string` - -• **args.video\_id?**: `string` - -#### Returns - -`Promise`\<`object`\> - -##### data - -> **data**: [`IRawResponse`](../../APIResponseTypes/interfaces/IRawResponse.md) = `response.data` - -##### status\_code - -> **status\_code**: `number` = `response.status_code` - -##### success - -> **success**: `boolean` = `response.success` - -##### translated\_content - -> **translated\_content**: `any` = `mutation.translatedContent.content` - -#### Defined in - -[src/core/managers/InteractionManager.ts:151](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L151) - -*** - -### unsubscribe() - -> **unsubscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Unsubscribes from the given channel. - -#### Parameters - -• **channel\_id**: `string` - -The channel ID - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/InteractionManager.ts:98](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/InteractionManager.ts#L98) diff --git a/docs/api/namespaces/Managers/classes/PlaylistManager.md b/docs/api/namespaces/Managers/classes/PlaylistManager.md deleted file mode 100644 index 0ee11279..00000000 --- a/docs/api/namespaces/Managers/classes/PlaylistManager.md +++ /dev/null @@ -1,323 +0,0 @@ -[youtubei.js](../../../README.md) / [Managers](../README.md) / PlaylistManager - -# Class: PlaylistManager - -## Constructors - -### new PlaylistManager() - -> **new PlaylistManager**(`actions`): [`PlaylistManager`](PlaylistManager.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`PlaylistManager`](PlaylistManager.md) - -#### Defined in - -[src/core/managers/PlaylistManager.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L11) - -## Methods - -### addToLibrary() - -> **addToLibrary**(`playlist_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Adds a given playlist to the library of a user. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/PlaylistManager.ts:73](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L73) - -*** - -### addVideos() - -> **addVideos**(`playlist_id`, `video_ids`): `Promise`\<`object`\> - -Adds videos to a given playlist. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -• **video\_ids**: `string`[] - -An array of video IDs to add to the playlist. - -#### Returns - -`Promise`\<`object`\> - -##### action\_result - -> **action\_result**: `any` - -##### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/core/managers/PlaylistManager.ts:114](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L114) - -*** - -### create() - -> **create**(`title`, `video_ids`): `Promise`\<`object`\> - -Creates a playlist. - -#### Parameters - -• **title**: `string` - -The title of the playlist. - -• **video\_ids**: `string`[] - -An array of video IDs to add to the playlist. - -#### Returns - -`Promise`\<`object`\> - -##### data - -> **data**: `any` - -##### playlist\_id? - -> `optional` **playlist\_id**: `string` - -##### status\_code - -> **status\_code**: `number` - -##### success - -> **success**: `boolean` - -#### Defined in - -[src/core/managers/PlaylistManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L20) - -*** - -### delete() - -> **delete**(`playlist_id`): `Promise`\<`object`\> - -Deletes a given playlist. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -#### Returns - -`Promise`\<`object`\> - -##### data - -> **data**: `any` - -##### playlist\_id - -> **playlist\_id**: `string` - -##### status\_code - -> **status\_code**: `number` - -##### success - -> **success**: `boolean` - -#### Defined in - -[src/core/managers/PlaylistManager.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L47) - -*** - -### moveVideo() - -> **moveVideo**(`playlist_id`, `moved_video_id`, `predecessor_video_id`): `Promise`\<`object`\> - -Moves a video to a new position within a given playlist. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -• **moved\_video\_id**: `string` - -The video ID to move. - -• **predecessor\_video\_id**: `string` - -The video ID to move the moved video before. - -#### Returns - -`Promise`\<`object`\> - -##### action\_result - -> **action\_result**: `any` - -##### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/core/managers/PlaylistManager.ts:194](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L194) - -*** - -### removeFromLibrary() - -> **removeFromLibrary**(`playlist_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Remove a given playlist to the library of a user. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/core/managers/PlaylistManager.ts:93](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L93) - -*** - -### removeVideos() - -> **removeVideos**(`playlist_id`, `video_ids`, `use_set_video_ids`): `Promise`\<`object`\> - -Removes videos from a given playlist. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -• **video\_ids**: `string`[] - -An array of video IDs to remove from the playlist. - -• **use\_set\_video\_ids**: `boolean` = `false` - -Option to remove videos using set video IDs. - -#### Returns - -`Promise`\<`object`\> - -##### action\_result - -> **action\_result**: `any` - -##### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/core/managers/PlaylistManager.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L144) - -*** - -### setDescription() - -> **setDescription**(`playlist_id`, `description`): `Promise`\<`object`\> - -Sets the description for the given playlist. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -• **description**: `string` - -The description to use for the playlist. - -#### Returns - -`Promise`\<`object`\> - -##### action\_result - -> **action\_result**: `any` - -##### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/core/managers/PlaylistManager.ts:282](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L282) - -*** - -### setName() - -> **setName**(`playlist_id`, `name`): `Promise`\<`object`\> - -Sets the name for the given playlist. - -#### Parameters - -• **playlist\_id**: `string` - -The playlist ID. - -• **name**: `string` - -The name / title to use for the playlist. - -#### Returns - -`Promise`\<`object`\> - -##### action\_result - -> **action\_result**: `any` - -##### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/core/managers/PlaylistManager.ts:255](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/managers/PlaylistManager.ts#L255) diff --git a/docs/api/namespaces/Misc/classes/AccessibilityContext.md b/docs/api/namespaces/Misc/classes/AccessibilityContext.md deleted file mode 100644 index caf7862b..00000000 --- a/docs/api/namespaces/Misc/classes/AccessibilityContext.md +++ /dev/null @@ -1,31 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / AccessibilityContext - -# Class: AccessibilityContext - -## Constructors - -### new AccessibilityContext() - -> **new AccessibilityContext**(`data`): [`AccessibilityContext`](AccessibilityContext.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AccessibilityContext`](AccessibilityContext.md) - -#### Defined in - -[src/parser/classes/misc/AccessibilityContext.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/AccessibilityContext.ts#L6) - -## Properties - -### label - -> **label**: `string` - -#### Defined in - -[src/parser/classes/misc/AccessibilityContext.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/AccessibilityContext.ts#L4) diff --git a/docs/api/namespaces/Misc/classes/AccessibilityData.md b/docs/api/namespaces/Misc/classes/AccessibilityData.md deleted file mode 100644 index ce57ffd5..00000000 --- a/docs/api/namespaces/Misc/classes/AccessibilityData.md +++ /dev/null @@ -1,51 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / AccessibilityData - -# Class: AccessibilityData - -## Constructors - -### new AccessibilityData() - -> **new AccessibilityData**(`data`): [`AccessibilityData`](AccessibilityData.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AccessibilityData`](AccessibilityData.md) - -#### Defined in - -[src/parser/classes/misc/AccessibilityData.ts:120](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/AccessibilityData.ts#L120) - -## Properties - -### accessibility\_identifier? - -> `optional` **accessibility\_identifier**: `string` - -#### Defined in - -[src/parser/classes/misc/AccessibilityData.ts:116](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/AccessibilityData.ts#L116) - -*** - -### identifier? - -> `optional` **identifier**: `AccessibilityId` - -#### Defined in - -[src/parser/classes/misc/AccessibilityData.ts:117](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/AccessibilityData.ts#L117) - -*** - -### label? - -> `optional` **label**: `string` - -#### Defined in - -[src/parser/classes/misc/AccessibilityData.ts:118](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/AccessibilityData.ts#L118) diff --git a/docs/api/namespaces/Misc/classes/Author.md b/docs/api/namespaces/Misc/classes/Author.md deleted file mode 100644 index fa072b35..00000000 --- a/docs/api/namespaces/Misc/classes/Author.md +++ /dev/null @@ -1,131 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / Author - -# Class: Author - -## Constructors - -### new Author() - -> **new Author**(`item`, `badges`?, `thumbs`?, `id`?): [`Author`](Author.md) - -#### Parameters - -• **item**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -• **badges?**: `any` - -• **thumbs?**: `any` - -• **id?**: `string` - -#### Returns - -[`Author`](Author.md) - -#### Defined in - -[src/parser/classes/misc/Author.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L21) - -## Properties - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/misc/Author.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L15) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/Author.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L14) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/misc/Author.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L11) - -*** - -### is\_moderator? - -> `optional` **is\_moderator**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Author.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L16) - -*** - -### is\_verified? - -> `optional` **is\_verified**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Author.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L17) - -*** - -### is\_verified\_artist? - -> `optional` **is\_verified\_artist**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Author.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L18) - -*** - -### name - -> **name**: `string` - -#### Defined in - -[src/parser/classes/misc/Author.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L12) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/misc/Author.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L13) - -*** - -### url - -> **url**: `string` - -#### Defined in - -[src/parser/classes/misc/Author.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L19) - -## Accessors - -### best\_thumbnail - -> `get` **best\_thumbnail**(): `undefined` \| [`Thumbnail`](Thumbnail.md) - -#### Returns - -`undefined` \| [`Thumbnail`](Thumbnail.md) - -#### Defined in - -[src/parser/classes/misc/Author.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Author.ts#L51) diff --git a/docs/api/namespaces/Misc/classes/ChildElement.md b/docs/api/namespaces/Misc/classes/ChildElement.md deleted file mode 100644 index bcb3d68a..00000000 --- a/docs/api/namespaces/Misc/classes/ChildElement.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / ChildElement - -# Class: ChildElement - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChildElement() - -> **new ChildElement**(`data`): [`ChildElement`](ChildElement.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChildElement`](ChildElement.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/misc/ChildElement.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/ChildElement.ts#L11) - -## Properties - -### child\_elements? - -> `optional` **child\_elements**: [`ChildElement`](ChildElement.md)[] - -#### Defined in - -[src/parser/classes/misc/ChildElement.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/ChildElement.ts#L9) - -*** - -### properties - -> **properties**: `any` - -#### Defined in - -[src/parser/classes/misc/ChildElement.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/ChildElement.ts#L8) - -*** - -### text? - -> `optional` **text**: `string` - -#### Defined in - -[src/parser/classes/misc/ChildElement.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/ChildElement.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChildElement'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/misc/ChildElement.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/ChildElement.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChildElement & { [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 ChildElement & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/Misc/classes/CommandContext.md b/docs/api/namespaces/Misc/classes/CommandContext.md deleted file mode 100644 index 431af3eb..00000000 --- a/docs/api/namespaces/Misc/classes/CommandContext.md +++ /dev/null @@ -1,121 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / CommandContext - -# Class: CommandContext - -## Constructors - -### new CommandContext() - -> **new CommandContext**(`data`): [`CommandContext`](CommandContext.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommandContext`](CommandContext.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L16) - -## Properties - -### on\_first\_visible? - -> `optional` **on\_first\_visible**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L13) - -*** - -### on\_focus? - -> `optional` **on\_focus**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L5) - -*** - -### on\_hidden? - -> `optional` **on\_hidden**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L6) - -*** - -### on\_hover? - -> `optional` **on\_hover**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L14) - -*** - -### on\_long\_press? - -> `optional` **on\_long\_press**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L9) - -*** - -### on\_tap? - -> `optional` **on\_tap**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L10) - -*** - -### on\_touch\_end? - -> `optional` **on\_touch\_end**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L7) - -*** - -### on\_touch\_move? - -> `optional` **on\_touch\_move**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L8) - -*** - -### on\_touch\_start? - -> `optional` **on\_touch\_start**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L11) - -*** - -### on\_visible? - -> `optional` **on\_visible**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/CommandContext.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/CommandContext.ts#L12) diff --git a/docs/api/namespaces/Misc/classes/EmojiRun.md b/docs/api/namespaces/Misc/classes/EmojiRun.md deleted file mode 100644 index ae3df3c1..00000000 --- a/docs/api/namespaces/Misc/classes/EmojiRun.md +++ /dev/null @@ -1,85 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / EmojiRun - -# Class: EmojiRun - -## Implements - -- `Run` - -## Constructors - -### new EmojiRun() - -> **new EmojiRun**(`data`): [`EmojiRun`](EmojiRun.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EmojiRun`](EmojiRun.md) - -#### Defined in - -[src/parser/classes/misc/EmojiRun.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/EmojiRun.ts#L17) - -## Properties - -### emoji - -> **emoji**: `Emoji` - -#### Defined in - -[src/parser/classes/misc/EmojiRun.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/EmojiRun.ts#L15) - -*** - -### text - -> **text**: `string` - -#### Implementation of - -`Run.text` - -#### Defined in - -[src/parser/classes/misc/EmojiRun.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/EmojiRun.ts#L14) - -## Methods - -### toHTML() - -> **toHTML**(): `string` - -#### Returns - -`string` - -#### Implementation of - -`Run.toHTML` - -#### Defined in - -[src/parser/classes/misc/EmojiRun.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/EmojiRun.ts#L37) - -*** - -### toString() - -> **toString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -`Run.toString` - -#### Defined in - -[src/parser/classes/misc/EmojiRun.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/EmojiRun.ts#L33) diff --git a/docs/api/namespaces/Misc/classes/Format.md b/docs/api/namespaces/Misc/classes/Format.md deleted file mode 100644 index 7672938c..00000000 --- a/docs/api/namespaces/Misc/classes/Format.md +++ /dev/null @@ -1,527 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / Format - -# Class: Format - -## Constructors - -### new Format() - -> **new Format**(`data`, `this_response_nsig_cache`?): [`Format`](Format.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -• **this\_response\_nsig\_cache?**: `Map`\<`string`, `string`\> - -#### Returns - -[`Format`](Format.md) - -#### Defined in - -[src/parser/classes/misc/Format.ts:87](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L87) - -## Properties - -### approx\_duration\_ms - -> **approx\_duration\_ms**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:60](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L60) - -*** - -### audio\_channels? - -> `optional` **audio\_channels**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:62](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L62) - -*** - -### audio\_quality? - -> `optional` **audio\_quality**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L59) - -*** - -### audio\_sample\_rate? - -> `optional` **audio\_sample\_rate**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:61](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L61) - -*** - -### audio\_track? - -> `optional` **audio\_track**: `AudioTrack` - -#### Defined in - -[src/parser/classes/misc/Format.ts:74](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L74) - -*** - -### average\_bitrate? - -> `optional` **average\_bitrate**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L51) - -*** - -### bitrate - -> **bitrate**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:52](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L52) - -*** - -### caption\_track? - -> `optional` **caption\_track**: `CaptionTrack` - -#### Defined in - -[src/parser/classes/misc/Format.ts:85](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L85) - -*** - -### cipher? - -> `optional` **cipher**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:73](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L73) - -*** - -### color\_info? - -> `optional` **color\_info**: `ColorInfo` - -#### Defined in - -[src/parser/classes/misc/Format.ts:84](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L84) - -*** - -### content\_length? - -> `optional` **content\_length**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L44) - -*** - -### distinct\_params? - -> `optional` **distinct\_params**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L67) - -*** - -### drm\_families? - -> `optional` **drm\_families**: `string`[] - -#### Defined in - -[src/parser/classes/misc/Format.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L47) - -*** - -### drm\_track\_type? - -> `optional` **drm\_track\_type**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:66](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L66) - -*** - -### fair\_play\_key\_uri? - -> `optional` **fair\_play\_key\_uri**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L55) - -*** - -### fps? - -> `optional` **fps**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:48](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L48) - -*** - -### has\_audio - -> **has\_audio**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:75](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L75) - -*** - -### has\_text - -> **has\_text**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:77](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L77) - -*** - -### has\_video - -> **has\_video**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:76](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L76) - -*** - -### height? - -> `optional` **height**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L41) - -*** - -### high\_replication? - -> `optional` **high\_replication**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:58](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L58) - -*** - -### index\_range? - -> `optional` **index\_range**: `Range` - -#### Defined in - -[src/parser/classes/misc/Format.ts:72](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L72) - -*** - -### init\_range? - -> `optional` **init\_range**: `Range` - -#### Defined in - -[src/parser/classes/misc/Format.ts:71](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L71) - -*** - -### is\_auto\_dubbed? - -> `optional` **is\_auto\_dubbed**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:80](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L80) - -*** - -### is\_descriptive? - -> `optional` **is\_descriptive**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L81) - -*** - -### is\_drc? - -> `optional` **is\_drc**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:65](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L65) - -*** - -### is\_dubbed? - -> `optional` **is\_dubbed**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:79](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L79) - -*** - -### is\_original? - -> `optional` **is\_original**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:83](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L83) - -*** - -### is\_secondary? - -> `optional` **is\_secondary**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:82](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L82) - -*** - -### is\_type\_otf - -> **is\_type\_otf**: `boolean` - -#### Defined in - -[src/parser/classes/misc/Format.ts:70](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L70) - -*** - -### itag - -> **itag**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L38) - -*** - -### language? - -> `optional` **language**: `null` \| `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L78) - -*** - -### last\_modified - -> **last\_modified**: `Date` - -#### Defined in - -[src/parser/classes/misc/Format.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L42) - -*** - -### last\_modified\_ms - -> **last\_modified\_ms**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L43) - -*** - -### loudness\_db? - -> `optional` **loudness\_db**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:63](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L63) - -*** - -### max\_dvr\_duration\_sec? - -> `optional` **max\_dvr\_duration\_sec**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:57](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L57) - -*** - -### mime\_type - -> **mime\_type**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L69) - -*** - -### projection\_type? - -> `optional` **projection\_type**: `ProjectionType` - -#### Defined in - -[src/parser/classes/misc/Format.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L50) - -*** - -### quality? - -> `optional` **quality**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L45) - -*** - -### quality\_label? - -> `optional` **quality\_label**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L49) - -*** - -### signature\_cipher? - -> `optional` **signature\_cipher**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L64) - -*** - -### spatial\_audio\_type? - -> `optional` **spatial\_audio\_type**: `SpatialAudioType` - -#### Defined in - -[src/parser/classes/misc/Format.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L53) - -*** - -### stereo\_layout? - -> `optional` **stereo\_layout**: `StereoLayout` - -#### Defined in - -[src/parser/classes/misc/Format.ts:56](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L56) - -*** - -### target\_duration\_dec? - -> `optional` **target\_duration\_dec**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L54) - -*** - -### track\_absolute\_loudness\_lkfs? - -> `optional` **track\_absolute\_loudness\_lkfs**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L68) - -*** - -### url? - -> `optional` **url**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L39) - -*** - -### width? - -> `optional` **width**: `number` - -#### Defined in - -[src/parser/classes/misc/Format.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L40) - -*** - -### xtags? - -> `optional` **xtags**: `string` - -#### Defined in - -[src/parser/classes/misc/Format.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L46) - -## Methods - -### decipher() - -> **decipher**(`player`?): `Promise`\<`string`\> - -Deciphers the URL using the provided player instance. - -#### Parameters - -• **player?**: [`Player`](../../../classes/Player.md) - -An optional instance of the Player class used to decipher the URL. - -#### Returns - -`Promise`\<`string`\> - -The deciphered URL as a string. If no player is provided, returns the original URL or an empty string. - -#### Defined in - -[src/parser/classes/misc/Format.ts:245](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Format.ts#L245) diff --git a/docs/api/namespaces/Misc/classes/RendererContext.md b/docs/api/namespaces/Misc/classes/RendererContext.md deleted file mode 100644 index 90c6b1b7..00000000 --- a/docs/api/namespaces/Misc/classes/RendererContext.md +++ /dev/null @@ -1,41 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / RendererContext - -# Class: RendererContext - -## Constructors - -### new RendererContext() - -> **new RendererContext**(`data`?): [`RendererContext`](RendererContext.md) - -#### Parameters - -• **data?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RendererContext`](RendererContext.md) - -#### Defined in - -[src/parser/classes/misc/RendererContext.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/RendererContext.ts#L9) - -## Properties - -### accessibility\_context? - -> `optional` **accessibility\_context**: [`AccessibilityContext`](AccessibilityContext.md) - -#### Defined in - -[src/parser/classes/misc/RendererContext.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/RendererContext.ts#L7) - -*** - -### command\_context? - -> `optional` **command\_context**: [`CommandContext`](CommandContext.md) - -#### Defined in - -[src/parser/classes/misc/RendererContext.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/RendererContext.ts#L6) diff --git a/docs/api/namespaces/Misc/classes/SubscriptionButton.md b/docs/api/namespaces/Misc/classes/SubscriptionButton.md deleted file mode 100644 index 29296c4e..00000000 --- a/docs/api/namespaces/Misc/classes/SubscriptionButton.md +++ /dev/null @@ -1,61 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / SubscriptionButton - -# Class: SubscriptionButton - -## Constructors - -### new SubscriptionButton() - -> **new SubscriptionButton**(`data`): [`SubscriptionButton`](SubscriptionButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SubscriptionButton`](SubscriptionButton.md) - -#### Defined in - -[src/parser/classes/misc/SubscriptionButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/SubscriptionButton.ts#L11) - -## Properties - -### subscribed - -> **subscribed**: `boolean` - -#### Defined in - -[src/parser/classes/misc/SubscriptionButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/SubscriptionButton.ts#L8) - -*** - -### subscription\_type? - -> `optional` **subscription\_type**: `"FREE"` \| `"PAID"` \| `"UNAVAILABLE"` - -#### Defined in - -[src/parser/classes/misc/SubscriptionButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/SubscriptionButton.ts#L9) - -*** - -### text - -> **text**: [`Text`](Text.md) - -#### Defined in - -[src/parser/classes/misc/SubscriptionButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/SubscriptionButton.ts#L7) - -*** - -### type - -> `static` **type**: `string` = `'SubscriptionButton'` - -#### Defined in - -[src/parser/classes/misc/SubscriptionButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/SubscriptionButton.ts#L5) diff --git a/docs/api/namespaces/Misc/classes/Text.md b/docs/api/namespaces/Misc/classes/Text.md deleted file mode 100644 index ea58c408..00000000 --- a/docs/api/namespaces/Misc/classes/Text.md +++ /dev/null @@ -1,155 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / Text - -# Class: Text - -Represents text content that may include formatting, emojis, and navigation endpoints. - -## Constructors - -### new Text() - -> **new Text**(`data`): [`Text`](Text.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Text`](Text.md) - -#### Defined in - -[src/parser/classes/misc/Text.ts:60](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L60) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `FormattedStringSupportedAccessibilityDatas` - -Accessibility data associated with this text. - -#### Defined in - -[src/parser/classes/misc/Text.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L53) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -Navigation endpoint associated with this text. - -#### Defined in - -[src/parser/classes/misc/Text.ts:48](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L48) - -*** - -### rtl - -> **rtl**: `boolean` - -Indicates if the text is right-to-left. - -#### Defined in - -[src/parser/classes/misc/Text.ts:58](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L58) - -*** - -### runs? - -> `optional` **runs**: ([`TextRun`](TextRun.md) \| [`EmojiRun`](EmojiRun.md))[] - -Individual text segments with their formatting. - -#### Defined in - -[src/parser/classes/misc/Text.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L43) - -*** - -### text? - -> `optional` **text**: `string` - -The plain text content. - -#### Defined in - -[src/parser/classes/misc/Text.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L38) - -## Methods - -### isEmpty() - -> **isEmpty**(): `boolean` - -Checks if the text is empty. - -#### Returns - -`boolean` - -Whether the text is empty. - -#### Defined in - -[src/parser/classes/misc/Text.ts:262](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L262) - -*** - -### toHTML() - -> **toHTML**(): `undefined` \| `string` - -Converts the text to HTML. - -#### Returns - -`undefined` \| `string` - -The HTML. - -#### Defined in - -[src/parser/classes/misc/Text.ts:254](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L254) - -*** - -### toString() - -> **toString**(): `string` - -Converts the text to a string. - -#### Returns - -`string` - -The text. - -#### Defined in - -[src/parser/classes/misc/Text.ts:270](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L270) - -*** - -### fromAttributed() - -> `static` **fromAttributed**(`data`): [`Text`](Text.md) - -#### Parameters - -• **data**: `AttributedText` - -#### Returns - -[`Text`](Text.md) - -#### Defined in - -[src/parser/classes/misc/Text.ts:103](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Text.ts#L103) diff --git a/docs/api/namespaces/Misc/classes/TextRun.md b/docs/api/namespaces/Misc/classes/TextRun.md deleted file mode 100644 index eb6966b9..00000000 --- a/docs/api/namespaces/Misc/classes/TextRun.md +++ /dev/null @@ -1,195 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / TextRun - -# Class: TextRun - -## Implements - -- `Run` - -## Constructors - -### new TextRun() - -> **new TextRun**(`data`): [`TextRun`](TextRun.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TextRun`](TextRun.md) - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L32) - -## Properties - -### attachment - -> **attachment**: `any` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L30) - -*** - -### bold - -> **bold**: `boolean` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L9) - -*** - -### bracket - -> **bracket**: `boolean` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L10) - -*** - -### dark\_mode\_text\_color? - -> `optional` **dark\_mode\_text\_color**: `number` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L11) - -*** - -### deemphasize - -> **deemphasize**: `boolean` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L12) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L8) - -*** - -### error\_underline - -> **error\_underline**: `boolean` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L15) - -*** - -### font\_face? - -> `optional` **font\_face**: `"FONT_FACE_UNKNOWN"` \| `"FONT_FACE_YT_SANS_MEDIUM"` \| `"FONT_FACE_ROBOTO_MEDIUM"` \| `"FONT_FACE_YOUTUBE_SANS_LIGHT"` \| `"FONT_FACE_YOUTUBE_SANS_REGULAR"` \| `"FONT_FACE_YOUTUBE_SANS_MEDIUM"` \| `"FONT_FACE_YOUTUBE_SANS_SEMIBOLD"` \| `"FONT_FACE_YOUTUBE_SANS_BOLD"` \| `"FONT_FACE_YOUTUBE_SANS_EXTRABOLD"` \| `"FONT_FACE_YOUTUBE_SANS_BLACK"` \| `"FONT_FACE_YT_SANS_BOLD"` \| `"FONT_FACE_ROBOTO_REGULAR"` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L17) - -*** - -### italics - -> **italics**: `boolean` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L13) - -*** - -### strikethrough - -> **strikethrough**: `boolean` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L14) - -*** - -### text - -> **text**: `string` - -#### Implementation of - -`Run.text` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L6) - -*** - -### text\_color? - -> `optional` **text\_color**: `number` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L7) - -*** - -### underline - -> **underline**: `boolean` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L16) - -## Methods - -### toHTML() - -> **toHTML**(): `string` - -#### Returns - -`string` - -#### Implementation of - -`Run.toHTML` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:65](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L65) - -*** - -### toString() - -> **toString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -`Run.toString` - -#### Defined in - -[src/parser/classes/misc/TextRun.ts:61](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/TextRun.ts#L61) diff --git a/docs/api/namespaces/Misc/classes/Thumbnail.md b/docs/api/namespaces/Misc/classes/Thumbnail.md deleted file mode 100644 index 37926179..00000000 --- a/docs/api/namespaces/Misc/classes/Thumbnail.md +++ /dev/null @@ -1,71 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / Thumbnail - -# Class: Thumbnail - -## Constructors - -### new Thumbnail() - -> **new Thumbnail**(`data`): [`Thumbnail`](Thumbnail.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Thumbnail`](Thumbnail.md) - -#### Defined in - -[src/parser/classes/misc/Thumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Thumbnail.ts#L8) - -## Properties - -### height - -> **height**: `number` - -#### Defined in - -[src/parser/classes/misc/Thumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Thumbnail.ts#L6) - -*** - -### url - -> **url**: `string` - -#### Defined in - -[src/parser/classes/misc/Thumbnail.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Thumbnail.ts#L4) - -*** - -### width - -> **width**: `number` - -#### Defined in - -[src/parser/classes/misc/Thumbnail.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Thumbnail.ts#L5) - -## Methods - -### fromResponse() - -> `static` **fromResponse**(`data`): [`Thumbnail`](Thumbnail.md)[] - -Get thumbnails from response object. - -#### Parameters - -• **data**: `any` - -#### Returns - -[`Thumbnail`](Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/misc/Thumbnail.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/Thumbnail.ts#L17) diff --git a/docs/api/namespaces/Misc/classes/VideoDetails.md b/docs/api/namespaces/Misc/classes/VideoDetails.md deleted file mode 100644 index 01cb9d15..00000000 --- a/docs/api/namespaces/Misc/classes/VideoDetails.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [Misc](../README.md) / VideoDetails - -# Class: VideoDetails - -## Constructors - -### new VideoDetails() - -> **new VideoDetails**(`data`): [`VideoDetails`](VideoDetails.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoDetails`](VideoDetails.md) - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L26) - -## Properties - -### allow\_ratings - -> **allow\_ratings**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L13) - -*** - -### author - -> **author**: `string` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L15) - -*** - -### channel\_id - -> **channel\_id**: `string` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L6) - -*** - -### duration - -> **duration**: `number` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L8) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L5) - -*** - -### is\_crawlable - -> **is\_crawlable**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L21) - -*** - -### is\_live - -> **is\_live**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L17) - -*** - -### is\_live\_content - -> **is\_live\_content**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L18) - -*** - -### is\_live\_dvr\_enabled - -> **is\_live\_dvr\_enabled**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L19) - -*** - -### is\_low\_latency\_live\_stream - -> **is\_low\_latency\_live\_stream**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L23) - -*** - -### is\_owner\_viewing - -> **is\_owner\_viewing**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L10) - -*** - -### is\_post\_live\_dvr - -> **is\_post\_live\_dvr**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L22) - -*** - -### is\_private - -> **is\_private**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L16) - -*** - -### is\_upcoming - -> **is\_upcoming**: `boolean` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L20) - -*** - -### keywords - -> **keywords**: `string`[] - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L9) - -*** - -### live\_chunk\_readahead? - -> `optional` **live\_chunk\_readahead**: `number` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L24) - -*** - -### short\_description - -> **short\_description**: `string` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L11) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L12) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L7) - -*** - -### view\_count - -> **view\_count**: `number` - -#### Defined in - -[src/parser/classes/misc/VideoDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/misc/VideoDetails.ts#L14) diff --git a/docs/api/namespaces/Mixins/classes/Feed.md b/docs/api/namespaces/Mixins/classes/Feed.md deleted file mode 100644 index 702f301d..00000000 --- a/docs/api/namespaces/Mixins/classes/Feed.md +++ /dev/null @@ -1,306 +0,0 @@ -[youtubei.js](../../../README.md) / [Mixins](../README.md) / Feed - -# Class: Feed\ - -## Extended by - -- [`FilterableFeed`](FilterableFeed.md) -- [`TabbedFeed`](TabbedFeed.md) -- [`History`](../../YT/classes/History.md) -- [`Library`](../../YT/classes/Library.md) -- [`Playlist`](../../YT/classes/Playlist.md) -- [`Search`](../../YT/classes/Search.md) -- [`ChannelListContinuation`](../../YT/classes/ChannelListContinuation.md) -- [`Channel`](../../YTKids/classes/Channel.md) -- [`HomeFeed`](../../YTKids/classes/HomeFeed.md) -- [`Search`](../../YTKids/classes/Search.md) - -## Type Parameters - -• **T** *extends* [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) = [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -## Constructors - -### new Feed() - -> **new Feed**\<`T`\>(`actions`, `response`, `already_parsed`): [`Feed`](Feed.md)\<`T`\> - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **response**: [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) \| [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`Feed`](Feed.md)\<`T`\> - -#### Defined in - -[src/core/mixins/Feed.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L47) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -Retrieves next batch of contents and returns a new [Feed](Feed.md) object. - -#### Returns - -`Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -#### Defined in - -[src/core/mixins/Feed.ts:219](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L219) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| `T`\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| `T`\> - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/Mixins/classes/FilterableFeed.md b/docs/api/namespaces/Mixins/classes/FilterableFeed.md deleted file mode 100644 index ee06b06f..00000000 --- a/docs/api/namespaces/Mixins/classes/FilterableFeed.md +++ /dev/null @@ -1,423 +0,0 @@ -[youtubei.js](../../../README.md) / [Mixins](../README.md) / FilterableFeed - -# Class: FilterableFeed\ - -## Extends - -- [`Feed`](Feed.md)\<`T`\> - -## Extended by - -- [`HomeFeed`](../../YT/classes/HomeFeed.md) -- [`HashtagFeed`](../../YT/classes/HashtagFeed.md) -- [`FilteredChannelList`](../../YT/classes/FilteredChannelList.md) - -## Type Parameters - -• **T** *extends* [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -## Constructors - -### new FilterableFeed() - -> **new FilterableFeed**\<`T`\>(`actions`, `data`, `already_parsed`): [`FilterableFeed`](FilterableFeed.md)\<`T`\> - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| `T` - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`FilterableFeed`](FilterableFeed.md)\<`T`\> - -#### Overrides - -[`Feed`](Feed.md).[`constructor`](Feed.md#constructors) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L13) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](Feed.md).[`actions`](Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`channels`](Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### filter\_chips - -> `get` **filter\_chips**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -Returns the filter chips. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L20) - -*** - -### filters - -> `get` **filters**(): `string`[] - -Returns available filters. - -#### Returns - -`string`[] - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L38) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](Feed.md).[`has_continuation`](Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](Feed.md).[`memo`](Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](Feed.md).[`page`](Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](Feed.md).[`page_contents`](Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`playlists`](Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`posts`](Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](Feed.md).[`secondary_contents`](Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`shelves`](Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`videos`](Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -Retrieves next batch of contents and returns a new [Feed](Feed.md) object. - -#### Returns - -`Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -#### Inherited from - -[`Feed`](Feed.md).[`getContinuation`](Feed.md#getcontinuation) - -#### Defined in - -[src/core/mixins/Feed.ts:219](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L219) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| `T`\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| `T`\> - -#### Inherited from - -[`Feed`](Feed.md).[`getContinuationData`](Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getFilteredFeed() - -> **getFilteredFeed**(`filter`): `Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -Applies given filter and returns a new [Feed](Feed.md) object. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Returns - -`Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L45) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](Feed.md).[`getShelf`](Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`getPlaylistsFromMemo`](Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`getVideosFromMemo`](Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/Mixins/classes/MediaInfo.md b/docs/api/namespaces/Mixins/classes/MediaInfo.md deleted file mode 100644 index 4772f35a..00000000 --- a/docs/api/namespaces/Mixins/classes/MediaInfo.md +++ /dev/null @@ -1,456 +0,0 @@ -[youtubei.js](../../../README.md) / [Mixins](../README.md) / MediaInfo - -# Class: MediaInfo - -## Extended by - -- [`VideoInfo`](../../YT/classes/VideoInfo.md) -- [`TrackInfo`](../../YTMusic/classes/TrackInfo.md) -- [`VideoInfo`](../../YTKids/classes/VideoInfo.md) -- [`ShortFormVideoInfo`](../../YTShorts/classes/ShortFormVideoInfo.md) - -## Constructors - -### new MediaInfo() - -> **new MediaInfo**(`data`, `actions`, `cpn`): [`MediaInfo`](MediaInfo.md) - -#### Parameters - -• **data**: [[`ApiResponse`](../../../interfaces/ApiResponse.md), `ApiResponse?`] - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **cpn**: `string` - -#### Returns - -[`MediaInfo`](MediaInfo.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L49) - -## Properties - -### annotations? - -> `optional` **annotations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)\> - -#### Defined in - -[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L40) - -*** - -### basic\_info - -> **basic\_info**: `object` - -#### allow\_ratings? - -> `optional` **allow\_ratings**: `boolean` - -#### author? - -> `optional` **author**: `string` - -#### category - -> **category**: `null` \| `string` - -#### channel - -> **channel**: `null` \| `object` - -#### channel\_id? - -> `optional` **channel\_id**: `string` - -#### duration? - -> `optional` **duration**: `number` - -#### embed - -> **embed**: `undefined` \| `null` \| `object` - -#### end\_timestamp - -> **end\_timestamp**: `null` \| `Date` - -#### has\_ypc\_metadata - -> **has\_ypc\_metadata**: `null` \| `boolean` - -#### id? - -> `optional` **id**: `string` - -#### is\_crawlable? - -> `optional` **is\_crawlable**: `boolean` - -#### is\_disliked - -> **is\_disliked**: `undefined` \| `boolean` - -#### is\_family\_safe - -> **is\_family\_safe**: `undefined` \| `boolean` = `info.microformat.is_family_safe` - -#### is\_liked - -> **is\_liked**: `undefined` \| `boolean` - -#### is\_live? - -> `optional` **is\_live**: `boolean` - -#### is\_live\_content? - -> `optional` **is\_live\_content**: `boolean` - -#### is\_live\_dvr\_enabled? - -> `optional` **is\_live\_dvr\_enabled**: `boolean` - -#### is\_low\_latency\_live\_stream? - -> `optional` **is\_low\_latency\_live\_stream**: `boolean` - -#### is\_owner\_viewing? - -> `optional` **is\_owner\_viewing**: `boolean` - -#### is\_post\_live\_dvr? - -> `optional` **is\_post\_live\_dvr**: `boolean` - -#### is\_private? - -> `optional` **is\_private**: `boolean` - -#### is\_unlisted - -> **is\_unlisted**: `undefined` \| `boolean` = `info.microformat.is_unlisted` - -#### is\_upcoming? - -> `optional` **is\_upcoming**: `boolean` - -#### keywords? - -> `optional` **keywords**: `string`[] - -#### like\_count - -> **like\_count**: `undefined` \| `number` - -#### live\_chunk\_readahead? - -> `optional` **live\_chunk\_readahead**: `number` - -#### short\_description? - -> `optional` **short\_description**: `string` - -#### start\_timestamp - -> **start\_timestamp**: `null` \| `Date` - -#### tags - -> **tags**: `null` \| `string`[] - -#### thumbnail? - -> `optional` **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### title? - -> `optional` **title**: `string` - -#### url\_canonical - -> **url\_canonical**: `null` \| `string` - -#### view\_count - -> **view\_count**: `undefined` \| `number` - -#### Defined in - -[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L39) - -*** - -### captions? - -> `optional` **captions**: [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L43) - -*** - -### cards? - -> `optional` **cards**: [`CardCollection`](../../YTNodes/classes/CardCollection.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L44) - -*** - -### endscreen? - -> `optional` **endscreen**: [`Endscreen`](../../YTNodes/classes/Endscreen.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L42) - -*** - -### playability\_status? - -> `optional` **playability\_status**: [`IPlayabilityStatus`](../../APIResponseTypes/interfaces/IPlayabilityStatus.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L46) - -*** - -### player\_config? - -> `optional` **player\_config**: [`IPlayerConfig`](../../APIResponseTypes/interfaces/IPlayerConfig.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L47) - -*** - -### storyboards? - -> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L41) - -*** - -### streaming\_data? - -> `optional` **streaming\_data**: [`IStreamingData`](../../APIResponseTypes/interfaces/IStreamingData.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L45) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:247](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L247) - -*** - -### cpn - -> `get` **cpn**(): `string` - -Content Playback Nonce. - -#### Returns - -`string` - -#### Defined in - -[src/core/mixins/MediaInfo.ts:254](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L254) - -*** - -### page - -> `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] - -Parsed InnerTube response. - -#### Returns - -[[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] - -#### Defined in - -[src/core/mixins/MediaInfo.ts:261](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L261) - -## Methods - -### addToWatchHistory() - -> **addToWatchHistory**(`client_name`?, `client_version`?, `replacement`?): `Promise`\<`Response`\> - -#### Parameters - -• **client\_name?**: `string` - -• **client\_version?**: `string` - -• **replacement?**: `string` = `'https://www.'` - -#### Returns - -`Promise`\<`Response`\> - -#### Defined in - -[src/core/mixins/MediaInfo.ts:208](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L208) - -*** - -### chooseFormat() - -> **chooseFormat**(`options`): [`Format`](../../Misc/classes/Format.md) - -Selects the format that best matches the given options. - -#### Parameters - -• **options**: [`FormatOptions`](../../Types/interfaces/FormatOptions.md) - -Options - -#### Returns - -[`Format`](../../Misc/classes/Format.md) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:161](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L161) - -*** - -### download() - -> **download**(`options`): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -Downloads the video. - -#### Parameters - -• **options**: [`DownloadOptions`](../../Types/interfaces/DownloadOptions.md) = `{}` - -Download options. - -#### Returns - -`Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -#### Defined in - -[src/core/mixins/MediaInfo.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L169) - -*** - -### getStreamingInfo() - -> **getStreamingInfo**(`url_transformer`?, `format_filter`?): `Promise`\<`StreamingInfo`\> - -Get a cleaned up representation of the adaptive_formats - -#### Parameters - -• **url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) - -• **format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) - -#### Returns - -`Promise`\<`StreamingInfo`\> - -#### Defined in - -[src/core/mixins/MediaInfo.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L144) - -*** - -### getTranscript() - -> **getTranscript**(): `Promise`\<[`TranscriptInfo`](../../YT/classes/TranscriptInfo.md)\> - -Retrieves the video's transcript. - -#### Returns - -`Promise`\<[`TranscriptInfo`](../../YT/classes/TranscriptInfo.md)\> - -#### Defined in - -[src/core/mixins/MediaInfo.ts:182](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L182) - -*** - -### toDash() - -> **toDash**(`options`): `Promise`\<`string`\> - -Generates a DASH manifest from the streaming data. - -#### Parameters - -• **options** = `{}` - -• **options.format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) - -• **options.manifest\_options?**: `DashOptions` - -• **options.url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) - -#### Returns - -`Promise`\<`string`\> - -DASH manifest - -#### Defined in - -[src/core/mixins/MediaInfo.ts:104](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L104) - -*** - -### updateWatchTime() - -> **updateWatchTime**(`startTime`, `client_name`, `client_version`, `replacement`): `Promise`\<`Response`\> - -#### Parameters - -• **startTime**: `number` - -• **client\_name**: `string` = `Constants.CLIENTS.WEB.NAME` - -• **client\_version**: `string` = `Constants.CLIENTS.WEB.VERSION` - -• **replacement**: `string` = `'https://www.'` - -#### Returns - -`Promise`\<`Response`\> - -#### Defined in - -[src/core/mixins/MediaInfo.ts:227](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L227) diff --git a/docs/api/namespaces/Mixins/classes/TabbedFeed.md b/docs/api/namespaces/Mixins/classes/TabbedFeed.md deleted file mode 100644 index e9992bc3..00000000 --- a/docs/api/namespaces/Mixins/classes/TabbedFeed.md +++ /dev/null @@ -1,451 +0,0 @@ -[youtubei.js](../../../README.md) / [Mixins](../README.md) / TabbedFeed - -# Class: TabbedFeed\ - -## Extends - -- [`Feed`](Feed.md)\<`T`\> - -## Extended by - -- [`Channel`](../../YT/classes/Channel.md) - -## Type Parameters - -• **T** *extends* [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -## Constructors - -### new TabbedFeed() - -> **new TabbedFeed**\<`T`\>(`actions`, `data`, `already_parsed`): [`TabbedFeed`](TabbedFeed.md)\<`T`\> - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) \| [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`TabbedFeed`](TabbedFeed.md)\<`T`\> - -#### Overrides - -[`Feed`](Feed.md).[`constructor`](Feed.md#constructors) - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L13) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](Feed.md).[`actions`](Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`channels`](Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](Feed.md).[`has_continuation`](Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](Feed.md).[`memo`](Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](Feed.md).[`page`](Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](Feed.md).[`page_contents`](Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`playlists`](Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`posts`](Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](Feed.md).[`secondary_contents`](Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`shelves`](Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### tabs - -> `get` **tabs**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L19) - -*** - -### title - -> `get` **title**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L55) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`videos`](Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -Retrieves next batch of contents and returns a new [Feed](Feed.md) object. - -#### Returns - -`Promise`\<[`Feed`](Feed.md)\<`T`\>\> - -#### Inherited from - -[`Feed`](Feed.md).[`getContinuation`](Feed.md#getcontinuation) - -#### Defined in - -[src/core/mixins/Feed.ts:219](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L219) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| `T`\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| `T`\> - -#### Inherited from - -[`Feed`](Feed.md).[`getContinuationData`](Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](Feed.md).[`getShelf`](Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getTabByName() - -> **getTabByName**(`title`): `Promise`\<[`TabbedFeed`](TabbedFeed.md)\<`T`\>\> - -#### Parameters - -• **title**: `string` - -#### Returns - -`Promise`\<[`TabbedFeed`](TabbedFeed.md)\<`T`\>\> - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L23) - -*** - -### getTabByURL() - -> **getTabByURL**(`url`): `Promise`\<[`TabbedFeed`](TabbedFeed.md)\<`T`\>\> - -#### Parameters - -• **url**: `string` - -#### Returns - -`Promise`\<[`TabbedFeed`](TabbedFeed.md)\<`T`\>\> - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L37) - -*** - -### hasTabWithURL() - -> **hasTabWithURL**(`url`): `boolean` - -#### Parameters - -• **url**: `string` - -#### Returns - -`boolean` - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L51) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`getPlaylistsFromMemo`](Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](Feed.md).[`getVideosFromMemo`](Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/Parser/functions/addRuntimeParser.md b/docs/api/namespaces/Parser/functions/addRuntimeParser.md deleted file mode 100644 index 6b1b96db..00000000 --- a/docs/api/namespaces/Parser/functions/addRuntimeParser.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / addRuntimeParser - -# Function: addRuntimeParser() - -> **addRuntimeParser**(`classname`, `ParserConstructor`): `void` - -## Parameters - -• **classname**: `string` - -• **ParserConstructor**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -## Returns - -`void` - -## Defined in - -[src/parser/parser.ts:218](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L218) diff --git a/docs/api/namespaces/Parser/functions/applyCommentsMutations.md b/docs/api/namespaces/Parser/functions/applyCommentsMutations.md deleted file mode 100644 index c7781244..00000000 --- a/docs/api/namespaces/Parser/functions/applyCommentsMutations.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / applyCommentsMutations - -# Function: applyCommentsMutations() - -> **applyCommentsMutations**(`memo`, `mutations`): `void` - -## Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -• **mutations**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -## Returns - -`void` - -## Defined in - -[src/parser/parser.ts:825](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L825) diff --git a/docs/api/namespaces/Parser/functions/applyMutations.md b/docs/api/namespaces/Parser/functions/applyMutations.md deleted file mode 100644 index 42c5a35e..00000000 --- a/docs/api/namespaces/Parser/functions/applyMutations.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / applyMutations - -# Function: applyMutations() - -> **applyMutations**(`memo`, `mutations`): `void` - -## Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -• **mutations**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -## Returns - -`void` - -## Defined in - -[src/parser/parser.ts:771](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L771) diff --git a/docs/api/namespaces/Parser/functions/getDynamicParsers.md b/docs/api/namespaces/Parser/functions/getDynamicParsers.md deleted file mode 100644 index ad48ac1d..00000000 --- a/docs/api/namespaces/Parser/functions/getDynamicParsers.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / getDynamicParsers - -# Function: getDynamicParsers() - -> **getDynamicParsers**(): `object` - -## Returns - -`object` - -## Defined in - -[src/parser/parser.ts:223](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L223) diff --git a/docs/api/namespaces/Parser/functions/hasParser.md b/docs/api/namespaces/Parser/functions/hasParser.md deleted file mode 100644 index e15db35e..00000000 --- a/docs/api/namespaces/Parser/functions/hasParser.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / hasParser - -# Function: hasParser() - -> **hasParser**(`classname`): `boolean` - -## Parameters - -• **classname**: `string` - -## Returns - -`boolean` - -## Defined in - -[src/parser/parser.ts:214](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L214) diff --git a/docs/api/namespaces/Parser/functions/parse.md b/docs/api/namespaces/Parser/functions/parse.md deleted file mode 100644 index b2217d76..00000000 --- a/docs/api/namespaces/Parser/functions/parse.md +++ /dev/null @@ -1,87 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parse - -# Function: parse() - -## parse(data, requireArray, validTypes) - -> **parse**\<`T`, `K`\>(`data`, `requireArray`, `validTypes`?): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> \| `null` - -Parses an item or an array of items. - -### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -### Parameters - -• **data**: [`RawData`](../../APIResponseTypes/type-aliases/RawData.md) - -The data to parse. - -• **requireArray**: `true` - -Whether the data should be parsed as an array. - -• **validTypes?**: `K` - -YTNode types that are allowed to be parsed. - -### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> \| `null` - -### Defined in - -[src/parser/parser.ts:628](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L628) - -## parse(data, requireArray, validTypes) - -> **parse**\<`T`, `K`\>(`data`, `requireArray`, `validTypes`?): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\>\> \| `null` - -### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\> - -### Parameters - -• **data**: [`RawData`](../../APIResponseTypes/type-aliases/RawData.md) - -• **requireArray**: `true` - -• **validTypes?**: `K` - -### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\>\> \| `null` - -### Defined in - -[src/parser/parser.ts:629](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L629) - -## parse(data, requireArray, validTypes) - -> **parse**\<`T`\>(`data`?, `requireArray`?, `validTypes`?): [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<`T`\> - -### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) = [`YTNode`](../../Helpers/classes/YTNode.md) - -### Parameters - -• **data?**: [`RawData`](../../APIResponseTypes/type-aliases/RawData.md) - -• **requireArray?**: `false` - -• **validTypes?**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\> \| [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -### Returns - -[`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<`T`\> - -### Defined in - -[src/parser/parser.ts:630](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L630) diff --git a/docs/api/namespaces/Parser/functions/parseArray.md b/docs/api/namespaces/Parser/functions/parseArray.md deleted file mode 100644 index 18336344..00000000 --- a/docs/api/namespaces/Parser/functions/parseArray.md +++ /dev/null @@ -1,71 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseArray - -# Function: parseArray() - -## parseArray(data, validTypes) - -> **parseArray**\<`T`, `K`\>(`data`, `validTypes`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> - -Parses an array of items. - -### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -### Parameters - -• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -The data to parse. - -• **validTypes**: `K` - -YTNode types that are allowed to be parsed. - -### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> - -### Defined in - -[src/parser/parser.ts:601](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L601) - -## parseArray(data, validType) - -> **parseArray**\<`T`\>(`data`, `validType`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`T`\> - -### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) = [`YTNode`](../../Helpers/classes/YTNode.md) - -### Parameters - -• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -• **validType**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\> - -### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`T`\> - -### Defined in - -[src/parser/parser.ts:602](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L602) - -## parseArray(data) - -> **parseArray**(`data`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -### Parameters - -• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -### Defined in - -[src/parser/parser.ts:603](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L603) diff --git a/docs/api/namespaces/Parser/functions/parseC.md b/docs/api/namespaces/Parser/functions/parseC.md deleted file mode 100644 index bcc53390..00000000 --- a/docs/api/namespaces/Parser/functions/parseC.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseC - -# Function: parseC() - -> **parseC**(`data`): `null` \| [`Continuation`](../../../classes/Continuation.md) - -## Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -## Returns - -`null` \| [`Continuation`](../../../classes/Continuation.md) - -## Defined in - -[src/parser/parser.ts:715](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L715) diff --git a/docs/api/namespaces/Parser/functions/parseCommands.md b/docs/api/namespaces/Parser/functions/parseCommands.md deleted file mode 100644 index 26f92073..00000000 --- a/docs/api/namespaces/Parser/functions/parseCommands.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseCommands - -# Function: parseCommands() - -> **parseCommands**(`commands`?): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -Parses an array of InnerTube command nodes. - -## Parameters - -• **commands?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -Array of raw command nodes to parse - -## Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -An observed array of parsed YTNodes - -## Defined in - -[src/parser/parser.ts:699](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L699) diff --git a/docs/api/namespaces/Parser/functions/parseFormats.md b/docs/api/namespaces/Parser/functions/parseFormats.md deleted file mode 100644 index 97c20bf3..00000000 --- a/docs/api/namespaces/Parser/functions/parseFormats.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseFormats - -# Function: parseFormats() - -> **parseFormats**(`formats`, `this_response_nsig_cache`): [`Format`](../../Misc/classes/Format.md)[] - -## Parameters - -• **formats**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -• **this\_response\_nsig\_cache**: `Map`\<`string`, `string`\> - -## Returns - -[`Format`](../../Misc/classes/Format.md)[] - -## Defined in - -[src/parser/parser.ts:767](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L767) diff --git a/docs/api/namespaces/Parser/functions/parseItem.md b/docs/api/namespaces/Parser/functions/parseItem.md deleted file mode 100644 index 6a386c77..00000000 --- a/docs/api/namespaces/Parser/functions/parseItem.md +++ /dev/null @@ -1,71 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseItem - -# Function: parseItem() - -## parseItem(data, validTypes) - -> **parseItem**\<`T`, `K`\>(`data`, `validTypes`): `InstanceType`\<`K`\[`number`\]\> \| `null` - -Parses an item. - -### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -### Parameters - -• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -The data to parse. - -• **validTypes**: `K` - -YTNode types that are allowed to be parsed. - -### Returns - -`InstanceType`\<`K`\[`number`\]\> \| `null` - -### Defined in - -[src/parser/parser.ts:535](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L535) - -## parseItem(data, validTypes) - -> **parseItem**\<`T`\>(`data`, `validTypes`): `T` \| `null` - -### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -### Parameters - -• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -• **validTypes**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\> - -### Returns - -`T` \| `null` - -### Defined in - -[src/parser/parser.ts:536](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L536) - -## parseItem(data) - -> **parseItem**(`data`?): [`YTNode`](../../Helpers/classes/YTNode.md) - -### Parameters - -• **data?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -### Returns - -[`YTNode`](../../Helpers/classes/YTNode.md) - -### Defined in - -[src/parser/parser.ts:537](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L537) diff --git a/docs/api/namespaces/Parser/functions/parseLC.md b/docs/api/namespaces/Parser/functions/parseLC.md deleted file mode 100644 index 1539d582..00000000 --- a/docs/api/namespaces/Parser/functions/parseLC.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseLC - -# Function: parseLC() - -> **parseLC**(`data`): `null` \| [`ItemSectionContinuation`](../../../classes/ItemSectionContinuation.md) \| [`SectionListContinuation`](../../../classes/SectionListContinuation.md) \| [`LiveChatContinuation`](../../../classes/LiveChatContinuation.md) \| [`MusicPlaylistShelfContinuation`](../../../classes/MusicPlaylistShelfContinuation.md) \| [`MusicShelfContinuation`](../../../classes/MusicShelfContinuation.md) \| [`GridContinuation`](../../../classes/GridContinuation.md) \| [`PlaylistPanelContinuation`](../../../classes/PlaylistPanelContinuation.md) \| [`ContinuationCommand`](../../../classes/ContinuationCommand.md) - -## Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -## Returns - -`null` \| [`ItemSectionContinuation`](../../../classes/ItemSectionContinuation.md) \| [`SectionListContinuation`](../../../classes/SectionListContinuation.md) \| [`LiveChatContinuation`](../../../classes/LiveChatContinuation.md) \| [`MusicPlaylistShelfContinuation`](../../../classes/MusicPlaylistShelfContinuation.md) \| [`MusicShelfContinuation`](../../../classes/MusicShelfContinuation.md) \| [`GridContinuation`](../../../classes/GridContinuation.md) \| [`PlaylistPanelContinuation`](../../../classes/PlaylistPanelContinuation.md) \| [`ContinuationCommand`](../../../classes/ContinuationCommand.md) - -## Defined in - -[src/parser/parser.ts:721](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L721) diff --git a/docs/api/namespaces/Parser/functions/parseRR.md b/docs/api/namespaces/Parser/functions/parseRR.md deleted file mode 100644 index 8243fc06..00000000 --- a/docs/api/namespaces/Parser/functions/parseRR.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseRR - -# Function: parseRR() - -> **parseRR**(`actions`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md)\> - -## Parameters - -• **actions**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[] - -## Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md)\> - -## Defined in - -[src/parser/parser.ts:742](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L742) diff --git a/docs/api/namespaces/Parser/functions/parseResponse.md b/docs/api/namespaces/Parser/functions/parseResponse.md deleted file mode 100644 index b91fba47..00000000 --- a/docs/api/namespaces/Parser/functions/parseResponse.md +++ /dev/null @@ -1,25 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / parseResponse - -# Function: parseResponse() - -> **parseResponse**\<`T`\>(`data`): `T` - -Parses a given InnerTube response. - -## Type Parameters - -• **T** *extends* [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) = [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -## Parameters - -• **data**: [`IRawResponse`](../../APIResponseTypes/interfaces/IRawResponse.md) - -Raw data. - -## Returns - -`T` - -## Defined in - -[src/parser/parser.ts:231](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L231) diff --git a/docs/api/namespaces/Parser/functions/sanitizeClassName.md b/docs/api/namespaces/Parser/functions/sanitizeClassName.md deleted file mode 100644 index 71865323..00000000 --- a/docs/api/namespaces/Parser/functions/sanitizeClassName.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / sanitizeClassName - -# Function: sanitizeClassName() - -> **sanitizeClassName**(`input`): `string` - -## Parameters - -• **input**: `string` - -## Returns - -`string` - -## Defined in - -[src/parser/parser.ts:196](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L196) diff --git a/docs/api/namespaces/Parser/functions/setParserErrorHandler.md b/docs/api/namespaces/Parser/functions/setParserErrorHandler.md deleted file mode 100644 index 4c37a874..00000000 --- a/docs/api/namespaces/Parser/functions/setParserErrorHandler.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / setParserErrorHandler - -# Function: setParserErrorHandler() - -> **setParserErrorHandler**(`handler`): `void` - -## Parameters - -• **handler**: [`ParserErrorHandler`](../type-aliases/ParserErrorHandler.md) - -## Returns - -`void` - -## Defined in - -[src/parser/parser.ts:163](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L163) diff --git a/docs/api/namespaces/Parser/functions/shouldIgnore.md b/docs/api/namespaces/Parser/functions/shouldIgnore.md deleted file mode 100644 index a0dee7dd..00000000 --- a/docs/api/namespaces/Parser/functions/shouldIgnore.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / shouldIgnore - -# Function: shouldIgnore() - -> **shouldIgnore**(`classname`): `boolean` - -## Parameters - -• **classname**: `string` - -## Returns - -`boolean` - -## Defined in - -[src/parser/parser.ts:192](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L192) diff --git a/docs/api/namespaces/Parser/type-aliases/ParserError.md b/docs/api/namespaces/Parser/type-aliases/ParserError.md deleted file mode 100644 index a4cc9f74..00000000 --- a/docs/api/namespaces/Parser/type-aliases/ParserError.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / ParserError - -# Type Alias: ParserError - -> **ParserError**: `object` & `object` \| `object` \| `object` \| `object` \| `object` \| `object` - -## Type declaration - -### classname - -> **classname**: `string` - -## Defined in - -[src/parser/parser.ts:48](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L48) diff --git a/docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md b/docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md deleted file mode 100644 index baf7f7c5..00000000 --- a/docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Parser](../README.md) / ParserErrorHandler - -# Type Alias: ParserErrorHandler() - -> **ParserErrorHandler**: (`error`) => `void` - -## Parameters - -• **error**: [`ParserError`](ParserError.md) - -## Returns - -`void` - -## Defined in - -[src/parser/parser.ts:75](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L75) diff --git a/docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md b/docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md deleted file mode 100644 index 45ebf76a..00000000 --- a/docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / decodeVisitorData - -# Function: decodeVisitorData() - -> **decodeVisitorData**(`visitor_data`): `VisitorData` - -## Parameters - -• **visitor\_data**: `string` - -## Returns - -`VisitorData` - -## Defined in - -[src/utils/ProtoUtils.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/ProtoUtils.ts#L16) diff --git a/docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md b/docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md deleted file mode 100644 index 4a12370c..00000000 --- a/docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / encodeCommentActionParams - -# Function: encodeCommentActionParams() - -> **encodeCommentActionParams**(`type`, `args`): `string` - -## Parameters - -• **type**: `number` - -• **args**: [`CommentActionParamsArgs`](../type-aliases/CommentActionParamsArgs.md) = `{}` - -## Returns - -`string` - -## Defined in - -[src/utils/ProtoUtils.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/ProtoUtils.ts#L20) diff --git a/docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md b/docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md deleted file mode 100644 index c177c828..00000000 --- a/docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / encodeNextParams - -# Function: encodeNextParams() - -> **encodeNextParams**(`video_ids`, `playlist_title`?): `string` - -## Parameters - -• **video\_ids**: `string`[] - -• **playlist\_title?**: `string` - -## Returns - -`string` - -## Defined in - -[src/utils/ProtoUtils.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/ProtoUtils.ts#L51) diff --git a/docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md b/docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md deleted file mode 100644 index 3c76f28c..00000000 --- a/docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / encodeVisitorData - -# Function: encodeVisitorData() - -> **encodeVisitorData**(`id`, `timestamp`): `string` - -## Parameters - -• **id**: `string` - -• **timestamp**: `number` - -## Returns - -`string` - -## Defined in - -[src/utils/ProtoUtils.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/ProtoUtils.ts#L11) diff --git a/docs/api/namespaces/ProtoUtils/type-aliases/CommentActionParamsArgs.md b/docs/api/namespaces/ProtoUtils/type-aliases/CommentActionParamsArgs.md deleted file mode 100644 index 06dfd2bb..00000000 --- a/docs/api/namespaces/ProtoUtils/type-aliases/CommentActionParamsArgs.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / CommentActionParamsArgs - -# Type Alias: CommentActionParamsArgs - -> **CommentActionParamsArgs**: `object` - -## Type declaration - -### comment\_id? - -> `optional` **comment\_id**: `string` - -### target\_language? - -> `optional` **target\_language**: `string` - -### text? - -> `optional` **text**: `string` - -### video\_id? - -> `optional` **video\_id**: `string` - -## Defined in - -[src/utils/ProtoUtils.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/ProtoUtils.ts#L4) diff --git a/docs/api/namespaces/Types/classes/JsAnalyzer.md b/docs/api/namespaces/Types/classes/JsAnalyzer.md deleted file mode 100644 index c00c8350..00000000 --- a/docs/api/namespaces/Types/classes/JsAnalyzer.md +++ /dev/null @@ -1,83 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / JsAnalyzer - -# Class: JsAnalyzer - -Performs dependency-aware extraction of variables inside an IIFE. - -## Constructors - -### new JsAnalyzer() - -> **new JsAnalyzer**(`code`, `options`): [`JsAnalyzer`](JsAnalyzer.md) - -Creates a new instance over the provided source. - -#### Parameters - -• **code**: `string` - -JavaScript source to parse and inspect. - -• **options**: [`AnalyzerOptions`](../interfaces/AnalyzerOptions.md) = `{}` - -Optional traversal settings. - -#### Returns - -[`JsAnalyzer`](JsAnalyzer.md) - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:76](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L76) - -## Properties - -### declaredVariables - -> **declaredVariables**: `Map`\<`string`, [`VariableMetadata`](../interfaces/VariableMetadata.md)\> - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L68) - -*** - -### iifeParamName - -> **iifeParamName**: `null` \| `string` = `null` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L69) - -## Methods - -### getExtractedMatches() - -> **getExtractedMatches**(): [`ExtractionState`](../interfaces/ExtractionState.md)[] - -Returns the current set of matched extractions. - -#### Returns - -[`ExtractionState`](../interfaces/ExtractionState.md)[] - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:555](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L555) - -*** - -### getSource() - -> **getSource**(): `string` - -Returns the raw, original source. - -#### Returns - -`string` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:563](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L563) diff --git a/docs/api/namespaces/Types/classes/JsExtractor.md b/docs/api/namespaces/Types/classes/JsExtractor.md deleted file mode 100644 index 6c7a82c3..00000000 --- a/docs/api/namespaces/Types/classes/JsExtractor.md +++ /dev/null @@ -1,48 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / JsExtractor - -# Class: JsExtractor - -Class responsible for extracting and emitting JavaScript code snippets -based on analysis results from a `JsAnalyzer` instance. - -## Constructors - -### new JsExtractor() - -> **new JsExtractor**(`analyzer`): [`JsExtractor`](JsExtractor.md) - -#### Parameters - -• **analyzer**: [`JsAnalyzer`](JsAnalyzer.md) - -#### Returns - -[`JsExtractor`](JsExtractor.md) - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:62](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L62) - -## Methods - -### buildScript() - -> **buildScript**(`config`): [`BuildScriptResult`](../interfaces/BuildScriptResult.md) - -Processes extracted matches from the analyzer, handles dependencies, predeclares -variables as needed, and generates an IIFE-wrapped output string containing the -code snippets and exported variables. - -#### Parameters - -• **config**: [`EmitterOptions`](../interfaces/EmitterOptions.md) - -Configuration options for the emitter. - -#### Returns - -[`BuildScriptResult`](../interfaces/BuildScriptResult.md) - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:320](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L320) diff --git a/docs/api/namespaces/Types/interfaces/AnalyzerOptions.md b/docs/api/namespaces/Types/interfaces/AnalyzerOptions.md deleted file mode 100644 index 967759d2..00000000 --- a/docs/api/namespaces/Types/interfaces/AnalyzerOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / AnalyzerOptions - -# Interface: AnalyzerOptions - -## Properties - -### extractions? - -> `optional` **extractions**: [`ExtractionConfig`](ExtractionConfig.md) \| [`ExtractionConfig`](ExtractionConfig.md)[] - -One or more extraction configurations to look for while traversing. - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L30) diff --git a/docs/api/namespaces/Types/interfaces/BuildScriptResult.md b/docs/api/namespaces/Types/interfaces/BuildScriptResult.md deleted file mode 100644 index b9f154bb..00000000 --- a/docs/api/namespaces/Types/interfaces/BuildScriptResult.md +++ /dev/null @@ -1,39 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / BuildScriptResult - -# Interface: BuildScriptResult - -## Properties - -### exported - -> **exported**: `string`[] - -An array of exported variable names. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L50) - -*** - -### exportedRawValues? - -> `optional` **exportedRawValues**: `Record`\<`string`, `any`\> - -An object mapping exported variable names to their raw values, if `exportRawValues` was enabled. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L54) - -*** - -### output - -> **output**: `string` - -The generated output script as a string. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L46) diff --git a/docs/api/namespaces/Types/interfaces/EmitterOptions.md b/docs/api/namespaces/Types/interfaces/EmitterOptions.md deleted file mode 100644 index eedbcaac..00000000 --- a/docs/api/namespaces/Types/interfaces/EmitterOptions.md +++ /dev/null @@ -1,67 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / EmitterOptions - -# Interface: EmitterOptions - -## Properties - -### disallowSideEffectInitializers? - -> `optional` **disallowSideEffectInitializers**: `boolean` \| [`SideEffectPolicyOptions`](SideEffectPolicyOptions.md) - -When true or configured, replace unsafe initializers (calls, `new`, etc.) -with `undefined` to avoid executing side-effectful code. -Use `{ mode: 'loose' }` to allow a broader set of expressions. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L26) - -*** - -### exportRawValues? - -> `optional` **exportRawValues**: `boolean` - -When true, also export raw values of matched nodes. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L35) - -*** - -### forceVarPredeclaration? - -> `optional` **forceVarPredeclaration**: `boolean` - -When true, emit a single `var` declaration for every variable -encountered, even if it originally had an initializer. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L31) - -*** - -### maxDepth? - -> `optional` **maxDepth**: `number` - -The maximum depth to traverse when emitting dependencies. -If not specified, there is no limit on the depth. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L20) - -*** - -### rawValueOnly? - -> `optional` **rawValueOnly**: `string`[] - -Array of names to skip emitting code/deps for, but still export the raw value. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L39) diff --git a/docs/api/namespaces/Types/interfaces/ExtractionConfig.md b/docs/api/namespaces/Types/interfaces/ExtractionConfig.md deleted file mode 100644 index b9ba37ee..00000000 --- a/docs/api/namespaces/Types/interfaces/ExtractionConfig.md +++ /dev/null @@ -1,61 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ExtractionConfig - -# Interface: ExtractionConfig - -## Properties - -### collectDependencies? - -> `optional` **collectDependencies**: `boolean` - -When `false`, dependency resolution is not enforced and extractions are marked as ready immediately -when `stopWhenReady` is true. - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L14) - -*** - -### friendlyName? - -> `optional` **friendlyName**: `string` - -Name for easier identification of extractions. - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L23) - -*** - -### match() - -> **match**: (`node`) => `boolean` \| `Node` - -Predicate that determines whether the current node should be considered a match. - -#### Parameters - -• **node**: `Node` - -#### Returns - -`boolean` \| `Node` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L9) - -*** - -### stopWhenReady? - -> `optional` **stopWhenReady**: `boolean` - -When `true`, traversal stops once the extraction is matched and all its dependencies (when `collectDependencies=true`) resolve. -Only useful for small functions/vars without too many dependencies. - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L19) diff --git a/docs/api/namespaces/Types/interfaces/ExtractionState.md b/docs/api/namespaces/Types/interfaces/ExtractionState.md deleted file mode 100644 index 4c13c158..00000000 --- a/docs/api/namespaces/Types/interfaces/ExtractionState.md +++ /dev/null @@ -1,73 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ExtractionState - -# Interface: ExtractionState - -## Properties - -### config - -> **config**: [`ExtractionConfig`](ExtractionConfig.md) - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L42) - -*** - -### dependencies - -> **dependencies**: `Set`\<`string`\> - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L45) - -*** - -### dependents - -> **dependents**: `Set`\<`string`\> - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L46) - -*** - -### matchContext? - -> `optional` **matchContext**: `Node` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L47) - -*** - -### metadata? - -> `optional` **metadata**: [`VariableMetadata`](VariableMetadata.md) - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L44) - -*** - -### node? - -> `optional` **node**: `Node` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L43) - -*** - -### ready - -> **ready**: `boolean` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:48](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L48) diff --git a/docs/api/namespaces/Types/interfaces/FormatOptions.md b/docs/api/namespaces/Types/interfaces/FormatOptions.md deleted file mode 100644 index e246cb00..00000000 --- a/docs/api/namespaces/Types/interfaces/FormatOptions.md +++ /dev/null @@ -1,116 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / FormatOptions - -# Interface: FormatOptions - -## Extends - -- [`GetVideoInfoOptions`](GetVideoInfoOptions.md) - -## Extended by - -- [`DownloadOptions`](DownloadOptions.md) - -## Properties - -### client? - -> `optional` **client**: [`InnerTubeClient`](../type-aliases/InnerTubeClient.md) - -InnerTube client. - -#### Inherited from - -[`GetVideoInfoOptions`](GetVideoInfoOptions.md).[`client`](GetVideoInfoOptions.md#client) - -#### Defined in - -[src/types/GetVideoInfoOptions.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/GetVideoInfoOptions.ts#L7) - -*** - -### codec? - -> `optional` **codec**: `string` - -Video or audio codec, e.g. 'avc', 'vp9', 'av01' for video, 'opus', 'mp4a' for audio - -#### Defined in - -[src/types/FormatUtils.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L31) - -*** - -### format? - -> `optional` **format**: `string` - -File format, use 'any' to download any format - -#### Defined in - -[src/types/FormatUtils.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L27) - -*** - -### itag? - -> `optional` **itag**: `number` - -Video or audio itag - -#### Defined in - -[src/types/FormatUtils.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L11) - -*** - -### language? - -> `optional` **language**: `string` - -Language code, defaults to 'original'. - -#### Defined in - -[src/types/FormatUtils.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L23) - -*** - -### po\_token? - -> `optional` **po\_token**: `string` - -Proof of Origin token, bound to the video ID being requested. -If not provided, session bound token will be used. - -#### Inherited from - -[`GetVideoInfoOptions`](GetVideoInfoOptions.md).[`po_token`](GetVideoInfoOptions.md#po_token) - -#### Defined in - -[src/types/GetVideoInfoOptions.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/GetVideoInfoOptions.ts#L12) - -*** - -### quality? - -> `optional` **quality**: `string` - -Video quality; 360p, 720p, 1080p, etc... also accepts 'best' and 'bestefficiency'. - -#### Defined in - -[src/types/FormatUtils.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L15) - -*** - -### type? - -> `optional` **type**: `"video"` \| `"audio"` \| `"video+audio"` - -Download type, can be: video, audio or video+audio - -#### Defined in - -[src/types/FormatUtils.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L19) diff --git a/docs/api/namespaces/Types/interfaces/GetVideoInfoOptions.md b/docs/api/namespaces/Types/interfaces/GetVideoInfoOptions.md deleted file mode 100644 index efc85bd4..00000000 --- a/docs/api/namespaces/Types/interfaces/GetVideoInfoOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / GetVideoInfoOptions - -# Interface: GetVideoInfoOptions - -## Extended by - -- [`FormatOptions`](FormatOptions.md) - -## Properties - -### client? - -> `optional` **client**: [`InnerTubeClient`](../type-aliases/InnerTubeClient.md) - -InnerTube client. - -#### Defined in - -[src/types/GetVideoInfoOptions.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/GetVideoInfoOptions.ts#L7) - -*** - -### po\_token? - -> `optional` **po\_token**: `string` - -Proof of Origin token, bound to the video ID being requested. -If not provided, session bound token will be used. - -#### Defined in - -[src/types/GetVideoInfoOptions.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/GetVideoInfoOptions.ts#L12) diff --git a/docs/api/namespaces/Types/interfaces/ICache.md b/docs/api/namespaces/Types/interfaces/ICache.md deleted file mode 100644 index 42648e88..00000000 --- a/docs/api/namespaces/Types/interfaces/ICache.md +++ /dev/null @@ -1,69 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ICache - -# Interface: ICache - -## Properties - -### cache\_dir - -> **cache\_dir**: `string` - -#### Defined in - -[src/types/Cache.ts:2](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Cache.ts#L2) - -## Methods - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `ArrayBuffer`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`undefined` \| `ArrayBuffer`\> - -#### Defined in - -[src/types/Cache.ts:3](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Cache.ts#L3) - -*** - -### remove() - -> **remove**(`key`): `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/types/Cache.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Cache.ts#L5) - -*** - -### set() - -> **set**(`key`, `value`): `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `ArrayBuffer` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/types/Cache.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Cache.ts#L4) diff --git a/docs/api/namespaces/Types/interfaces/ICacheConstructor.md b/docs/api/namespaces/Types/interfaces/ICacheConstructor.md deleted file mode 100644 index 4b41acff..00000000 --- a/docs/api/namespaces/Types/interfaces/ICacheConstructor.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ICacheConstructor - -# Interface: ICacheConstructor - -## Constructors - -### new ICacheConstructor() - -> **new ICacheConstructor**(`persistent`, `persistent_directory`?): [`ICache`](ICache.md) - -#### Parameters - -• **persistent**: `boolean` - -• **persistent\_directory?**: `string` - -#### Returns - -[`ICache`](ICache.md) - -#### Defined in - -[src/types/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Cache.ts#L9) diff --git a/docs/api/namespaces/Types/interfaces/PlatformShim.md b/docs/api/namespaces/Types/interfaces/PlatformShim.md deleted file mode 100644 index 5138d9c4..00000000 --- a/docs/api/namespaces/Types/interfaces/PlatformShim.md +++ /dev/null @@ -1,343 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / PlatformShim - -# Interface: PlatformShim - -## Properties - -### Cache - -> **Cache**: [`ICacheConstructor`](ICacheConstructor.md) - -#### Defined in - -[src/types/PlatformShim.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L15) - -*** - -### CustomEvent() - -> **CustomEvent**: \<`T`\>(`type`, `eventInitDict`?) => `CustomEvent`\<`T`\> - -#### Parameters - -• **type**: `string` - -• **eventInitDict?**: `CustomEventInit`\<`T`\> - -#### Returns - -`CustomEvent`\<`T`\> - -#### prototype - -> **prototype**: `CustomEvent`\<`any`\> - -#### Defined in - -[src/types/PlatformShim.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L26) - -*** - -### fetch() - -> **fetch**: (`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\> - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch) - -#### Parameters - -• **input**: `URL` \| `RequestInfo` - -• **init?**: `RequestInit` - -#### Returns - -`Promise`\<`Response`\> - -#### Parameters - -• **input**: `string` \| `URL` \| `Request` - -• **init?**: `RequestInit` - -#### Returns - -`Promise`\<`Response`\> - -#### Defined in - -[src/types/PlatformShim.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L19) - -*** - -### File() - -> **File**: (`fileBits`, `fileName`, `options`?) => `File` - -#### Parameters - -• **fileBits**: `BlobPart`[] - -• **fileName**: `string` - -• **options?**: `FilePropertyBag` - -#### Returns - -`File` - -#### prototype - -> **prototype**: `File` - -#### Defined in - -[src/types/PlatformShim.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L24) - -*** - -### FormData() - -> **FormData**: (`form`?, `submitter`?) => `FormData` - -#### Parameters - -• **form?**: `HTMLFormElement` - -• **submitter?**: `null` \| `HTMLElement` - -#### Returns - -`FormData` - -#### prototype - -> **prototype**: `FormData` - -#### Defined in - -[src/types/PlatformShim.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L23) - -*** - -### Headers() - -> **Headers**: (`init`?) => `Headers` - -#### Parameters - -• **init?**: `HeadersInit` - -#### Returns - -`Headers` - -#### prototype - -> **prototype**: `Headers` - -#### Defined in - -[src/types/PlatformShim.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L22) - -*** - -### ReadableStream() - -> **ReadableStream**: (`underlyingSource`, `strategy`?) => `ReadableStream`\<`Uint8Array`\>\<`R`\>(`underlyingSource`, `strategy`?) => `ReadableStream`\<`R`\>\<`R`\>(`underlyingSource`?, `strategy`?) => `ReadableStream`\<`R`\> - -#### Parameters - -• **underlyingSource**: `UnderlyingByteSource` - -• **strategy?** - -• **strategy.highWaterMark?**: `number` - -#### Returns - -`ReadableStream`\<`Uint8Array`\> - -#### Parameters - -• **underlyingSource**: `UnderlyingDefaultSource`\<`R`\> - -• **strategy?**: `QueuingStrategy`\<`R`\> - -#### Returns - -`ReadableStream`\<`R`\> - -#### Parameters - -• **underlyingSource?**: `UnderlyingSource`\<`R`\> - -• **strategy?**: `QueuingStrategy`\<`R`\> - -#### Returns - -`ReadableStream`\<`R`\> - -#### prototype - -> **prototype**: `ReadableStream`\<`any`\> - -#### Defined in - -[src/types/PlatformShim.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L25) - -*** - -### Request() - -> **Request**: (`input`, `init`?) => `Request` - -#### Parameters - -• **input**: `URL` \| `RequestInfo` - -• **init?**: `RequestInit` - -#### Returns - -`Request` - -#### prototype - -> **prototype**: `Request` - -#### Defined in - -[src/types/PlatformShim.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L20) - -*** - -### Response() - -> **Response**: (`body`?, `init`?) => `Response` - -#### Parameters - -• **body?**: `null` \| `BodyInit` - -• **init?**: `ResponseInit` - -#### Returns - -`Response` - -#### prototype - -> **prototype**: `Response` - -#### error() - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/error_static) - -##### Returns - -`Response` - -#### json() - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/json_static) - -##### Parameters - -• **data**: `any` - -• **init?**: `ResponseInit` - -##### Returns - -`Response` - -#### redirect() - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static) - -##### Parameters - -• **url**: `string` \| `URL` - -• **status?**: `number` - -##### Returns - -`Response` - -#### Defined in - -[src/types/PlatformShim.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L21) - -*** - -### runtime - -> **runtime**: [`Runtime`](../type-aliases/Runtime.md) - -#### Defined in - -[src/types/PlatformShim.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L13) - -*** - -### server - -> **server**: `boolean` - -#### Defined in - -[src/types/PlatformShim.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L14) - -## Methods - -### eval() - -> **eval**(`data`, `env`): [`EvalResult`](../type-aliases/EvalResult.md) \| `Promise`\<[`EvalResult`](../type-aliases/EvalResult.md)\> - -#### Parameters - -• **data**: [`BuildScriptResult`](BuildScriptResult.md) - -• **env**: `Record`\<`string`, [`VMPrimative`](../type-aliases/VMPrimative.md)\> - -#### Returns - -[`EvalResult`](../type-aliases/EvalResult.md) \| `Promise`\<[`EvalResult`](../type-aliases/EvalResult.md)\> - -#### Defined in - -[src/types/PlatformShim.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L18) - -*** - -### sha1Hash() - -> **sha1Hash**(`data`): `Promise`\<`string`\> - -#### Parameters - -• **data**: `string` - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/types/PlatformShim.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L16) - -*** - -### uuidv4() - -> **uuidv4**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/types/PlatformShim.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L17) diff --git a/docs/api/namespaces/Types/interfaces/SideEffectPolicyOptions.md b/docs/api/namespaces/Types/interfaces/SideEffectPolicyOptions.md deleted file mode 100644 index 66cfb770..00000000 --- a/docs/api/namespaces/Types/interfaces/SideEffectPolicyOptions.md +++ /dev/null @@ -1,16 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SideEffectPolicyOptions - -# Interface: SideEffectPolicyOptions - -## Properties - -### mode? - -> `optional` **mode**: [`SideEffectMode`](../type-aliases/SideEffectMode.md) - -Determines how strictly side-effect detection should behave. -Use `"loose"` to allow benign computed expressions. - -#### Defined in - -[src/utils/javascript/JsExtractor.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L12) diff --git a/docs/api/namespaces/Types/interfaces/VariableMetadata.md b/docs/api/namespaces/Types/interfaces/VariableMetadata.md deleted file mode 100644 index 5db8c319..00000000 --- a/docs/api/namespaces/Types/interfaces/VariableMetadata.md +++ /dev/null @@ -1,53 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / VariableMetadata - -# Interface: VariableMetadata - -## Properties - -### dependencies - -> **dependencies**: `Set`\<`string`\> - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L36) - -*** - -### dependents - -> **dependents**: `Set`\<`string`\> - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L37) - -*** - -### name - -> **name**: `string` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L34) - -*** - -### node? - -> `optional` **node**: `any` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L35) - -*** - -### predeclared - -> **predeclared**: `boolean` - -#### Defined in - -[src/utils/javascript/JsAnalyzer.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L38) diff --git a/docs/api/namespaces/Types/type-aliases/Duration.md b/docs/api/namespaces/Types/type-aliases/Duration.md deleted file mode 100644 index 41687a1c..00000000 --- a/docs/api/namespaces/Types/type-aliases/Duration.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / Duration - -# Type Alias: Duration - -> **Duration**: `"all"` \| `"short"` \| `"medium"` \| `"long"` - -## Defined in - -[src/types/Misc.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L9) diff --git a/docs/api/namespaces/Types/type-aliases/EngagementType.md b/docs/api/namespaces/Types/type-aliases/EngagementType.md deleted file mode 100644 index 66462df1..00000000 --- a/docs/api/namespaces/Types/type-aliases/EngagementType.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / EngagementType - -# Type Alias: EngagementType - -> **EngagementType**: `"ENGAGEMENT_TYPE_UNBOUND"` \| `"ENGAGEMENT_TYPE_VIDEO_LIKE"` \| `"ENGAGEMENT_TYPE_VIDEO_DISLIKE"` \| `"ENGAGEMENT_TYPE_SUBSCRIBE"` \| `"ENGAGEMENT_TYPE_PLAYBACK"` \| `"ENGAGEMENT_TYPE_YPC_GET_PREMIUM_PAGE"` \| `"ENGAGEMENT_TYPE_YPC_GET_DOWNLOAD_ACTION"` - -## Defined in - -[src/types/Misc.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L5) diff --git a/docs/api/namespaces/Types/type-aliases/EvalResult.md b/docs/api/namespaces/Types/type-aliases/EvalResult.md deleted file mode 100644 index a2f08bfc..00000000 --- a/docs/api/namespaces/Types/type-aliases/EvalResult.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / EvalResult - -# Type Alias: EvalResult - -> **EvalResult**: `object` \| `void` - -## Defined in - -[src/types/PlatformShim.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L10) diff --git a/docs/api/namespaces/Types/type-aliases/ExtractionMatch.md b/docs/api/namespaces/Types/type-aliases/ExtractionMatch.md deleted file mode 100644 index 5e8e62f9..00000000 --- a/docs/api/namespaces/Types/type-aliases/ExtractionMatch.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ExtractionMatch - -# Type Alias: ExtractionMatch - -> **ExtractionMatch**: [`ExtractionState`](../interfaces/ExtractionState.md) - -## Defined in - -[src/utils/javascript/JsAnalyzer.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsAnalyzer.ts#L51) diff --git a/docs/api/namespaces/Types/type-aliases/Feature.md b/docs/api/namespaces/Types/type-aliases/Feature.md deleted file mode 100644 index ab892cf5..00000000 --- a/docs/api/namespaces/Types/type-aliases/Feature.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / Feature - -# Type Alias: Feature - -> **Feature**: `"hd"` \| `"subtitles"` \| `"creative_commons"` \| `"3d"` \| `"live"` \| `"purchased"` \| `"4k"` \| `"360"` \| `"location"` \| `"hdr"` \| `"vr180"` - -## Defined in - -[src/types/Misc.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L11) diff --git a/docs/api/namespaces/Types/type-aliases/FetchFunction.md b/docs/api/namespaces/Types/type-aliases/FetchFunction.md deleted file mode 100644 index 073c5f4f..00000000 --- a/docs/api/namespaces/Types/type-aliases/FetchFunction.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / FetchFunction - -# Type Alias: FetchFunction - -> **FetchFunction**: *typeof* `fetch` - -## Defined in - -[src/types/PlatformShim.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L6) diff --git a/docs/api/namespaces/Types/type-aliases/FormatFilter.md b/docs/api/namespaces/Types/type-aliases/FormatFilter.md deleted file mode 100644 index 05df6199..00000000 --- a/docs/api/namespaces/Types/type-aliases/FormatFilter.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / FormatFilter - -# Type Alias: FormatFilter() - -> **FormatFilter**: (`format`) => `boolean` - -## Parameters - -• **format**: [`Format`](../../Misc/classes/Format.md) - -## Returns - -`boolean` - -## Defined in - -[src/types/FormatUtils.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L5) diff --git a/docs/api/namespaces/Types/type-aliases/InnerTubeClient.md b/docs/api/namespaces/Types/type-aliases/InnerTubeClient.md deleted file mode 100644 index a0679b1f..00000000 --- a/docs/api/namespaces/Types/type-aliases/InnerTubeClient.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / InnerTubeClient - -# Type Alias: InnerTubeClient - -> **InnerTubeClient**: `"IOS"` \| `"WEB"` \| `"MWEB"` \| `"ANDROID"` \| `"YTMUSIC"` \| `"YTMUSIC_ANDROID"` \| `"YTSTUDIO_ANDROID"` \| `"TV"` \| `"TV_SIMPLY"` \| `"TV_EMBEDDED"` \| `"YTKIDS"` \| `"WEB_EMBEDDED"` \| `"WEB_CREATOR"` - -## Defined in - -[src/types/Misc.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L4) diff --git a/docs/api/namespaces/Types/type-aliases/InnerTubeConfig.md b/docs/api/namespaces/Types/type-aliases/InnerTubeConfig.md deleted file mode 100644 index f578597e..00000000 --- a/docs/api/namespaces/Types/type-aliases/InnerTubeConfig.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / InnerTubeConfig - -# Type Alias: InnerTubeConfig - -> **InnerTubeConfig**: [`SessionOptions`](../../../type-aliases/SessionOptions.md) - -## Defined in - -[src/types/Misc.ts:3](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L3) diff --git a/docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md b/docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md deleted file mode 100644 index acb53239..00000000 --- a/docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / MusicSearchFilters - -# Type Alias: MusicSearchFilters - -> **MusicSearchFilters**: `object` - -## Type declaration - -### type? - -> `optional` **type**: [`MusicSearchType`](MusicSearchType.md) - -## Defined in - -[src/types/Misc.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L42) diff --git a/docs/api/namespaces/Types/type-aliases/MusicSearchType.md b/docs/api/namespaces/Types/type-aliases/MusicSearchType.md deleted file mode 100644 index d1f0acaf..00000000 --- a/docs/api/namespaces/Types/type-aliases/MusicSearchType.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / MusicSearchType - -# Type Alias: MusicSearchType - -> **MusicSearchType**: `"all"` \| `"song"` \| `"video"` \| `"album"` \| `"playlist"` \| `"artist"` - -## Defined in - -[src/types/Misc.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L40) diff --git a/docs/api/namespaces/Types/type-aliases/Runtime.md b/docs/api/namespaces/Types/type-aliases/Runtime.md deleted file mode 100644 index d92011a0..00000000 --- a/docs/api/namespaces/Types/type-aliases/Runtime.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / Runtime - -# Type Alias: Runtime - -> **Runtime**: `"deno"` \| `"node"` \| `"browser"` \| `"cf-worker"` \| `"unknown"` \| `"react-native"` - -## Defined in - -[src/types/PlatformShim.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L4) diff --git a/docs/api/namespaces/Types/type-aliases/SearchFilters.md b/docs/api/namespaces/Types/type-aliases/SearchFilters.md deleted file mode 100644 index a62b0635..00000000 --- a/docs/api/namespaces/Types/type-aliases/SearchFilters.md +++ /dev/null @@ -1,31 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SearchFilters - -# Type Alias: SearchFilters - -> **SearchFilters**: `object` - -## Type declaration - -### duration? - -> `optional` **duration**: [`Duration`](Duration.md) - -### features? - -> `optional` **features**: [`Feature`](Feature.md)[] - -### sort\_by? - -> `optional` **sort\_by**: [`SortBy`](SortBy.md) - -### type? - -> `optional` **type**: [`SearchType`](SearchType.md) - -### upload\_date? - -> `optional` **upload\_date**: [`UploadDate`](UploadDate.md) - -## Defined in - -[src/types/Misc.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L13) diff --git a/docs/api/namespaces/Types/type-aliases/SearchType.md b/docs/api/namespaces/Types/type-aliases/SearchType.md deleted file mode 100644 index 3a682575..00000000 --- a/docs/api/namespaces/Types/type-aliases/SearchType.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SearchType - -# Type Alias: SearchType - -> **SearchType**: `"all"` \| `"video"` \| `"channel"` \| `"playlist"` \| `"movie"` - -## Defined in - -[src/types/Misc.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L8) diff --git a/docs/api/namespaces/Types/type-aliases/SideEffectMode.md b/docs/api/namespaces/Types/type-aliases/SideEffectMode.md deleted file mode 100644 index 20a8274e..00000000 --- a/docs/api/namespaces/Types/type-aliases/SideEffectMode.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SideEffectMode - -# Type Alias: SideEffectMode - -> **SideEffectMode**: `"strict"` \| `"loose"` - -## Defined in - -[src/utils/javascript/JsExtractor.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/javascript/JsExtractor.ts#L5) diff --git a/docs/api/namespaces/Types/type-aliases/SortBy.md b/docs/api/namespaces/Types/type-aliases/SortBy.md deleted file mode 100644 index 7c4d6310..00000000 --- a/docs/api/namespaces/Types/type-aliases/SortBy.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SortBy - -# Type Alias: SortBy - -> **SortBy**: `"relevance"` \| `"rating"` \| `"upload_date"` \| `"view_count"` - -## Defined in - -[src/types/Misc.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L10) diff --git a/docs/api/namespaces/Types/type-aliases/URLTransformer.md b/docs/api/namespaces/Types/type-aliases/URLTransformer.md deleted file mode 100644 index 282cc30f..00000000 --- a/docs/api/namespaces/Types/type-aliases/URLTransformer.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / URLTransformer - -# Type Alias: URLTransformer() - -> **URLTransformer**: (`url`) => `URL` - -## Parameters - -• **url**: `URL` - -## Returns - -`URL` - -## Defined in - -[src/types/FormatUtils.ts:4](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/FormatUtils.ts#L4) diff --git a/docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md b/docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md deleted file mode 100644 index c0a7e901..00000000 --- a/docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md +++ /dev/null @@ -1,47 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / UpdateVideoMetadataOptions - -# Type Alias: UpdateVideoMetadataOptions - -> **UpdateVideoMetadataOptions**: `Partial`\<`object`\> - -## Type declaration - -### age\_restricted - -> **age\_restricted**: `boolean` - -### category - -> **category**: `number` - -### description - -> **description**: `string` - -### license - -> **license**: `string` - -### made\_for\_kids - -> **made\_for\_kids**: `boolean` - -### privacy - -> **privacy**: `"PUBLIC"` \| `"PRIVATE"` \| `"UNLISTED"` - -### tags - -> **tags**: `string`[] - -### thumbnail - -> **thumbnail**: `Uint8Array` - -### title - -> **title**: `string` - -## Defined in - -[src/types/Misc.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L21) diff --git a/docs/api/namespaces/Types/type-aliases/UploadDate.md b/docs/api/namespaces/Types/type-aliases/UploadDate.md deleted file mode 100644 index 75864039..00000000 --- a/docs/api/namespaces/Types/type-aliases/UploadDate.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / UploadDate - -# Type Alias: UploadDate - -> **UploadDate**: `"all"` \| `"hour"` \| `"today"` \| `"week"` \| `"month"` \| `"year"` - -## Defined in - -[src/types/Misc.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L7) diff --git a/docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md b/docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md deleted file mode 100644 index b7114860..00000000 --- a/docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / UploadedVideoMetadataOptions - -# Type Alias: UploadedVideoMetadataOptions - -> **UploadedVideoMetadataOptions**: `Partial`\<`object`\> - -## Type declaration - -### description - -> **description**: `string` - -### is\_draft - -> **is\_draft**: `boolean` - -### privacy - -> **privacy**: `"PUBLIC"` \| `"PRIVATE"` \| `"UNLISTED"` - -### title - -> **title**: `string` - -## Defined in - -[src/types/Misc.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/Misc.ts#L33) diff --git a/docs/api/namespaces/Types/type-aliases/VMPrimative.md b/docs/api/namespaces/Types/type-aliases/VMPrimative.md deleted file mode 100644 index dce1f5c8..00000000 --- a/docs/api/namespaces/Types/type-aliases/VMPrimative.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / VMPrimative - -# Type Alias: VMPrimative - -> **VMPrimative**: `string` \| `number` \| `boolean` \| `null` \| `undefined` - -## Defined in - -[src/types/PlatformShim.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/types/PlatformShim.ts#L8) diff --git a/docs/api/namespaces/Utils/functions/base64ToU8.md b/docs/api/namespaces/Utils/functions/base64ToU8.md deleted file mode 100644 index 8512ec80..00000000 --- a/docs/api/namespaces/Utils/functions/base64ToU8.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / base64ToU8 - -# Function: base64ToU8() - -> **base64ToU8**(`base64`): `Uint8Array` - -## Parameters - -• **base64**: `string` - -## Returns - -`Uint8Array` - -## Defined in - -[src/utils/Utils.ts:250](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L250) diff --git a/docs/api/namespaces/Utils/functions/concatMemos.md b/docs/api/namespaces/Utils/functions/concatMemos.md deleted file mode 100644 index 6238f0eb..00000000 --- a/docs/api/namespaces/Utils/functions/concatMemos.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / concatMemos - -# Function: concatMemos() - -> **concatMemos**(...`iterables`): [`Memo`](../../Helpers/classes/Memo.md) - -## Parameters - -• ...**iterables**: (`undefined` \| [`Memo`](../../Helpers/classes/Memo.md))[] - -## Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -## Defined in - -[src/utils/Utils.ts:154](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L154) diff --git a/docs/api/namespaces/Utils/functions/debugFetch.md b/docs/api/namespaces/Utils/functions/debugFetch.md deleted file mode 100644 index f0a722bc..00000000 --- a/docs/api/namespaces/Utils/functions/debugFetch.md +++ /dev/null @@ -1,41 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / debugFetch - -# Function: debugFetch() - -## debugFetch(input, init) - -> **debugFetch**(`input`, `init`?): `Promise`\<`Response`\> - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch) - -### Parameters - -• **input**: `URL` \| `RequestInfo` - -• **init?**: `RequestInit` - -### Returns - -`Promise`\<`Response`\> - -### Defined in - -[src/utils/Utils.ts:205](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L205) - -## debugFetch(input, init) - -> **debugFetch**(`input`, `init`?): `Promise`\<`Response`\> - -### Parameters - -• **input**: `string` \| `URL` \| `Request` - -• **init?**: `RequestInit` - -### Returns - -`Promise`\<`Response`\> - -### Defined in - -[src/utils/Utils.ts:205](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L205) diff --git a/docs/api/namespaces/Utils/functions/deepCompare.md b/docs/api/namespaces/Utils/functions/deepCompare.md deleted file mode 100644 index 21eefcee..00000000 --- a/docs/api/namespaces/Utils/functions/deepCompare.md +++ /dev/null @@ -1,22 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / deepCompare - -# Function: deepCompare() - -> **deepCompare**(`obj1`, `obj2`): `boolean` - -Compares given objects. May not work correctly for -objects with methods. - -## Parameters - -• **obj1**: `any` - -• **obj2**: `any` - -## Returns - -`boolean` - -## Defined in - -[src/utils/Utils.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L67) diff --git a/docs/api/namespaces/Utils/functions/escapeStringRegexp.md b/docs/api/namespaces/Utils/functions/escapeStringRegexp.md deleted file mode 100644 index 39c58c16..00000000 --- a/docs/api/namespaces/Utils/functions/escapeStringRegexp.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / escapeStringRegexp - -# Function: escapeStringRegexp() - -> **escapeStringRegexp**(`input`): `string` - -## Parameters - -• **input**: `string` - -## Returns - -`string` - -## Defined in - -[src/utils/Utils.ts:90](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L90) diff --git a/docs/api/namespaces/Utils/functions/generateRandomString.md b/docs/api/namespaces/Utils/functions/generateRandomString.md deleted file mode 100644 index e712f83f..00000000 --- a/docs/api/namespaces/Utils/functions/generateRandomString.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / generateRandomString - -# Function: generateRandomString() - -> **generateRandomString**(`length`): `string` - -Generates a random string with the given length. - -## Parameters - -• **length**: `number` - -## Returns - -`string` - -## Defined in - -[src/utils/Utils.ts:124](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L124) diff --git a/docs/api/namespaces/Utils/functions/generateSidAuth.md b/docs/api/namespaces/Utils/functions/generateSidAuth.md deleted file mode 100644 index 619fdfaf..00000000 --- a/docs/api/namespaces/Utils/functions/generateSidAuth.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / generateSidAuth - -# Function: generateSidAuth() - -> **generateSidAuth**(`sid`): `Promise`\<`string`\> - -Generates an authentication token from a cookies' sid. - -## Parameters - -• **sid**: `string` - -Sid extracted from cookies - -## Returns - -`Promise`\<`string`\> - -## Defined in - -[src/utils/Utils.ts:110](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L110) diff --git a/docs/api/namespaces/Utils/functions/getCookie.md b/docs/api/namespaces/Utils/functions/getCookie.md deleted file mode 100644 index e913e3bf..00000000 --- a/docs/api/namespaces/Utils/functions/getCookie.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / getCookie - -# Function: getCookie() - -> **getCookie**(`cookies`, `name`, `matchWholeName`): `string` \| `undefined` - -## Parameters - -• **cookies**: `string` - -• **name**: `string` - -• **matchWholeName**: `boolean` = `false` - -## Returns - -`string` \| `undefined` - -## Defined in - -[src/utils/Utils.ts:260](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L260) diff --git a/docs/api/namespaces/Utils/functions/getRandomUserAgent.md b/docs/api/namespaces/Utils/functions/getRandomUserAgent.md deleted file mode 100644 index 091df871..00000000 --- a/docs/api/namespaces/Utils/functions/getRandomUserAgent.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / getRandomUserAgent - -# Function: getRandomUserAgent() - -> **getRandomUserAgent**(`type`): `string` - -Returns a random user agent. - -## Parameters - -• **type**: [`DeviceCategory`](../type-aliases/DeviceCategory.md) - -mobile | desktop - -## Returns - -`string` - -## Defined in - -[src/utils/Utils.ts:100](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L100) diff --git a/docs/api/namespaces/Utils/functions/getStringBetweenStrings.md b/docs/api/namespaces/Utils/functions/getStringBetweenStrings.md deleted file mode 100644 index 469836c8..00000000 --- a/docs/api/namespaces/Utils/functions/getStringBetweenStrings.md +++ /dev/null @@ -1,29 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / getStringBetweenStrings - -# Function: getStringBetweenStrings() - -> **getStringBetweenStrings**(`data`, `start_string`, `end_string`): `string` \| `undefined` - -Finds a string between two delimiters. - -## Parameters - -• **data**: `string` - -the data. - -• **start\_string**: `string` - -start string. - -• **end\_string**: `string` - -end string. - -## Returns - -`string` \| `undefined` - -## Defined in - -[src/utils/Utils.ts:84](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L84) diff --git a/docs/api/namespaces/Utils/functions/hasKeys.md b/docs/api/namespaces/Utils/functions/hasKeys.md deleted file mode 100644 index b4c2c936..00000000 --- a/docs/api/namespaces/Utils/functions/hasKeys.md +++ /dev/null @@ -1,25 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / hasKeys - -# Function: hasKeys() - -> **hasKeys**\<`T`, `R`\>(`params`, ...`keys`): `params is Exclude & Required>` - -## Type Parameters - -• **T** *extends* `object` - -• **R** *extends* keyof `T`[] - -## Parameters - -• **params**: `T` - -• ...**keys**: `R` - -## Returns - -`params is Exclude & Required>` - -## Defined in - -[src/utils/Utils.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L181) diff --git a/docs/api/namespaces/Utils/functions/isTextRun.md b/docs/api/namespaces/Utils/functions/isTextRun.md deleted file mode 100644 index a04b7d27..00000000 --- a/docs/api/namespaces/Utils/functions/isTextRun.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / isTextRun - -# Function: isTextRun() - -> **isTextRun**(`run`): `run is TextRun` - -## Parameters - -• **run**: [`TextRun`](../../Misc/classes/TextRun.md) \| [`EmojiRun`](../../Misc/classes/EmojiRun.md) - -## Returns - -`run is TextRun` - -## Defined in - -[src/utils/Utils.ts:256](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L256) diff --git a/docs/api/namespaces/Utils/functions/streamToIterable.md b/docs/api/namespaces/Utils/functions/streamToIterable.md deleted file mode 100644 index 56d30337..00000000 --- a/docs/api/namespaces/Utils/functions/streamToIterable.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / streamToIterable - -# Function: streamToIterable() - -> **streamToIterable**(`stream`): `AsyncGenerator`\<`Uint8Array`, `void`, `unknown`\> - -## Parameters - -• **stream**: `ReadableStream`\<`Uint8Array`\> - -## Returns - -`AsyncGenerator`\<`Uint8Array`, `void`, `unknown`\> - -## Defined in - -[src/utils/Utils.ts:189](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L189) diff --git a/docs/api/namespaces/Utils/functions/throwIfMissing.md b/docs/api/namespaces/Utils/functions/throwIfMissing.md deleted file mode 100644 index 9c69d3d5..00000000 --- a/docs/api/namespaces/Utils/functions/throwIfMissing.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / throwIfMissing - -# Function: throwIfMissing() - -> **throwIfMissing**(`params`): `void` - -## Parameters - -• **params**: `object` - -## Returns - -`void` - -## Defined in - -[src/utils/Utils.ts:174](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L174) diff --git a/docs/api/namespaces/Utils/functions/timeToSeconds.md b/docs/api/namespaces/Utils/functions/timeToSeconds.md deleted file mode 100644 index e03dd397..00000000 --- a/docs/api/namespaces/Utils/functions/timeToSeconds.md +++ /dev/null @@ -1,21 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / timeToSeconds - -# Function: timeToSeconds() - -> **timeToSeconds**(`time`): `number` - -Converts time (h:m:s) to seconds. - -## Parameters - -• **time**: `string` - -## Returns - -`number` - -seconds - -## Defined in - -[src/utils/Utils.ts:140](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L140) diff --git a/docs/api/namespaces/Utils/functions/u8ToBase64.md b/docs/api/namespaces/Utils/functions/u8ToBase64.md deleted file mode 100644 index 0aff981b..00000000 --- a/docs/api/namespaces/Utils/functions/u8ToBase64.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / u8ToBase64 - -# Function: u8ToBase64() - -> **u8ToBase64**(`u8`): `string` - -## Parameters - -• **u8**: `Uint8Array` - -## Returns - -`string` - -## Defined in - -[src/utils/Utils.ts:246](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L246) diff --git a/docs/api/namespaces/Utils/type-aliases/DeviceCategory.md b/docs/api/namespaces/Utils/type-aliases/DeviceCategory.md deleted file mode 100644 index f3afd862..00000000 --- a/docs/api/namespaces/Utils/type-aliases/DeviceCategory.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Utils](../README.md) / DeviceCategory - -# Type Alias: DeviceCategory - -> **DeviceCategory**: `"mobile"` \| `"desktop"` - -## Defined in - -[src/utils/Utils.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/Utils.ts#L94) diff --git a/docs/api/namespaces/YT/classes/AccountInfo.md b/docs/api/namespaces/YT/classes/AccountInfo.md deleted file mode 100644 index d500073e..00000000 --- a/docs/api/namespaces/YT/classes/AccountInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / AccountInfo - -# Class: AccountInfo - -## Constructors - -### new AccountInfo() - -> **new AccountInfo**(`response`): [`AccountInfo`](AccountInfo.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -#### Returns - -[`AccountInfo`](AccountInfo.md) - -#### Defined in - -[src/parser/youtube/AccountInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/AccountInfo.ts#L14) - -## Properties - -### contents - -> **contents**: `null` \| [`AccountItemSection`](../../YTNodes/classes/AccountItemSection.md) - -#### Defined in - -[src/parser/youtube/AccountInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/AccountInfo.ts#L12) - -## Accessors - -### page - -> `get` **page**(): [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -#### Returns - -[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -#### Defined in - -[src/parser/youtube/AccountInfo.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/AccountInfo.ts#L28) diff --git a/docs/api/namespaces/YT/classes/Channel.md b/docs/api/namespaces/YT/classes/Channel.md deleted file mode 100644 index f8338274..00000000 --- a/docs/api/namespaces/YT/classes/Channel.md +++ /dev/null @@ -1,1064 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / Channel - -# Class: Channel - -## Extends - -- [`TabbedFeed`](../../Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new Channel() - -> **new Channel**(`actions`, `data`, `already_parsed`): [`Channel`](Channel.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`Channel`](Channel.md) - -#### Overrides - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`constructor`](../../Mixins/classes/TabbedFeed.md#constructors) - -#### Defined in - -[src/parser/youtube/Channel.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L42) - -## Properties - -### current\_tab? - -> `optional` **current\_tab**: [`Tab`](../../YTNodes/classes/Tab.md) \| [`ExpandableTab`](../../YTNodes/classes/ExpandableTab.md) - -#### Defined in - -[src/parser/youtube/Channel.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L40) - -*** - -### header? - -> `optional` **header**: [`C4TabbedHeader`](../../YTNodes/classes/C4TabbedHeader.md) \| [`CarouselHeader`](../../YTNodes/classes/CarouselHeader.md) \| [`InteractiveTabbedHeader`](../../YTNodes/classes/InteractiveTabbedHeader.md) \| [`PageHeader`](../../YTNodes/classes/PageHeader.md) - -#### Defined in - -[src/parser/youtube/Channel.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L37) - -*** - -### metadata - -> **metadata**: `object` - -#### android\_appindexing\_link? - -> `optional` **android\_appindexing\_link**: `string` - -#### android\_deep\_link? - -> `optional` **android\_deep\_link**: `string` - -#### android\_package? - -> `optional` **android\_package**: `string` - -#### app\_name? - -> `optional` **app\_name**: `string` - -#### available\_countries? - -> `optional` **available\_countries**: `string`[] - -#### avatar? - -> `optional` **avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### description? - -> `optional` **description**: `string` - -#### external\_id? - -> `optional` **external\_id**: `string` - -#### ios\_app\_arguments? - -> `optional` **ios\_app\_arguments**: `string` - -#### ios\_app\_store\_id? - -> `optional` **ios\_app\_store\_id**: `string` - -#### ios\_appindexing\_link? - -> `optional` **ios\_appindexing\_link**: `string` - -#### is\_family\_safe? - -> `optional` **is\_family\_safe**: `boolean` - -#### is\_unlisted? - -> `optional` **is\_unlisted**: `boolean` - -#### keywords? - -> `optional` **keywords**: `string`[] - -#### music\_artist\_name? - -> `optional` **music\_artist\_name**: `string` - -#### noindex? - -> `optional` **noindex**: `string` - -#### og\_type? - -> `optional` **og\_type**: `string` - -#### rss\_url? - -> `optional` **rss\_url**: `string` - -#### schema\_dot\_org\_type? - -> `optional` **schema\_dot\_org\_type**: `string` - -#### site\_name? - -> `optional` **site\_name**: `string` - -#### tags? - -> `optional` **tags**: `string`[] - -#### thumbnail? - -> `optional` **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### title? - -> `optional` **title**: `string` - -#### twitter\_card\_type? - -> `optional` **twitter\_card\_type**: `string` - -#### twitter\_site\_handle? - -> `optional` **twitter\_site\_handle**: `string` - -#### type? - -> `readonly` `optional` **type**: `string` - -#### url? - -> `optional` **url**: `string` - -#### url\_applinks\_android? - -> `optional` **url\_applinks\_android**: `string` - -#### url\_applinks\_ios? - -> `optional` **url\_applinks\_ios**: `string` - -#### url\_applinks\_web? - -> `optional` **url\_applinks\_web**: `string` - -#### url\_canonical? - -> `optional` **url\_canonical**: `string` - -#### url\_twitter\_android? - -> `optional` **url\_twitter\_android**: `string` - -#### url\_twitter\_ios? - -> `optional` **url\_twitter\_ios**: `string` - -#### vanity\_channel\_url? - -> `optional` **vanity\_channel\_url**: `string` - -#### Defined in - -[src/parser/youtube/Channel.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L38) - -*** - -### subscribe\_button? - -> `optional` **subscribe\_button**: [`SubscribeButton`](../../YTNodes/classes/SubscribeButton.md) - -#### Defined in - -[src/parser/youtube/Channel.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L39) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`actions`](../../Mixins/classes/TabbedFeed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`channels`](../../Mixins/classes/TabbedFeed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### content\_type\_filters - -> `get` **content\_type\_filters**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/Channel.ts:151](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L151) - -*** - -### filters - -> `get` **filters**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/Channel.ts:142](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L142) - -*** - -### has\_about - -> `get` **has\_about**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:289](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L289) - -*** - -### has\_community - -> `get` **has\_community**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:285](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L285) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`has_continuation`](../../Mixins/classes/TabbedFeed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### has\_courses - -> `get` **has\_courses**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:277](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L277) - -*** - -### has\_home - -> `get` **has\_home**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:253](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L253) - -*** - -### has\_live\_streams - -> `get` **has\_live\_streams**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:265](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L265) - -*** - -### has\_playlists - -> `get` **has\_playlists**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:281](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L281) - -*** - -### has\_podcasts - -> `get` **has\_podcasts**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:273](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L273) - -*** - -### has\_releases - -> `get` **has\_releases**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:269](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L269) - -*** - -### has\_search - -> `get` **has\_search**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:296](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L296) - -*** - -### has\_shorts - -> `get` **has\_shorts**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:261](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L261) - -*** - -### has\_videos - -> `get` **has\_videos**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Channel.ts:257](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L257) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`memo`](../../Mixins/classes/TabbedFeed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`page`](../../Mixins/classes/TabbedFeed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`page_contents`](../../Mixins/classes/TabbedFeed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`playlists`](../../Mixins/classes/TabbedFeed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`posts`](../../Mixins/classes/TabbedFeed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`secondary_contents`](../../Mixins/classes/TabbedFeed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`shelves`](../../Mixins/classes/TabbedFeed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### sort\_filters - -> `get` **sort\_filters**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/Channel.ts:146](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L146) - -*** - -### tabs - -> `get` **tabs**(): `string`[] - -#### Returns - -`string`[] - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`tabs`](../../Mixins/classes/TabbedFeed.md#tabs) - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L19) - -*** - -### title - -> `get` **title**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`title`](../../Mixins/classes/TabbedFeed.md#title) - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L55) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`videos`](../../Mixins/classes/TabbedFeed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### applyContentTypeFilter() - -> **applyContentTypeFilter**(`content_type_filter`): `Promise`\<[`Channel`](Channel.md)\> - -Applies given content type filter to the list. Use [content_type_filters](Channel.md#content_type_filters) to get available filters. - -#### Parameters - -• **content\_type\_filter**: `string` - -The content type filter to apply - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:123](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L123) - -*** - -### applyFilter() - -> **applyFilter**(`filter`): `Promise`\<[`FilteredChannelList`](FilteredChannelList.md)\> - -Applies given filter to the list. Use [filters](Channel.md#filters) to get available filters. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -The filter to apply - -#### Returns - -`Promise`\<[`FilteredChannelList`](FilteredChannelList.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:72](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L72) - -*** - -### applySort() - -> **applySort**(`sort`): `Promise`\<[`Channel`](Channel.md)\> - -Applies given sort filter to the list. Use [sort_filters](Channel.md#sort_filters) to get available filters. - -#### Parameters - -• **sort**: `string` - -The sort filter to apply - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:100](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L100) - -*** - -### getAbout() - -> **getAbout**(): `Promise`\<[`ChannelAboutFullMetadata`](../../YTNodes/classes/ChannelAboutFullMetadata.md) \| [`AboutChannel`](../../YTNodes/classes/AboutChannel.md)\> - -Retrieves the about page. -Note that this does not return a new [Channel](Channel.md) object. - -#### Returns - -`Promise`\<[`ChannelAboutFullMetadata`](../../YTNodes/classes/ChannelAboutFullMetadata.md) \| [`AboutChannel`](../../YTNodes/classes/AboutChannel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:205](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L205) - -*** - -### getCommunity() - -> **getCommunity**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:196](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L196) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`ChannelListContinuation`](ChannelListContinuation.md)\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`ChannelListContinuation`](ChannelListContinuation.md)\> - -#### Overrides - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`getContinuation`](../../Mixins/classes/TabbedFeed.md#getcontinuation) - -#### Defined in - -[src/parser/youtube/Channel.ts:300](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L300) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`getContinuationData`](../../Mixins/classes/TabbedFeed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getCourses() - -> **getCourses**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:186](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L186) - -*** - -### getHome() - -> **getHome**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:156](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L156) - -*** - -### getLiveStreams() - -> **getLiveStreams**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:171](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L171) - -*** - -### getPlaylists() - -> **getPlaylists**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:191](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L191) - -*** - -### getPodcasts() - -> **getPodcasts**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L181) - -*** - -### getReleases() - -> **getReleases**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:176](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L176) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`getShelf`](../../Mixins/classes/TabbedFeed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getShorts() - -> **getShorts**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:166](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L166) - -*** - -### getTabByName() - -> **getTabByName**(`title`): `Promise`\<[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Parameters - -• **title**: `string` - -#### Returns - -`Promise`\<[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`getTabByName`](../../Mixins/classes/TabbedFeed.md#gettabbyname) - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L23) - -*** - -### getTabByURL() - -> **getTabByURL**(`url`): `Promise`\<[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Parameters - -• **url**: `string` - -#### Returns - -`Promise`\<[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`getTabByURL`](../../Mixins/classes/TabbedFeed.md#gettabbyurl) - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L37) - -*** - -### getVideos() - -> **getVideos**(): `Promise`\<[`Channel`](Channel.md)\> - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:161](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L161) - -*** - -### hasTabWithURL() - -> **hasTabWithURL**(`url`): `boolean` - -#### Parameters - -• **url**: `string` - -#### Returns - -`boolean` - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`hasTabWithURL`](../../Mixins/classes/TabbedFeed.md#hastabwithurl) - -#### Defined in - -[src/core/mixins/TabbedFeed.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/TabbedFeed.ts#L51) - -*** - -### search() - -> **search**(`query`): `Promise`\<[`Channel`](Channel.md)\> - -Searches within the channel. - -#### Parameters - -• **query**: `string` - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:242](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L242) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/TabbedFeed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`TabbedFeed`](../../Mixins/classes/TabbedFeed.md).[`getVideosFromMemo`](../../Mixins/classes/TabbedFeed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/ChannelListContinuation.md b/docs/api/namespaces/YT/classes/ChannelListContinuation.md deleted file mode 100644 index 00600cb4..00000000 --- a/docs/api/namespaces/YT/classes/ChannelListContinuation.md +++ /dev/null @@ -1,371 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / ChannelListContinuation - -# Class: ChannelListContinuation - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new ChannelListContinuation() - -> **new ChannelListContinuation**(`actions`, `data`, `already_parsed`): [`ChannelListContinuation`](ChannelListContinuation.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`ChannelListContinuation`](ChannelListContinuation.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/youtube/Channel.ts:311](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L311) - -## Properties - -### contents? - -> `optional` **contents**: [`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md) - -#### Defined in - -[src/parser/youtube/Channel.ts:309](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L309) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`ChannelListContinuation`](ChannelListContinuation.md)\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`ChannelListContinuation`](ChannelListContinuation.md)\> - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/parser/youtube/Channel.ts:318](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L318) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/Comments.md b/docs/api/namespaces/YT/classes/Comments.md deleted file mode 100644 index a45bed3b..00000000 --- a/docs/api/namespaces/YT/classes/Comments.md +++ /dev/null @@ -1,133 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / Comments - -# Class: Comments - -## Constructors - -### new Comments() - -> **new Comments**(`actions`, `data`, `already_parsed`): [`Comments`](Comments.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: `any` - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`Comments`](Comments.md) - -#### Defined in - -[src/parser/youtube/Comments.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L23) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CommentThread`](../../YTNodes/classes/CommentThread.md)\> - -#### Defined in - -[src/parser/youtube/Comments.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L21) - -*** - -### header? - -> `optional` **header**: [`CommentsHeader`](../../YTNodes/classes/CommentsHeader.md) - -#### Defined in - -[src/parser/youtube/Comments.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L20) - -## Accessors - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/Comments.ts:117](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L117) - -*** - -### page - -> `get` **page**(): [`INextResponse`](../../APIResponseTypes/type-aliases/INextResponse.md) - -#### Returns - -[`INextResponse`](../../APIResponseTypes/type-aliases/INextResponse.md) - -#### Defined in - -[src/parser/youtube/Comments.ts:121](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L121) - -## Methods - -### applySort() - -> **applySort**(`sort`): `Promise`\<[`Comments`](Comments.md)\> - -Applies given sort option to the comments. - -#### Parameters - -• **sort**: `"TOP_COMMENTS"` \| `"NEWEST_FIRST"` - -Sort type. - -#### Returns - -`Promise`\<[`Comments`](Comments.md)\> - -#### Defined in - -[src/parser/youtube/Comments.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L53) - -*** - -### createComment() - -> **createComment**(`text`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Creates a top-level comment. - -#### Parameters - -• **text**: `string` - -Comment text. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/parser/youtube/Comments.ts:80](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L80) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Comments`](Comments.md)\> - -Retrieves next batch of comments. - -#### Returns - -`Promise`\<[`Comments`](Comments.md)\> - -#### Defined in - -[src/parser/youtube/Comments.ts:98](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Comments.ts#L98) diff --git a/docs/api/namespaces/YT/classes/FilteredChannelList.md b/docs/api/namespaces/YT/classes/FilteredChannelList.md deleted file mode 100644 index b4764f52..00000000 --- a/docs/api/namespaces/YT/classes/FilteredChannelList.md +++ /dev/null @@ -1,467 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / FilteredChannelList - -# Class: FilteredChannelList - -## Extends - -- [`FilterableFeed`](../../Mixins/classes/FilterableFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new FilteredChannelList() - -> **new FilteredChannelList**(`actions`, `data`, `already_parsed`): [`FilteredChannelList`](FilteredChannelList.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`FilteredChannelList`](FilteredChannelList.md) - -#### Overrides - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`constructor`](../../Mixins/classes/FilterableFeed.md#constructors) - -#### Defined in - -[src/parser/youtube/Channel.ts:330](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L330) - -## Properties - -### applied\_filter? - -> `optional` **applied\_filter**: [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Defined in - -[src/parser/youtube/Channel.ts:327](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L327) - -*** - -### contents? - -> `optional` **contents**: [`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md) - -#### Defined in - -[src/parser/youtube/Channel.ts:328](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L328) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`actions`](../../Mixins/classes/FilterableFeed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`channels`](../../Mixins/classes/FilterableFeed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### filter\_chips - -> `get` **filter\_chips**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -Returns the filter chips. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`filter_chips`](../../Mixins/classes/FilterableFeed.md#filter_chips) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L20) - -*** - -### filters - -> `get` **filters**(): `string`[] - -Returns available filters. - -#### Returns - -`string`[] - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`filters`](../../Mixins/classes/FilterableFeed.md#filters) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L38) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`has_continuation`](../../Mixins/classes/FilterableFeed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`memo`](../../Mixins/classes/FilterableFeed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`page`](../../Mixins/classes/FilterableFeed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`page_contents`](../../Mixins/classes/FilterableFeed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`playlists`](../../Mixins/classes/FilterableFeed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`posts`](../../Mixins/classes/FilterableFeed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`secondary_contents`](../../Mixins/classes/FilterableFeed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`shelves`](../../Mixins/classes/FilterableFeed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`videos`](../../Mixins/classes/FilterableFeed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### applyFilter() - -> **applyFilter**(`filter`): `Promise`\<[`FilteredChannelList`](FilteredChannelList.md)\> - -Applies given filter to the list. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -The filter to apply - -#### Returns - -`Promise`\<[`FilteredChannelList`](FilteredChannelList.md)\> - -#### Defined in - -[src/parser/youtube/Channel.ts:350](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L350) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`FilteredChannelList`](FilteredChannelList.md)\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`FilteredChannelList`](FilteredChannelList.md)\> - -#### Overrides - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getContinuation`](../../Mixins/classes/FilterableFeed.md#getcontinuation) - -#### Defined in - -[src/parser/youtube/Channel.ts:355](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Channel.ts#L355) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getContinuationData`](../../Mixins/classes/FilterableFeed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getFilteredFeed() - -> **getFilteredFeed**(`filter`): `Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -Applies given filter and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Returns - -`Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getFilteredFeed`](../../Mixins/classes/FilterableFeed.md#getfilteredfeed) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L45) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getShelf`](../../Mixins/classes/FilterableFeed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/FilterableFeed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getVideosFromMemo`](../../Mixins/classes/FilterableFeed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/Guide.md b/docs/api/namespaces/YT/classes/Guide.md deleted file mode 100644 index 7ac2419e..00000000 --- a/docs/api/namespaces/YT/classes/Guide.md +++ /dev/null @@ -1,45 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / Guide - -# Class: Guide - -## Constructors - -### new Guide() - -> **new Guide**(`data`): [`Guide`](Guide.md) - -#### Parameters - -• **data**: [`IRawResponse`](../../APIResponseTypes/interfaces/IRawResponse.md) - -#### Returns - -[`Guide`](Guide.md) - -#### Defined in - -[src/parser/youtube/Guide.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Guide.ts#L13) - -## Properties - -### contents? - -> `optional` **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GuideSection`](../../YTNodes/classes/GuideSection.md) \| [`GuideSubscriptionsSection`](../../YTNodes/classes/GuideSubscriptionsSection.md)\> - -#### Defined in - -[src/parser/youtube/Guide.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Guide.ts#L11) - -## Accessors - -### page - -> `get` **page**(): [`IGuideResponse`](../../APIResponseTypes/type-aliases/IGuideResponse.md) - -#### Returns - -[`IGuideResponse`](../../APIResponseTypes/type-aliases/IGuideResponse.md) - -#### Defined in - -[src/parser/youtube/Guide.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Guide.ts#L19) diff --git a/docs/api/namespaces/YT/classes/HashtagFeed.md b/docs/api/namespaces/YT/classes/HashtagFeed.md deleted file mode 100644 index f834d5a5..00000000 --- a/docs/api/namespaces/YT/classes/HashtagFeed.md +++ /dev/null @@ -1,465 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / HashtagFeed - -# Class: HashtagFeed - -## Extends - -- [`FilterableFeed`](../../Mixins/classes/FilterableFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new HashtagFeed() - -> **new HashtagFeed**(`actions`, `response`): [`HashtagFeed`](HashtagFeed.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`HashtagFeed`](HashtagFeed.md) - -#### Overrides - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`constructor`](../../Mixins/classes/FilterableFeed.md#constructors) - -#### Defined in - -[src/parser/youtube/HashtagFeed.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HashtagFeed.ts#L16) - -## Properties - -### contents - -> **contents**: [`RichGrid`](../../YTNodes/classes/RichGrid.md) - -#### Defined in - -[src/parser/youtube/HashtagFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HashtagFeed.ts#L14) - -*** - -### header? - -> `optional` **header**: [`PageHeader`](../../YTNodes/classes/PageHeader.md) \| [`HashtagHeader`](../../YTNodes/classes/HashtagHeader.md) - -#### Defined in - -[src/parser/youtube/HashtagFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HashtagFeed.ts#L13) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`actions`](../../Mixins/classes/FilterableFeed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`channels`](../../Mixins/classes/FilterableFeed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### filter\_chips - -> `get` **filter\_chips**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -Returns the filter chips. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`filter_chips`](../../Mixins/classes/FilterableFeed.md#filter_chips) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L20) - -*** - -### filters - -> `get` **filters**(): `string`[] - -Returns available filters. - -#### Returns - -`string`[] - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`filters`](../../Mixins/classes/FilterableFeed.md#filters) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L38) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`has_continuation`](../../Mixins/classes/FilterableFeed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`memo`](../../Mixins/classes/FilterableFeed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`page`](../../Mixins/classes/FilterableFeed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`page_contents`](../../Mixins/classes/FilterableFeed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`playlists`](../../Mixins/classes/FilterableFeed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`posts`](../../Mixins/classes/FilterableFeed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`secondary_contents`](../../Mixins/classes/FilterableFeed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`shelves`](../../Mixins/classes/FilterableFeed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`videos`](../../Mixins/classes/FilterableFeed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### applyFilter() - -> **applyFilter**(`filter`): `Promise`\<[`HashtagFeed`](HashtagFeed.md)\> - -Applies given filter and returns a new [HashtagFeed](HashtagFeed.md) object. Use [HashtagFeed.filters](FilteredChannelList.md#filters) to get available filters. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -Filter to apply. - -#### Returns - -`Promise`\<[`HashtagFeed`](HashtagFeed.md)\> - -#### Defined in - -[src/parser/youtube/HashtagFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HashtagFeed.ts#L38) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getContinuation`](../../Mixins/classes/FilterableFeed.md#getcontinuation) - -#### Defined in - -[src/core/mixins/Feed.ts:219](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L219) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getContinuationData`](../../Mixins/classes/FilterableFeed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getFilteredFeed() - -> **getFilteredFeed**(`filter`): `Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -Applies given filter and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Returns - -`Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getFilteredFeed`](../../Mixins/classes/FilterableFeed.md#getfilteredfeed) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L45) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getShelf`](../../Mixins/classes/FilterableFeed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/FilterableFeed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getVideosFromMemo`](../../Mixins/classes/FilterableFeed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/History.md b/docs/api/namespaces/YT/classes/History.md deleted file mode 100644 index c59f1390..00000000 --- a/docs/api/namespaces/YT/classes/History.md +++ /dev/null @@ -1,401 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / History - -# Class: History - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new History() - -> **new History**(`actions`, `data`, `already_parsed`): [`History`](History.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`History`](History.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/youtube/History.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/History.ts#L15) - -## Properties - -### feed\_actions - -> **feed\_actions**: [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) - -#### Defined in - -[src/parser/youtube/History.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/History.ts#L13) - -*** - -### sections - -> **sections**: [`ItemSection`](../../YTNodes/classes/ItemSection.md)[] - -#### Defined in - -[src/parser/youtube/History.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/History.ts#L12) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`History`](History.md)\> - -Retrieves next batch of contents. - -#### Returns - -`Promise`\<[`History`](History.md)\> - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/parser/youtube/History.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/History.ts#L24) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### removeVideo() - -> **removeVideo**(`video_id`): `Promise`\<`boolean`\> - -Removes a video from watch history. - -#### Parameters - -• **video\_id**: `string` - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[src/parser/youtube/History.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/History.ts#L34) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/HomeFeed.md b/docs/api/namespaces/YT/classes/HomeFeed.md deleted file mode 100644 index e4b8aba6..00000000 --- a/docs/api/namespaces/YT/classes/HomeFeed.md +++ /dev/null @@ -1,467 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / HomeFeed - -# Class: HomeFeed - -## Extends - -- [`FilterableFeed`](../../Mixins/classes/FilterableFeed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new HomeFeed() - -> **new HomeFeed**(`actions`, `data`, `already_parsed`): [`HomeFeed`](HomeFeed.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`HomeFeed`](HomeFeed.md) - -#### Overrides - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`constructor`](../../Mixins/classes/FilterableFeed.md#constructors) - -#### Defined in - -[src/parser/youtube/HomeFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HomeFeed.ts#L14) - -## Properties - -### contents? - -> `optional` **contents**: [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Defined in - -[src/parser/youtube/HomeFeed.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HomeFeed.ts#L11) - -*** - -### header? - -> `optional` **header**: [`FeedTabbedHeader`](../../YTNodes/classes/FeedTabbedHeader.md) - -#### Defined in - -[src/parser/youtube/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HomeFeed.ts#L12) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`actions`](../../Mixins/classes/FilterableFeed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`channels`](../../Mixins/classes/FilterableFeed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### filter\_chips - -> `get` **filter\_chips**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -Returns the filter chips. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`filter_chips`](../../Mixins/classes/FilterableFeed.md#filter_chips) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L20) - -*** - -### filters - -> `get` **filters**(): `string`[] - -Returns available filters. - -#### Returns - -`string`[] - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`filters`](../../Mixins/classes/FilterableFeed.md#filters) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L38) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`has_continuation`](../../Mixins/classes/FilterableFeed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`memo`](../../Mixins/classes/FilterableFeed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`page`](../../Mixins/classes/FilterableFeed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`page_contents`](../../Mixins/classes/FilterableFeed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`playlists`](../../Mixins/classes/FilterableFeed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`posts`](../../Mixins/classes/FilterableFeed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`secondary_contents`](../../Mixins/classes/FilterableFeed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`shelves`](../../Mixins/classes/FilterableFeed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`videos`](../../Mixins/classes/FilterableFeed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### applyFilter() - -> **applyFilter**(`filter`): `Promise`\<[`HomeFeed`](HomeFeed.md)\> - -Applies given filter to the feed. Use [filters](FilteredChannelList.md#filters) to get available filters. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -Filter to apply. - -#### Returns - -`Promise`\<[`HomeFeed`](HomeFeed.md)\> - -#### Defined in - -[src/parser/youtube/HomeFeed.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HomeFeed.ts#L24) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`HomeFeed`](HomeFeed.md)\> - -Retrieves next batch of contents. - -#### Returns - -`Promise`\<[`HomeFeed`](HomeFeed.md)\> - -#### Overrides - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getContinuation`](../../Mixins/classes/FilterableFeed.md#getcontinuation) - -#### Defined in - -[src/parser/youtube/HomeFeed.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/HomeFeed.ts#L32) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getContinuationData`](../../Mixins/classes/FilterableFeed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getFilteredFeed() - -> **getFilteredFeed**(`filter`): `Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -Applies given filter and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Returns - -`Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getFilteredFeed`](../../Mixins/classes/FilterableFeed.md#getfilteredfeed) - -#### Defined in - -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/FilterableFeed.ts#L45) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getShelf`](../../Mixins/classes/FilterableFeed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/FilterableFeed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`FilterableFeed`](../../Mixins/classes/FilterableFeed.md).[`getVideosFromMemo`](../../Mixins/classes/FilterableFeed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/ItemMenu.md b/docs/api/namespaces/YT/classes/ItemMenu.md deleted file mode 100644 index f8e164cf..00000000 --- a/docs/api/namespaces/YT/classes/ItemMenu.md +++ /dev/null @@ -1,87 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / ItemMenu - -# Class: ItemMenu - -## Constructors - -### new ItemMenu() - -> **new ItemMenu**(`data`, `actions`): [`ItemMenu`](ItemMenu.md) - -#### Parameters - -• **data**: [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`ItemMenu`](ItemMenu.md) - -#### Defined in - -[src/parser/youtube/ItemMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/ItemMenu.ts#L16) - -## Methods - -### items() - -> **items**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/youtube/ItemMenu.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/ItemMenu.ts#L59) - -*** - -### page() - -> **page**(): [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -#### Returns - -[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -#### Defined in - -[src/parser/youtube/ItemMenu.ts:63](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/ItemMenu.ts#L63) - -*** - -### selectItem() - -#### selectItem(icon_type) - -> **selectItem**(`icon_type`): `Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\> - -##### Parameters - -• **icon\_type**: `string` - -##### Returns - -`Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\> - -##### Defined in - -[src/parser/youtube/ItemMenu.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/ItemMenu.ts#L28) - -#### selectItem(button) - -> **selectItem**(`button`): `Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\> - -##### Parameters - -• **button**: [`Button`](../../YTNodes/classes/Button.md) - -##### Returns - -`Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\> - -##### Defined in - -[src/parser/youtube/ItemMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/ItemMenu.ts#L29) diff --git a/docs/api/namespaces/YT/classes/Library.md b/docs/api/namespaces/YT/classes/Library.md deleted file mode 100644 index af3c743e..00000000 --- a/docs/api/namespaces/YT/classes/Library.md +++ /dev/null @@ -1,449 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / Library - -# Class: Library - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new Library() - -> **new Library**(`actions`, `data`): [`Library`](Library.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`Library`](Library.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/youtube/Library.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L17) - -## Properties - -### header - -> **header**: `null` \| [`PageHeader`](../../YTNodes/classes/PageHeader.md) - -#### Defined in - -[src/parser/youtube/Library.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L14) - -*** - -### sections - -> **sections**: `object`[] - -#### Defined in - -[src/parser/youtube/Library.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L15) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### clips - -> `get` **clips**(): `undefined` \| `object` - -#### Returns - -`undefined` \| `object` - -#### Defined in - -[src/parser/youtube/Library.ts:76](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L76) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### history - -> `get` **history**(): `undefined` \| `object` - -#### Returns - -`undefined` \| `object` - -#### Defined in - -[src/parser/youtube/Library.ts:60](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L60) - -*** - -### liked\_videos - -> `get` **liked\_videos**(): `undefined` \| `object` - -#### Returns - -`undefined` \| `object` - -#### Defined in - -[src/parser/youtube/Library.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L68) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### playlists\_section - -> `get` **playlists\_section**(): `undefined` \| `object` - -#### Returns - -`undefined` \| `object` - -#### Defined in - -[src/parser/youtube/Library.ts:72](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L72) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -*** - -### watch\_later - -> `get` **watch\_later**(): `undefined` \| `object` - -#### Returns - -`undefined` \| `object` - -#### Defined in - -[src/parser/youtube/Library.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Library.ts#L64) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/core/mixins/Feed.ts:219](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L219) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/LiveChat.md b/docs/api/namespaces/YT/classes/LiveChat.md deleted file mode 100644 index 2ed09a94..00000000 --- a/docs/api/namespaces/YT/classes/LiveChat.md +++ /dev/null @@ -1,565 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / LiveChat - -# Class: LiveChat - -## Extends - -- [`EventEmitter`](../../../classes/EventEmitter.md) - -## Constructors - -### new LiveChat() - -> **new LiveChat**(`video_info`): [`LiveChat`](LiveChat.md) - -#### Parameters - -• **video\_info**: [`VideoInfo`](VideoInfo.md) - -#### Returns - -[`LiveChat`](LiveChat.md) - -#### Overrides - -[`EventEmitter`](../../../classes/EventEmitter.md).[`constructor`](../../../classes/EventEmitter.md#constructors) - -#### Defined in - -[src/parser/youtube/LiveChat.ts:73](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L73) - -## Properties - -### initial\_info? - -> `optional` **initial\_info**: [`LiveChatContinuation`](../../../classes/LiveChatContinuation.md) - -#### Defined in - -[src/parser/youtube/LiveChat.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L68) - -*** - -### is\_replay - -> **is\_replay**: `boolean` = `false` - -#### Defined in - -[src/parser/youtube/LiveChat.ts:71](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L71) - -*** - -### metadata? - -> `optional` **metadata**: `LiveMetadata` - -#### Defined in - -[src/parser/youtube/LiveChat.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L69) - -*** - -### running - -> **running**: `boolean` = `false` - -#### Defined in - -[src/parser/youtube/LiveChat.ts:70](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L70) - -*** - -### smoothed\_queue - -> **smoothed\_queue**: [`SmoothedQueue`](SmoothedQueue.md) - -#### Defined in - -[src/parser/youtube/LiveChat.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L67) - -## Methods - -### addEventListener() - -> **addEventListener**(`type`, `callback`, `options`?): `void` - -Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched. - -The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture. - -When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET. - -When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners. - -When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed. - -If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted. - -The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener) - -#### Parameters - -• **type**: `string` - -• **callback**: `null` \| `EventListenerOrEventListenerObject` - -• **options?**: `boolean` \| `AddEventListenerOptions` - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](../../../classes/EventEmitter.md).[`addEventListener`](../../../classes/EventEmitter.md#addeventlistener) - -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8256 - -*** - -### applyFilter() - -> **applyFilter**(`filter`): `void` - -Applies given filter to the live chat. - -#### Parameters - -• **filter**: `"TOP_CHAT"` \| `"LIVE_CHAT"` - -Filter to apply. - -#### Returns - -`void` - -#### Defined in - -[src/parser/youtube/LiveChat.ts:287](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L287) - -*** - -### dispatchEvent() - -> **dispatchEvent**(`event`): `boolean` - -Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) - -#### Parameters - -• **event**: `Event` - -#### Returns - -`boolean` - -#### Inherited from - -[`EventEmitter`](../../../classes/EventEmitter.md).[`dispatchEvent`](../../../classes/EventEmitter.md#dispatchevent) - -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8262 - -*** - -### emit() - -> **emit**(`type`, ...`args`): `void` - -#### Parameters - -• **type**: `string` - -• ...**args**: `any`[] - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](../../../classes/EventEmitter.md).[`emit`](../../../classes/EventEmitter.md#emit) - -#### Defined in - -[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L10) - -*** - -### getItemMenu() - -> **getItemMenu**(`item`): `Promise`\<[`ItemMenu`](ItemMenu.md)\> - -Retrieves given chat item's menu. - -#### Parameters - -• **item**: `ChatItemWithMenu` - -#### Returns - -`Promise`\<[`ItemMenu`](ItemMenu.md)\> - -#### Defined in - -[src/parser/youtube/LiveChat.ts:305](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L305) - -*** - -### off() - -> **off**(`type`, `listener`): `void` - -#### Parameters - -• **type**: `string` - -• **listener** - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](../../../classes/EventEmitter.md).[`off`](../../../classes/EventEmitter.md#off) - -#### Defined in - -[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/utils/EventEmitterLike.ts#L40) - -*** - -### on() - -#### on(type, listener) - -> **on**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"start"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -[`EventEmitter`](../../../classes/EventEmitter.md).[`on`](../../../classes/EventEmitter.md#on) - -##### Defined in - -[src/parser/youtube/LiveChat.ts:108](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L108) - -#### on(type, listener) - -> **on**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"chat-update"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.on` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:109](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L109) - -#### on(type, listener) - -> **on**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"metadata-update"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.on` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:110](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L110) - -#### on(type, listener) - -> **on**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"error"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.on` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:111](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L111) - -#### on(type, listener) - -> **on**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"end"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.on` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L112) - -*** - -### once() - -#### once(type, listener) - -> **once**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"start"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -[`EventEmitter`](../../../classes/EventEmitter.md).[`once`](../../../classes/EventEmitter.md#once) - -##### Defined in - -[src/parser/youtube/LiveChat.ts:117](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L117) - -#### once(type, listener) - -> **once**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"chat-update"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.once` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:118](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L118) - -#### once(type, listener) - -> **once**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"metadata-update"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.once` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L119) - -#### once(type, listener) - -> **once**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"error"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.once` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:120](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L120) - -#### once(type, listener) - -> **once**(`type`, `listener`): `void` - -##### Parameters - -• **type**: `"end"` - -• **listener** - -##### Returns - -`void` - -##### Overrides - -`EventEmitter.once` - -##### Defined in - -[src/parser/youtube/LiveChat.ts:121](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L121) - -*** - -### removeEventListener() - -> **removeEventListener**(`type`, `callback`, `options`?): `void` - -Removes the event listener in target's event listener list with the same type, callback, and options. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener) - -#### Parameters - -• **type**: `string` - -• **callback**: `null` \| `EventListenerOrEventListenerObject` - -• **options?**: `boolean` \| `EventListenerOptions` - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](../../../classes/EventEmitter.md).[`removeEventListener`](../../../classes/EventEmitter.md#removeeventlistener) - -#### Defined in - -node\_modules/typescript/lib/lib.dom.d.ts:8268 - -*** - -### selectButton() - -> **selectButton**(`button`): `Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\> - -Equivalent to "clicking" a button. - -#### Parameters - -• **button**: [`Button`](../../YTNodes/classes/Button.md) - -#### Returns - -`Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\> - -#### Defined in - -[src/parser/youtube/LiveChat.ts:320](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L320) - -*** - -### sendMessage() - -> **sendMessage**(`text`): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`RunAttestationCommand`](../../YTNodes/classes/RunAttestationCommand.md) \| [`AddChatItemAction`](../../YTNodes/classes/AddChatItemAction.md)\>\> - -Sends a message. - -#### Parameters - -• **text**: `string` - -Text to send. - -#### Returns - -`Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`RunAttestationCommand`](../../YTNodes/classes/RunAttestationCommand.md) \| [`AddChatItemAction`](../../YTNodes/classes/AddChatItemAction.md)\>\> - -#### Defined in - -[src/parser/youtube/LiveChat.ts:255](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L255) - -*** - -### start() - -> **start**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/parser/youtube/LiveChat.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L126) - -*** - -### stop() - -> **stop**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/parser/youtube/LiveChat.ts:134](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/LiveChat.ts#L134) diff --git a/docs/api/namespaces/YT/classes/NotificationsMenu.md b/docs/api/namespaces/YT/classes/NotificationsMenu.md deleted file mode 100644 index c35ae5d1..00000000 --- a/docs/api/namespaces/YT/classes/NotificationsMenu.md +++ /dev/null @@ -1,71 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / NotificationsMenu - -# Class: NotificationsMenu - -## Constructors - -### new NotificationsMenu() - -> **new NotificationsMenu**(`actions`, `response`): [`NotificationsMenu`](NotificationsMenu.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -#### Returns - -[`NotificationsMenu`](NotificationsMenu.md) - -#### Defined in - -[src/parser/youtube/NotificationsMenu.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/NotificationsMenu.ts#L18) - -## Properties - -### contents - -> **contents**: [`Notification`](../../YTNodes/classes/Notification.md)[] - -#### Defined in - -[src/parser/youtube/NotificationsMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/NotificationsMenu.ts#L16) - -*** - -### header - -> **header**: [`SimpleMenuHeader`](../../YTNodes/classes/SimpleMenuHeader.md) - -#### Defined in - -[src/parser/youtube/NotificationsMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/NotificationsMenu.ts#L15) - -## Accessors - -### page - -> `get` **page**(): [`IGetNotificationsMenuResponse`](../../APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md) - -#### Returns - -[`IGetNotificationsMenuResponse`](../../APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md) - -#### Defined in - -[src/parser/youtube/NotificationsMenu.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/NotificationsMenu.ts#L40) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`NotificationsMenu`](NotificationsMenu.md)\> - -#### Returns - -`Promise`\<[`NotificationsMenu`](NotificationsMenu.md)\> - -#### Defined in - -[src/parser/youtube/NotificationsMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/NotificationsMenu.ts#L29) diff --git a/docs/api/namespaces/YT/classes/Playlist.md b/docs/api/namespaces/YT/classes/Playlist.md deleted file mode 100644 index 8965394d..00000000 --- a/docs/api/namespaces/YT/classes/Playlist.md +++ /dev/null @@ -1,471 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / Playlist - -# Class: Playlist - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new Playlist() - -> **new Playlist**(`actions`, `data`, `already_parsed`): [`Playlist`](Playlist.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`Playlist`](Playlist.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/youtube/Playlist.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L32) - -## Properties - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/youtube/Playlist.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L29) - -*** - -### info - -> **info**: `object` - -#### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### can\_delete - -> **can\_delete**: `boolean` = `header.can_delete` - -#### can\_reorder - -> **can\_reorder**: `boolean` = `video_list.can_reorder` - -#### can\_share - -> **can\_share**: `boolean` = `header.can_share` - -#### description? - -> `optional` **description**: `string` - -#### is\_editable - -> **is\_editable**: `boolean` = `video_list.is_editable` - -#### last\_updated - -> **last\_updated**: `string` - -#### privacy - -> **privacy**: `string` = `header.privacy` - -#### subtitle - -> **subtitle**: `null` \| [`Text`](../../Misc/classes/Text.md) - -#### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### title? - -> `optional` **title**: `string` - -#### total\_items - -> **total\_items**: `string` - -#### type? - -> `readonly` `optional` **type**: `string` - -#### views - -> **views**: `string` - -#### Defined in - -[src/parser/youtube/Playlist.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L27) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/youtube/Playlist.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L28) - -*** - -### messages - -> **messages**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Message`](../../YTNodes/classes/Message.md)\> - -#### Defined in - -[src/parser/youtube/Playlist.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L30) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/parser/youtube/Playlist.ts:73](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L73) - -*** - -### items - -> `get` **items**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md)\> - -#### Defined in - -[src/parser/youtube/Playlist.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L69) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Playlist`](Playlist.md)\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`Playlist`](Playlist.md)\> - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/parser/youtube/Playlist.ts:101](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L101) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/parser/youtube/Playlist.ts:82](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Playlist.ts#L82) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/Search.md b/docs/api/namespaces/YT/classes/Search.md deleted file mode 100644 index d6bd5d39..00000000 --- a/docs/api/namespaces/YT/classes/Search.md +++ /dev/null @@ -1,467 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / Search - -# Class: Search - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\> - -## Constructors - -### new Search() - -> **new Search**(`actions`, `data`, `already_parsed`): [`Search`](Search.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`Search`](Search.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/youtube/Search.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L28) - -## Properties - -### estimated\_results - -> **estimated\_results**: `number` - -#### Defined in - -[src/parser/youtube/Search.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L23) - -*** - -### header? - -> `optional` **header**: [`SearchHeader`](../../YTNodes/classes/SearchHeader.md) - -#### Defined in - -[src/parser/youtube/Search.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L20) - -*** - -### refinement\_cards? - -> `optional` **refinement\_cards**: `null` \| [`HorizontalCardList`](../../YTNodes/classes/HorizontalCardList.md) - -#### Defined in - -[src/parser/youtube/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L26) - -*** - -### refinements - -> **refinements**: `string`[] - -#### Defined in - -[src/parser/youtube/Search.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L22) - -*** - -### results - -> **results**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/youtube/Search.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L21) - -*** - -### sub\_menu? - -> `optional` **sub\_menu**: [`SearchSubMenu`](../../YTNodes/classes/SearchSubMenu.md) - -#### Defined in - -[src/parser/youtube/Search.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L24) - -*** - -### watch\_card? - -> `optional` **watch\_card**: [`UniversalWatchCard`](../../YTNodes/classes/UniversalWatchCard.md) - -#### Defined in - -[src/parser/youtube/Search.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L25) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### refinement\_card\_queries - -> `get` **refinement\_card\_queries**(): `string`[] - -Returns a list of refinement card queries. - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/Search.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L81) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Search`](Search.md)\> - -Retrieves next batch of search results. - -#### Returns - -`Promise`\<[`Search`](Search.md)\> - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/parser/youtube/Search.ts:88](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L88) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### selectRefinementCard() - -> **selectRefinementCard**(`card`): `Promise`\<[`Search`](Search.md)\> - -Applies given refinement card and returns a new [Search](Search.md) object. Use [refinement_card_queries](Search.md#refinement_card_queries) to get a list of available refinement cards. - -#### Parameters - -• **card**: `string` \| [`SearchRefinementCard`](../../YTNodes/classes/SearchRefinementCard.md) - -#### Returns - -`Promise`\<[`Search`](Search.md)\> - -#### Defined in - -[src/parser/youtube/Search.ts:57](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Search.ts#L57) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YT/classes/Settings.md b/docs/api/namespaces/YT/classes/Settings.md deleted file mode 100644 index 6282c077..00000000 --- a/docs/api/namespaces/YT/classes/Settings.md +++ /dev/null @@ -1,139 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / Settings - -# Class: Settings - -## Constructors - -### new Settings() - -> **new Settings**(`actions`, `response`): [`Settings`](Settings.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -#### Returns - -[`Settings`](Settings.md) - -#### Defined in - -[src/parser/youtube/Settings.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L27) - -## Properties - -### introduction? - -> `optional` **introduction**: [`PageIntroduction`](../../YTNodes/classes/PageIntroduction.md) - -#### Defined in - -[src/parser/youtube/Settings.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L24) - -*** - -### sections - -> **sections**: `undefined` \| `object`[] - -#### Defined in - -[src/parser/youtube/Settings.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L25) - -*** - -### sidebar? - -> `optional` **sidebar**: [`SettingsSidebar`](../../YTNodes/classes/SettingsSidebar.md) - -#### Defined in - -[src/parser/youtube/Settings.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L23) - -## Accessors - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/youtube/Settings.ts:131](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L131) - -*** - -### setting\_options - -> `get` **setting\_options**(): `string`[] - -Returns settings available in the page. - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/Settings.ts:104](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L104) - -*** - -### sidebar\_items - -> `get` **sidebar\_items**(): `string`[] - -Returns options available in the sidebar. - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/Settings.ts:124](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L124) - -## Methods - -### getSettingOption() - -> **getSettingOption**(`name`): [`SettingsSwitch`](../../YTNodes/classes/SettingsSwitch.md) - -Finds a setting by name and returns it. Use [setting_options](Settings.md#setting_options) to see available options. - -#### Parameters - -• **name**: `string` - -#### Returns - -[`SettingsSwitch`](../../YTNodes/classes/SettingsSwitch.md) - -#### Defined in - -[src/parser/youtube/Settings.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L78) - -*** - -### selectSidebarItem() - -> **selectSidebarItem**(`target_item`): `Promise`\<[`Settings`](Settings.md)\> - -Selects an item from the sidebar menu. Use [sidebar_items](Settings.md#sidebar_items) to see available items. - -#### Parameters - -• **target\_item**: `string` \| [`CompactLink`](../../YTNodes/classes/CompactLink.md) - -#### Returns - -`Promise`\<[`Settings`](Settings.md)\> - -#### Defined in - -[src/parser/youtube/Settings.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/Settings.ts#L54) diff --git a/docs/api/namespaces/YT/classes/SmoothedQueue.md b/docs/api/namespaces/YT/classes/SmoothedQueue.md deleted file mode 100644 index d16d16ba..00000000 --- a/docs/api/namespaces/YT/classes/SmoothedQueue.md +++ /dev/null @@ -1,153 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / SmoothedQueue - -# Class: SmoothedQueue - -## Constructors - -### new SmoothedQueue() - -> **new SmoothedQueue**(): [`SmoothedQueue`](SmoothedQueue.md) - -#### Returns - -[`SmoothedQueue`](SmoothedQueue.md) - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L55) - -## Accessors - -### action\_queue - -> `get` **action\_queue**(): [`YTNode`](../../Helpers/classes/YTNode.md)[][] - -#### Returns - -[`YTNode`](../../Helpers/classes/YTNode.md)[][] - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:141](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L141) - -*** - -### callback - -> `get` **callback**(): `null` \| (`actions`) => `void` - -> `set` **callback**(`cb`): `void` - -#### Parameters - -• **cb**: `null` \| (`actions`) => `void` - -#### Returns - -`null` \| (`actions`) => `void` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L137) - -*** - -### estimated\_update\_interval - -> `get` **estimated\_update\_interval**(): `null` \| `number` - -#### Returns - -`null` \| `number` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:145](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L145) - -*** - -### last\_update\_time - -> `get` **last\_update\_time**(): `null` \| `number` - -#### Returns - -`null` \| `number` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:149](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L149) - -*** - -### next\_update\_id - -> `get` **next\_update\_id**(): `any` - -#### Returns - -`any` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:153](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L153) - -*** - -### poll\_response\_delay\_queue - -> `get` **poll\_response\_delay\_queue**(): `DelayQueue` - -#### Returns - -`DelayQueue` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:157](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L157) - -## Methods - -### clear() - -> **clear**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:125](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L125) - -*** - -### emitSmoothedActions() - -> **emitSmoothedActions**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:92](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L92) - -*** - -### enqueueActionGroup() - -> **enqueueActionGroup**(`group`): `void` - -#### Parameters - -• **group**: [`YTNode`](../../Helpers/classes/YTNode.md)[] - -#### Returns - -`void` - -#### Defined in - -[src/parser/youtube/SmoothedQueue.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/SmoothedQueue.ts#L64) diff --git a/docs/api/namespaces/YT/classes/TranscriptInfo.md b/docs/api/namespaces/YT/classes/TranscriptInfo.md deleted file mode 100644 index 5184f4f8..00000000 --- a/docs/api/namespaces/YT/classes/TranscriptInfo.md +++ /dev/null @@ -1,101 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / TranscriptInfo - -# Class: TranscriptInfo - -## Constructors - -### new TranscriptInfo() - -> **new TranscriptInfo**(`actions`, `response`): [`TranscriptInfo`](TranscriptInfo.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -#### Returns - -[`TranscriptInfo`](TranscriptInfo.md) - -#### Defined in - -[src/parser/youtube/TranscriptInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/TranscriptInfo.ts#L12) - -## Properties - -### transcript - -> **transcript**: [`Transcript`](../../YTNodes/classes/Transcript.md) - -#### Defined in - -[src/parser/youtube/TranscriptInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/TranscriptInfo.ts#L10) - -## Accessors - -### languages - -> `get` **languages**(): `string`[] - -Returns available languages. - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/TranscriptInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/TranscriptInfo.ts#L45) - -*** - -### page - -> `get` **page**(): [`IGetTranscriptResponse`](../../APIResponseTypes/type-aliases/IGetTranscriptResponse.md) - -#### Returns - -[`IGetTranscriptResponse`](../../APIResponseTypes/type-aliases/IGetTranscriptResponse.md) - -#### Defined in - -[src/parser/youtube/TranscriptInfo.ts:56](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/TranscriptInfo.ts#L56) - -*** - -### selectedLanguage - -> `get` **selectedLanguage**(): `string` - -Returns the currently selected language. - -#### Returns - -`string` - -#### Defined in - -[src/parser/youtube/TranscriptInfo.ts:52](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/TranscriptInfo.ts#L52) - -## Methods - -### selectLanguage() - -> **selectLanguage**(`language`): `Promise`\<[`TranscriptInfo`](TranscriptInfo.md)\> - -Selects a language from the language menu and returns the updated transcript. - -#### Parameters - -• **language**: `string` - -Language to select. - -#### Returns - -`Promise`\<[`TranscriptInfo`](TranscriptInfo.md)\> - -#### Defined in - -[src/parser/youtube/TranscriptInfo.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/TranscriptInfo.ts#L26) diff --git a/docs/api/namespaces/YT/classes/VideoInfo.md b/docs/api/namespaces/YT/classes/VideoInfo.md deleted file mode 100644 index 9e1337f0..00000000 --- a/docs/api/namespaces/YT/classes/VideoInfo.md +++ /dev/null @@ -1,891 +0,0 @@ -[youtubei.js](../../../README.md) / [YT](../README.md) / VideoInfo - -# Class: VideoInfo - -## Extends - -- [`MediaInfo`](../../Mixins/classes/MediaInfo.md) - -## Constructors - -### new VideoInfo() - -> **new VideoInfo**(`data`, `actions`, `cpn`): [`VideoInfo`](VideoInfo.md) - -#### Parameters - -• **data**: [[`ApiResponse`](../../../interfaces/ApiResponse.md), `ApiResponse?`] - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **cpn**: `string` - -#### Returns - -[`VideoInfo`](VideoInfo.md) - -#### Overrides - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`constructor`](../../Mixins/classes/MediaInfo.md#constructors) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L54) - -## Properties - -### annotations? - -> `optional` **annotations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`annotations`](../../Mixins/classes/MediaInfo.md#annotations) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L40) - -*** - -### autoplay? - -> `optional` **autoplay**: `object` - -#### count\_down\_secs? - -> `optional` **count\_down\_secs**: `number` - -#### modified\_sets? - -> `optional` **modified\_sets**: `AutoplaySet`[] - -#### sets - -> **sets**: `AutoplaySet`[] - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L49) - -*** - -### basic\_info - -> **basic\_info**: `object` - -#### allow\_ratings? - -> `optional` **allow\_ratings**: `boolean` - -#### author? - -> `optional` **author**: `string` - -#### category - -> **category**: `null` \| `string` - -#### channel - -> **channel**: `null` \| `object` - -#### channel\_id? - -> `optional` **channel\_id**: `string` - -#### duration? - -> `optional` **duration**: `number` - -#### embed - -> **embed**: `undefined` \| `null` \| `object` - -#### end\_timestamp - -> **end\_timestamp**: `null` \| `Date` - -#### has\_ypc\_metadata - -> **has\_ypc\_metadata**: `null` \| `boolean` - -#### id? - -> `optional` **id**: `string` - -#### is\_crawlable? - -> `optional` **is\_crawlable**: `boolean` - -#### is\_disliked - -> **is\_disliked**: `undefined` \| `boolean` - -#### is\_family\_safe - -> **is\_family\_safe**: `undefined` \| `boolean` = `info.microformat.is_family_safe` - -#### is\_liked - -> **is\_liked**: `undefined` \| `boolean` - -#### is\_live? - -> `optional` **is\_live**: `boolean` - -#### is\_live\_content? - -> `optional` **is\_live\_content**: `boolean` - -#### is\_live\_dvr\_enabled? - -> `optional` **is\_live\_dvr\_enabled**: `boolean` - -#### is\_low\_latency\_live\_stream? - -> `optional` **is\_low\_latency\_live\_stream**: `boolean` - -#### is\_owner\_viewing? - -> `optional` **is\_owner\_viewing**: `boolean` - -#### is\_post\_live\_dvr? - -> `optional` **is\_post\_live\_dvr**: `boolean` - -#### is\_private? - -> `optional` **is\_private**: `boolean` - -#### is\_unlisted - -> **is\_unlisted**: `undefined` \| `boolean` = `info.microformat.is_unlisted` - -#### is\_upcoming? - -> `optional` **is\_upcoming**: `boolean` - -#### keywords? - -> `optional` **keywords**: `string`[] - -#### like\_count - -> **like\_count**: `undefined` \| `number` - -#### live\_chunk\_readahead? - -> `optional` **live\_chunk\_readahead**: `number` - -#### short\_description? - -> `optional` **short\_description**: `string` - -#### start\_timestamp - -> **start\_timestamp**: `null` \| `Date` - -#### tags - -> **tags**: `null` \| `string`[] - -#### thumbnail? - -> `optional` **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### title? - -> `optional` **title**: `string` - -#### url\_canonical - -> **url\_canonical**: `null` \| `string` - -#### view\_count - -> **view\_count**: `undefined` \| `number` - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`basic_info`](../../Mixins/classes/MediaInfo.md#basic_info) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L39) - -*** - -### captions? - -> `optional` **captions**: [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`captions`](../../Mixins/classes/MediaInfo.md#captions) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L43) - -*** - -### cards? - -> `optional` **cards**: [`CardCollection`](../../YTNodes/classes/CardCollection.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`cards`](../../Mixins/classes/MediaInfo.md#cards) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L44) - -*** - -### comments\_entry\_point\_header? - -> `optional` **comments\_entry\_point\_header**: `null` \| [`CommentsEntryPointHeader`](../../YTNodes/classes/CommentsEntryPointHeader.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L47) - -*** - -### endscreen? - -> `optional` **endscreen**: [`Endscreen`](../../YTNodes/classes/Endscreen.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`endscreen`](../../Mixins/classes/MediaInfo.md#endscreen) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L42) - -*** - -### game\_info? - -> `optional` **game\_info**: `object` - -#### release\_year - -> **release\_year**: `undefined` \| [`Text`](../../Misc/classes/Text.md) - -#### title - -> **title**: `undefined` \| [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L42) - -*** - -### heat\_map? - -> `optional` **heat\_map**: `null` \| [`Heatmap`](../../YTNodes/classes/Heatmap.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L50) - -*** - -### livechat? - -> `optional` **livechat**: `null` \| [`LiveChat`](../../YTNodes/classes/LiveChat.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:48](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L48) - -*** - -### merchandise? - -> `optional` **merchandise**: `null` \| [`MerchandiseShelf`](../../YTNodes/classes/MerchandiseShelf.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L43) - -*** - -### playability\_status? - -> `optional` **playability\_status**: [`IPlayabilityStatus`](../../APIResponseTypes/interfaces/IPlayabilityStatus.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`playability_status`](../../Mixins/classes/MediaInfo.md#playability_status) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L46) - -*** - -### player\_config? - -> `optional` **player\_config**: [`IPlayerConfig`](../../APIResponseTypes/interfaces/IPlayerConfig.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`player_config`](../../Mixins/classes/MediaInfo.md#player_config) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L47) - -*** - -### player\_overlays? - -> `optional` **player\_overlays**: `null` \| [`PlayerOverlay`](../../YTNodes/classes/PlayerOverlay.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L46) - -*** - -### playlist? - -> `optional` **playlist**: `object` - -#### author - -> **author**: [`Text`](../../Misc/classes/Text.md) \| [`Author`](../../Misc/classes/Author.md) - -#### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### current\_index - -> **current\_index**: `number` - -#### id - -> **id**: `string` - -#### is\_infinite - -> **is\_infinite**: `boolean` - -#### menu - -> **menu**: `null` \| [`Menu`](../../YTNodes/classes/Menu.md) - -#### title - -> **title**: `string` - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L41) - -*** - -### primary\_info? - -> `optional` **primary\_info**: `null` \| [`VideoPrimaryInfo`](../../YTNodes/classes/VideoPrimaryInfo.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L39) - -*** - -### related\_chip\_cloud? - -> `optional` **related\_chip\_cloud**: `null` \| [`ChipCloud`](../../YTNodes/classes/ChipCloud.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L44) - -*** - -### secondary\_info? - -> `optional` **secondary\_info**: `null` \| [`VideoSecondaryInfo`](../../YTNodes/classes/VideoSecondaryInfo.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L40) - -*** - -### storyboards? - -> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`storyboards`](../../Mixins/classes/MediaInfo.md#storyboards) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L41) - -*** - -### streaming\_data? - -> `optional` **streaming\_data**: [`IStreamingData`](../../APIResponseTypes/interfaces/IStreamingData.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`streaming_data`](../../Mixins/classes/MediaInfo.md#streaming_data) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L45) - -*** - -### watch\_next\_feed? - -> `optional` **watch\_next\_feed**: `null` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L45) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`actions`](../../Mixins/classes/MediaInfo.md#actions) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:247](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L247) - -*** - -### autoplay\_video\_endpoint - -> `get` **autoplay\_video\_endpoint**(): `null` \| [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -Gets the endpoint of the autoplay video - -#### Returns - -`null` \| [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:410](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L410) - -*** - -### cpn - -> `get` **cpn**(): `string` - -Content Playback Nonce. - -#### Returns - -`string` - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`cpn`](../../Mixins/classes/MediaInfo.md#cpn) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:254](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L254) - -*** - -### filters - -> `get` **filters**(): `string`[] - -Watch next feed filters. - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:396](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L396) - -*** - -### has\_trailer - -> `get` **has\_trailer**(): `boolean` - -Checks if trailer is available. - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:417](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L417) - -*** - -### music\_tracks - -> `get` **music\_tracks**(): `object`[] - -Get songs used in the video. - -#### Returns - -`object`[] - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:424](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L424) - -*** - -### page - -> `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] - -Parsed InnerTube response. - -#### Returns - -[[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`page`](../../Mixins/classes/MediaInfo.md#page) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:261](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L261) - -*** - -### wn\_has\_continuation - -> `get` **wn\_has\_continuation**(): `boolean` - -Checks if continuation is available for the watch next feed. - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:403](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L403) - -## Methods - -### addToWatchHistory() - -> **addToWatchHistory**(): `Promise`\<`Response`\> - -Adds video to the watch history. - -#### Returns - -`Promise`\<`Response`\> - -#### Overrides - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`addToWatchHistory`](../../Mixins/classes/MediaInfo.md#addtowatchhistory) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L195) - -*** - -### chooseFormat() - -> **chooseFormat**(`options`): [`Format`](../../Misc/classes/Format.md) - -Selects the format that best matches the given options. - -#### Parameters - -• **options**: [`FormatOptions`](../../Types/interfaces/FormatOptions.md) - -Options - -#### Returns - -[`Format`](../../Misc/classes/Format.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`chooseFormat`](../../Mixins/classes/MediaInfo.md#chooseformat) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:161](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L161) - -*** - -### dislike() - -> **dislike**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Dislikes the video. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:272](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L272) - -*** - -### download() - -> **download**(`options`): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -Downloads the video. - -#### Parameters - -• **options**: [`DownloadOptions`](../../Types/interfaces/DownloadOptions.md) = `{}` - -Download options. - -#### Returns - -`Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`download`](../../Mixins/classes/MediaInfo.md#download) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L169) - -*** - -### getLiveChat() - -> **getLiveChat**(): [`LiveChat`](LiveChat.md) - -Retrieves Live Chat if available. - -#### Returns - -[`LiveChat`](LiveChat.md) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:367](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L367) - -*** - -### getStreamingInfo() - -> **getStreamingInfo**(`url_transformer`?, `format_filter`?): `Promise`\<`StreamingInfo`\> - -Get a cleaned up representation of the adaptive_formats - -#### Parameters - -• **url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) - -• **format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) - -#### Returns - -`Promise`\<`StreamingInfo`\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`getStreamingInfo`](../../Mixins/classes/MediaInfo.md#getstreaminginfo) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L144) - -*** - -### getTrailerInfo() - -> **getTrailerInfo**(): `null` \| [`VideoInfo`](VideoInfo.md) - -Retrieves trailer info if available (typically for non-purchased movies or films). - -#### Returns - -`null` \| [`VideoInfo`](VideoInfo.md) - -`VideoInfo` for the trailer, or `null` if none. - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:377](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L377) - -*** - -### getTranscript() - -> **getTranscript**(): `Promise`\<[`TranscriptInfo`](TranscriptInfo.md)\> - -Retrieves the video's transcript. - -#### Returns - -`Promise`\<[`TranscriptInfo`](TranscriptInfo.md)\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`getTranscript`](../../Mixins/classes/MediaInfo.md#gettranscript) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:182](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L182) - -*** - -### getWatchNextContinuation() - -> **getWatchNextContinuation**(): `Promise`\<[`VideoInfo`](VideoInfo.md)\> - -Retrieves watch next feed continuation. - -#### Returns - -`Promise`\<[`VideoInfo`](VideoInfo.md)\> - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:209](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L209) - -*** - -### like() - -> **like**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Likes the video. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:232](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L232) - -*** - -### removeRating() - -> **removeRating**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Removes like/dislike. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:312](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L312) - -*** - -### selectFilter() - -> **selectFilter**(`target_filter`): `Promise`\<[`VideoInfo`](VideoInfo.md)\> - -Applies given filter to the watch next feed. Use [filters](VideoInfo.md#filters) to get available filters. - -#### Parameters - -• **target\_filter**: `undefined` \| `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -Filter to apply. - -#### Returns - -`Promise`\<[`VideoInfo`](VideoInfo.md)\> - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:161](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L161) - -*** - -### toDash() - -> **toDash**(`options`): `Promise`\<`string`\> - -Generates a DASH manifest from the streaming data. - -#### Parameters - -• **options** = `{}` - -• **options.format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) - -• **options.manifest\_options?**: `DashOptions` - -• **options.url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) - -#### Returns - -`Promise`\<`string`\> - -DASH manifest - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`toDash`](../../Mixins/classes/MediaInfo.md#todash) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:104](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L104) - -*** - -### updateWatchTime() - -> **updateWatchTime**(`startTime`): `Promise`\<`Response`\> - -Updates watch time for the video. - -#### Parameters - -• **startTime**: `number` - -#### Returns - -`Promise`\<`Response`\> - -#### Overrides - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`updateWatchTime`](../../Mixins/classes/MediaInfo.md#updatewatchtime) - -#### Defined in - -[src/parser/youtube/VideoInfo.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/youtube/VideoInfo.ts#L202) diff --git a/docs/api/namespaces/YTKids/classes/Channel.md b/docs/api/namespaces/YTKids/classes/Channel.md deleted file mode 100644 index db31d995..00000000 --- a/docs/api/namespaces/YTKids/classes/Channel.md +++ /dev/null @@ -1,381 +0,0 @@ -[youtubei.js](../../../README.md) / [YTKids](../README.md) / Channel - -# Class: Channel - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new Channel() - -> **new Channel**(`actions`, `data`, `already_parsed`): [`Channel`](Channel.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`Channel`](Channel.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/ytkids/Channel.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Channel.ts#L14) - -## Properties - -### contents? - -> `optional` **contents**: [`ItemSection`](../../YTNodes/classes/ItemSection.md) \| [`ItemSectionContinuation`](../../../classes/ItemSectionContinuation.md) - -#### Defined in - -[src/parser/ytkids/Channel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Channel.ts#L12) - -*** - -### header? - -> `optional` **header**: [`C4TabbedHeader`](../../YTNodes/classes/C4TabbedHeader.md) - -#### Defined in - -[src/parser/ytkids/Channel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Channel.ts#L11) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/parser/ytkids/Channel.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Channel.ts#L39) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Channel`](Channel.md)\> - -Retrieves next batch of content. - -#### Returns - -`Promise`\<[`Channel`](Channel.md)\> - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/parser/ytkids/Channel.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Channel.ts#L23) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YTKids/classes/HomeFeed.md b/docs/api/namespaces/YTKids/classes/HomeFeed.md deleted file mode 100644 index d24834ce..00000000 --- a/docs/api/namespaces/YTKids/classes/HomeFeed.md +++ /dev/null @@ -1,417 +0,0 @@ -[youtubei.js](../../../README.md) / [YTKids](../README.md) / HomeFeed - -# Class: HomeFeed - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -## Constructors - -### new HomeFeed() - -> **new HomeFeed**(`actions`, `data`, `already_parsed`): [`HomeFeed`](HomeFeed.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -• **already\_parsed**: `boolean` = `false` - -#### Returns - -[`HomeFeed`](HomeFeed.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/ytkids/HomeFeed.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/HomeFeed.ts#L15) - -## Properties - -### contents? - -> `optional` **contents**: [`KidsHomeScreen`](../../YTNodes/classes/KidsHomeScreen.md) - -#### Defined in - -[src/parser/ytkids/HomeFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/HomeFeed.ts#L13) - -*** - -### header? - -> `optional` **header**: [`KidsCategoriesHeader`](../../YTNodes/classes/KidsCategoriesHeader.md) - -#### Defined in - -[src/parser/ytkids/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/HomeFeed.ts#L12) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### categories - -> `get` **categories**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/ytkids/HomeFeed.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/HomeFeed.ts#L46) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/core/mixins/Feed.ts:219](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L219) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### selectCategoryTab() - -> **selectCategoryTab**(`tab`): `Promise`\<[`HomeFeed`](HomeFeed.md)\> - -Retrieves the contents of the given category tab. Use [HomeFeed.categories](HomeFeed.md#categories) to get a list of available categories. - -#### Parameters - -• **tab**: `string` \| [`KidsCategoryTab`](../../YTNodes/classes/KidsCategoryTab.md) - -The tab to select - -#### Returns - -`Promise`\<[`HomeFeed`](HomeFeed.md)\> - -#### Defined in - -[src/parser/ytkids/HomeFeed.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/HomeFeed.ts#L25) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YTKids/classes/Search.md b/docs/api/namespaces/YTKids/classes/Search.md deleted file mode 100644 index de1185f6..00000000 --- a/docs/api/namespaces/YTKids/classes/Search.md +++ /dev/null @@ -1,379 +0,0 @@ -[youtubei.js](../../../README.md) / [YTKids](../README.md) / Search - -# Class: Search - -## Extends - -- [`Feed`](../../Mixins/classes/Feed.md)\<[`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\> - -## Constructors - -### new Search() - -> **new Search**(`actions`, `data`): [`Search`](Search.md) - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md) - -#### Returns - -[`Search`](Search.md) - -#### Overrides - -[`Feed`](../../Mixins/classes/Feed.md).[`constructor`](../../Mixins/classes/Feed.md#constructors) - -#### Defined in - -[src/parser/ytkids/Search.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Search.ts#L13) - -## Properties - -### contents - -> **contents**: `null` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/ytkids/Search.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Search.ts#L11) - -*** - -### estimated\_results? - -> `optional` **estimated\_results**: `number` - -#### Defined in - -[src/parser/ytkids/Search.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytkids/Search.ts#L10) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`actions`](../../Mixins/classes/Feed.md#actions) - -#### Defined in - -[src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L181) - -*** - -### channels - -> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -Get all the channels in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`channels`](../../Mixins/classes/Feed.md#channels) - -#### Defined in - -[src/core/mixins/Feed.ts:126](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L126) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -Checks if the feed has continuation. - -#### Returns - -`boolean` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`has_continuation`](../../Mixins/classes/Feed.md#has_continuation) - -#### Defined in - -[src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L195) - -*** - -### memo - -> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`Memo`](../../Helpers/classes/Memo.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`memo`](../../Mixins/classes/Feed.md#memo) - -#### Defined in - -[src/core/mixins/Feed.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L137) - -*** - -### page - -> `get` **page**(): `T` - -Get the original page data - -#### Returns - -`T` - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page`](../../Mixins/classes/Feed.md#page) - -#### Defined in - -[src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L188) - -*** - -### page\_contents - -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -Returns contents from the page. - -#### Returns - -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`page_contents`](../../Mixins/classes/Feed.md#page_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L144) - -*** - -### playlists - -> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`playlists`](../../Mixins/classes/Feed.md#playlists) - -#### Defined in - -[src/core/mixins/Feed.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L133) - -*** - -### posts - -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -Get all the community posts in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`posts`](../../Mixins/classes/Feed.md#posts) - -#### Defined in - -[src/core/mixins/Feed.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L119) - -*** - -### secondary\_contents - -> `get` **secondary\_contents**(): `null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -Returns secondary contents from the page. - -#### Returns - -`null` \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`secondary_contents`](../../Mixins/classes/Feed.md#secondary_contents) - -#### Defined in - -[src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L169) - -*** - -### shelves - -> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -Returns all segments/sections from the page. - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`shelves`](../../Mixins/classes/Feed.md#shelves) - -#### Defined in - -[src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L155) - -*** - -### videos - -> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all the videos in the feed - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`videos`](../../Mixins/classes/Feed.md#videos) - -#### Defined in - -[src/core/mixins/Feed.ts:112](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L112) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\>\> - -Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/Feed.md) object. - -#### Returns - -`Promise`\<[`Feed`](../../Mixins/classes/Feed.md)\<[`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\>\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuation`](../../Mixins/classes/Feed.md#getcontinuation) - -#### Defined in - -[src/core/mixins/Feed.ts:219](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L219) - -*** - -### getContinuationData() - -> **getContinuationData**(): `Promise`\<`undefined` \| [`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\> - -Retrieves continuation data as it is. - -#### Returns - -`Promise`\<`undefined` \| [`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getContinuationData`](../../Mixins/classes/Feed.md#getcontinuationdata) - -#### Defined in - -[src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L202) - -*** - -### getShelf() - -> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -Finds shelf by title. - -#### Parameters - -• **title**: `string` - -#### Returns - -`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getShelf`](../../Mixins/classes/Feed.md#getshelf) - -#### Defined in - -[src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L162) - -*** - -### getPlaylistsFromMemo() - -> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -Get all playlists on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getPlaylistsFromMemo`](../../Mixins/classes/Feed.md#getplaylistsfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L94) - -*** - -### getVideosFromMemo() - -> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -Get all videos on a given page via memo - -#### Parameters - -• **memo**: [`Memo`](../../Helpers/classes/Memo.md) - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\> - -#### Inherited from - -[`Feed`](../../Mixins/classes/Feed.md).[`getVideosFromMemo`](../../Mixins/classes/Feed.md#getvideosfrommemo) - -#### Defined in - -[src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/Feed.ts#L78) diff --git a/docs/api/namespaces/YTMusic/classes/Album.md b/docs/api/namespaces/YTMusic/classes/Album.md deleted file mode 100644 index 7b0c477d..00000000 --- a/docs/api/namespaces/YTMusic/classes/Album.md +++ /dev/null @@ -1,85 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Album - -# Class: Album - -## Constructors - -### new Album() - -> **new Album**(`response`): [`Album`](Album.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -#### Returns - -[`Album`](Album.md) - -#### Defined in - -[src/parser/ytmusic/Album.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Album.ts#L24) - -## Properties - -### background? - -> `optional` **background**: [`MusicThumbnail`](../../YTNodes/classes/MusicThumbnail.md) - -#### Defined in - -[src/parser/ytmusic/Album.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Album.ts#L21) - -*** - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\> - -#### Defined in - -[src/parser/ytmusic/Album.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Album.ts#L19) - -*** - -### header? - -> `optional` **header**: [`MusicDetailHeader`](../../YTNodes/classes/MusicDetailHeader.md) \| [`MusicResponsiveHeader`](../../YTNodes/classes/MusicResponsiveHeader.md) - -#### Defined in - -[src/parser/ytmusic/Album.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Album.ts#L18) - -*** - -### sections - -> **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Album.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Album.ts#L20) - -*** - -### url? - -> `optional` **url**: `string` - -#### Defined in - -[src/parser/ytmusic/Album.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Album.ts#L22) - -## Accessors - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/Album.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Album.ts#L37) diff --git a/docs/api/namespaces/YTMusic/classes/Artist.md b/docs/api/namespaces/YTMusic/classes/Artist.md deleted file mode 100644 index 2b39401c..00000000 --- a/docs/api/namespaces/YTMusic/classes/Artist.md +++ /dev/null @@ -1,71 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Artist - -# Class: Artist - -## Constructors - -### new Artist() - -> **new Artist**(`response`, `actions`): [`Artist`](Artist.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Artist`](Artist.md) - -#### Defined in - -[src/parser/ytmusic/Artist.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Artist.ts#L23) - -## Properties - -### header? - -> `optional` **header**: [`MusicImmersiveHeader`](../../YTNodes/classes/MusicImmersiveHeader.md) \| [`MusicVisualHeader`](../../YTNodes/classes/MusicVisualHeader.md) \| [`MusicHeader`](../../YTNodes/classes/MusicHeader.md) - -#### Defined in - -[src/parser/ytmusic/Artist.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Artist.ts#L20) - -*** - -### sections - -> **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md) \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Artist.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Artist.ts#L21) - -## Accessors - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/Artist.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Artist.ts#L53) - -## Methods - -### getAllSongs() - -> **getAllSongs**(): `Promise`\<`undefined` \| [`MusicPlaylistShelf`](../../YTNodes/classes/MusicPlaylistShelf.md)\> - -#### Returns - -`Promise`\<`undefined` \| [`MusicPlaylistShelf`](../../YTNodes/classes/MusicPlaylistShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Artist.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Artist.ts#L35) diff --git a/docs/api/namespaces/YTMusic/classes/Explore.md b/docs/api/namespaces/YTMusic/classes/Explore.md deleted file mode 100644 index cae77073..00000000 --- a/docs/api/namespaces/YTMusic/classes/Explore.md +++ /dev/null @@ -1,55 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Explore - -# Class: Explore - -## Constructors - -### new Explore() - -> **new Explore**(`response`): [`Explore`](Explore.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -#### Returns - -[`Explore`](Explore.md) - -#### Defined in - -[src/parser/ytmusic/Explore.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Explore.ts#L20) - -## Properties - -### sections - -> **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Explore.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Explore.ts#L18) - -*** - -### top\_buttons - -> **top\_buttons**: [`MusicNavigationButton`](../../YTNodes/classes/MusicNavigationButton.md)[] - -#### Defined in - -[src/parser/ytmusic/Explore.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Explore.ts#L17) - -## Accessors - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/Explore.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Explore.ts#L37) diff --git a/docs/api/namespaces/YTMusic/classes/HomeFeed.md b/docs/api/namespaces/YTMusic/classes/HomeFeed.md deleted file mode 100644 index d678d560..00000000 --- a/docs/api/namespaces/YTMusic/classes/HomeFeed.md +++ /dev/null @@ -1,119 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / HomeFeed - -# Class: HomeFeed - -## Constructors - -### new HomeFeed() - -> **new HomeFeed**(`response`, `actions`): [`HomeFeed`](HomeFeed.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`HomeFeed`](HomeFeed.md) - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L22) - -## Properties - -### header? - -> `optional` **header**: [`ChipCloud`](../../YTNodes/classes/ChipCloud.md) - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L20) - -*** - -### sections? - -> `optional` **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md) \| [`MusicTastebuilderShelf`](../../YTNodes/classes/MusicTastebuilderShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L19) - -## Accessors - -### filters - -> `get` **filters**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:84](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L84) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:88](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L88) - -*** - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:92](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L92) - -## Methods - -### applyFilter() - -> **applyFilter**(`target_filter`): `Promise`\<[`HomeFeed`](HomeFeed.md)\> - -#### Parameters - -• **target\_filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Returns - -`Promise`\<[`HomeFeed`](HomeFeed.md)\> - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:61](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L61) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`HomeFeed`](HomeFeed.md)\> - -Retrieves home feed continuation. - -#### Returns - -`Promise`\<[`HomeFeed`](HomeFeed.md)\> - -#### Defined in - -[src/parser/ytmusic/HomeFeed.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/HomeFeed.ts#L49) diff --git a/docs/api/namespaces/YTMusic/classes/Library.md b/docs/api/namespaces/YTMusic/classes/Library.md deleted file mode 100644 index b369703a..00000000 --- a/docs/api/namespaces/YTMusic/classes/Library.md +++ /dev/null @@ -1,155 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Library - -# Class: Library - -## Constructors - -### new Library() - -> **new Library**(`response`, `actions`): [`Library`](Library.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Library`](Library.md) - -#### Defined in - -[src/parser/ytmusic/Library.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L29) - -## Properties - -### contents? - -> `optional` **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicShelf`](../../YTNodes/classes/MusicShelf.md) \| [`Grid`](../../YTNodes/classes/Grid.md)\> - -#### Defined in - -[src/parser/ytmusic/Library.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L27) - -*** - -### header? - -> `optional` **header**: [`MusicSideAlignedItem`](../../YTNodes/classes/MusicSideAlignedItem.md) - -#### Defined in - -[src/parser/ytmusic/Library.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L26) - -## Accessors - -### filters - -> `get` **filters**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/ytmusic/Library.ts:142](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L142) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/ytmusic/Library.ts:132](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L132) - -*** - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/Library.ts:146](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L146) - -*** - -### sort\_options - -> `get` **sort\_options**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/ytmusic/Library.ts:136](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L136) - -## Methods - -### applyFilter() - -> **applyFilter**(`filter`): `Promise`\<[`Library`](Library.md)\> - -Applies given filter to the library. - -#### Parameters - -• **filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Returns - -`Promise`\<[`Library`](Library.md)\> - -#### Defined in - -[src/parser/ytmusic/Library.ts:94](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L94) - -*** - -### applySort() - -> **applySort**(`sort_by`): `Promise`\<[`Library`](Library.md)\> - -Applies given sort option to the library items. - -#### Parameters - -• **sort\_by**: `string` \| [`MusicMultiSelectMenuItem`](../../YTNodes/classes/MusicMultiSelectMenuItem.md) - -#### Returns - -`Promise`\<[`Library`](Library.md)\> - -#### Defined in - -[src/parser/ytmusic/Library.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L44) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`LibraryContinuation`](LibraryContinuation.md)\> - -Retrieves continuation of the library items. - -#### Returns - -`Promise`\<[`LibraryContinuation`](LibraryContinuation.md)\> - -#### Defined in - -[src/parser/ytmusic/Library.ts:120](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L120) diff --git a/docs/api/namespaces/YTMusic/classes/LibraryContinuation.md b/docs/api/namespaces/YTMusic/classes/LibraryContinuation.md deleted file mode 100644 index a331522c..00000000 --- a/docs/api/namespaces/YTMusic/classes/LibraryContinuation.md +++ /dev/null @@ -1,75 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / LibraryContinuation - -# Class: LibraryContinuation - -## Constructors - -### new LibraryContinuation() - -> **new LibraryContinuation**(`response`, `actions`): [`LibraryContinuation`](LibraryContinuation.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`LibraryContinuation`](LibraryContinuation.md) - -#### Defined in - -[src/parser/ytmusic/Library.ts:158](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L158) - -## Properties - -### contents - -> **contents**: [`MusicShelfContinuation`](../../../classes/MusicShelfContinuation.md) \| [`GridContinuation`](../../../classes/GridContinuation.md) - -#### Defined in - -[src/parser/ytmusic/Library.ts:156](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L156) - -## Accessors - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/ytmusic/Library.ts:182](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L182) - -*** - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/Library.ts:186](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L186) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`LibraryContinuation`](LibraryContinuation.md)\> - -#### Returns - -`Promise`\<[`LibraryContinuation`](LibraryContinuation.md)\> - -#### Defined in - -[src/parser/ytmusic/Library.ts:170](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Library.ts#L170) diff --git a/docs/api/namespaces/YTMusic/classes/Playlist.md b/docs/api/namespaces/YTMusic/classes/Playlist.md deleted file mode 100644 index d55b5334..00000000 --- a/docs/api/namespaces/YTMusic/classes/Playlist.md +++ /dev/null @@ -1,145 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Playlist - -# Class: Playlist - -## Constructors - -### new Playlist() - -> **new Playlist**(`response`, `actions`): [`Playlist`](Playlist.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Playlist`](Playlist.md) - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L34) - -## Properties - -### background? - -> `optional` **background**: [`MusicThumbnail`](../../YTNodes/classes/MusicThumbnail.md) - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L29) - -*** - -### contents? - -> `optional` **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ContinuationItem`](../../YTNodes/classes/ContinuationItem.md) \| [`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\> - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L28) - -*** - -### header? - -> `optional` **header**: [`MusicDetailHeader`](../../YTNodes/classes/MusicDetailHeader.md) \| [`MusicResponsiveHeader`](../../YTNodes/classes/MusicResponsiveHeader.md) \| [`MusicEditablePlaylistDetailHeader`](../../YTNodes/classes/MusicEditablePlaylistDetailHeader.md) - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L27) - -## Accessors - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:163](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L163) - -*** - -### items - -> `get` **items**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ContinuationItem`](../../YTNodes/classes/ContinuationItem.md) \| [`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ContinuationItem`](../../YTNodes/classes/ContinuationItem.md) \| [`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\> - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:159](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L159) - -*** - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:155](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L155) - -## Methods - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`Playlist`](Playlist.md)\> - -Retrieves playlist items continuation. - -#### Returns - -`Promise`\<[`Playlist`](Playlist.md)\> - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L64) - -*** - -### getRelated() - -> **getRelated**(): `Promise`\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md)\> - -Retrieves related playlists - -#### Returns - -`Promise`\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:85](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L85) - -*** - -### getSuggestions() - -> **getSuggestions**(`refresh`): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\>\> - -#### Parameters - -• **refresh**: `boolean` = `true` - -#### Returns - -`Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\>\> - -#### Defined in - -[src/parser/ytmusic/Playlist.ts:114](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Playlist.ts#L114) diff --git a/docs/api/namespaces/YTMusic/classes/Recap.md b/docs/api/namespaces/YTMusic/classes/Recap.md deleted file mode 100644 index a720dab2..00000000 --- a/docs/api/namespaces/YTMusic/classes/Recap.md +++ /dev/null @@ -1,73 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Recap - -# Class: Recap - -## Constructors - -### new Recap() - -> **new Recap**(`response`, `actions`): [`Recap`](Recap.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Recap`](Recap.md) - -#### Defined in - -[src/parser/ytmusic/Recap.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Recap.ts#L26) - -## Properties - -### header? - -> `optional` **header**: [`MusicHeader`](../../YTNodes/classes/MusicHeader.md) \| [`HighlightsCarousel`](../../YTNodes/classes/HighlightsCarousel.md) - -#### Defined in - -[src/parser/ytmusic/Recap.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Recap.ts#L23) - -*** - -### sections? - -> `optional` **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ItemSection`](../../YTNodes/classes/ItemSection.md) \| [`Message`](../../YTNodes/classes/Message.md) \| [`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Recap.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Recap.ts#L24) - -## Accessors - -### page - -> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Returns - -[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md) - -#### Defined in - -[src/parser/ytmusic/Recap.ts:60](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Recap.ts#L60) - -## Methods - -### getPlaylist() - -> **getPlaylist**(): `Promise`\<[`Playlist`](Playlist.md)\> - -Retrieves recap playlist. - -#### Returns - -`Promise`\<[`Playlist`](Playlist.md)\> - -#### Defined in - -[src/parser/ytmusic/Recap.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Recap.ts#L47) diff --git a/docs/api/namespaces/YTMusic/classes/Search.md b/docs/api/namespaces/YTMusic/classes/Search.md deleted file mode 100644 index 25b4db7d..00000000 --- a/docs/api/namespaces/YTMusic/classes/Search.md +++ /dev/null @@ -1,255 +0,0 @@ -[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Search - -# Class: Search - -## Constructors - -### new Search() - -> **new Search**(`response`, `actions`, `is_filtered`?): [`Search`](Search.md) - -#### Parameters - -• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **is\_filtered?**: `boolean` - -#### Returns - -[`Search`](Search.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L28) - -## Properties - -### contents? - -> `optional` **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ItemSection`](../../YTNodes/classes/ItemSection.md) \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) \| [`MusicCardShelf`](../../YTNodes/classes/MusicCardShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L26) - -*** - -### header? - -> `optional` **header**: [`ChipCloud`](../../YTNodes/classes/ChipCloud.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L25) - -## Accessors - -### albums - -> `get` **albums**(): `undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Returns - -`undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:137](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L137) - -*** - -### artists - -> `get` **artists**(): `undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Returns - -`undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:141](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L141) - -*** - -### did\_you\_mean - -> `get` **did\_you\_mean**(): `undefined` \| [`DidYouMean`](../../YTNodes/classes/DidYouMean.md) - -#### Returns - -`undefined` \| [`DidYouMean`](../../YTNodes/classes/DidYouMean.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:117](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L117) - -*** - -### filters - -> `get` **filters**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/parser/ytmusic/Search.ts:109](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L109) - -*** - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/ytmusic/Search.ts:113](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L113) - -*** - -### message - -> `get` **message**(): `undefined` \| [`Message`](../../YTNodes/classes/Message.md) - -#### Returns - -`undefined` \| [`Message`](../../YTNodes/classes/Message.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:125](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L125) - -*** - -### page - -> `get` **page**(): [`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md) - -#### Returns - -[`ISearchResponse`](../../APIResponseTypes/type-aliases/ISearchResponse.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:149](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L149) - -*** - -### playlists - -> `get` **playlists**(): `undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Returns - -`undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:145](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L145) - -*** - -### showing\_results\_for - -> `get` **showing\_results\_for**(): `undefined` \| [`ShowingResultsFor`](../../YTNodes/classes/ShowingResultsFor.md) - -#### Returns - -`undefined` \| [`ShowingResultsFor`](../../YTNodes/classes/ShowingResultsFor.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:121](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L121) - -*** - -### songs - -> `get` **songs**(): `undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Returns - -`undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:129](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L129) - -*** - -### videos - -> `get` **videos**(): `undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Returns - -`undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Defined in - -[src/parser/ytmusic/Search.ts:133](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L133) - -## Methods - -### applyFilter() - -> **applyFilter**(`target_filter`): `Promise`\<[`Search`](Search.md)\> - -Applies given filter to the search. - -#### Parameters - -• **target\_filter**: `string` \| [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md) - -#### Returns - -`Promise`\<[`Search`](Search.md)\> - -#### Defined in - -[src/parser/ytmusic/Search.ts:86](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L86) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<`SearchContinuation`\> - -Retrieves search continuation. Only available for filtered searches and shelf continuations. - -#### Returns - -`Promise`\<`SearchContinuation`\> - -#### Defined in - -[src/parser/ytmusic/Search.ts:71](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L71) - -*** - -### getMore() - -> **getMore**(`shelf`): `Promise`\<[`Search`](Search.md)\> - -Loads more items for the given shelf. - -#### Parameters - -• **shelf**: `undefined` \| [`MusicShelf`](../../YTNodes/classes/MusicShelf.md) - -#### Returns - -`Promise`\<[`Search`](Search.md)\> - -#### Defined in - -[src/parser/ytmusic/Search.ts:56](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytmusic/Search.ts#L56) diff --git a/docs/api/namespaces/YTNodes/classes/AboutChannel.md b/docs/api/namespaces/YTNodes/classes/AboutChannel.md deleted file mode 100644 index eb1215de..00000000 --- a/docs/api/namespaces/YTNodes/classes/AboutChannel.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AboutChannel - -# Class: AboutChannel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AboutChannel() - -> **new AboutChannel**(`data`): [`AboutChannel`](AboutChannel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AboutChannel`](AboutChannel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/AboutChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannel.ts#L12) - -## Properties - -### metadata - -> **metadata**: `null` \| [`AboutChannelView`](AboutChannelView.md) - -#### Defined in - -[src/parser/classes/AboutChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannel.ts#L9) - -*** - -### share\_channel - -> **share\_channel**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/AboutChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannel.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AboutChannel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/AboutChannel.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannel.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AboutChannel & { [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 AboutChannel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AboutChannelView.md b/docs/api/namespaces/YTNodes/classes/AboutChannelView.md deleted file mode 100644 index 6e85e005..00000000 --- a/docs/api/namespaces/YTNodes/classes/AboutChannelView.md +++ /dev/null @@ -1,341 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AboutChannelView - -# Class: AboutChannelView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AboutChannelView() - -> **new AboutChannelView**(`data`): [`AboutChannelView`](AboutChannelView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AboutChannelView`](AboutChannelView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L26) - -## Properties - -### additional\_info\_label? - -> `optional` **additional\_info\_label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L20) - -*** - -### canonical\_channel\_url? - -> `optional` **canonical\_channel\_url**: `string` - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L18) - -*** - -### channel\_id? - -> `optional` **channel\_id**: `string` - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L19) - -*** - -### country? - -> `optional` **country**: `string` - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L13) - -*** - -### custom\_links\_label? - -> `optional` **custom\_links\_label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L14) - -*** - -### custom\_url\_on\_tap? - -> `optional` **custom\_url\_on\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L21) - -*** - -### description? - -> `optional` **description**: `string` - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L11) - -*** - -### description\_label? - -> `optional` **description\_label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L12) - -*** - -### joined\_date? - -> `optional` **joined\_date**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L17) - -*** - -### links - -> **links**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChannelExternalLinkView`](ChannelExternalLinkView.md)\> - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L24) - -*** - -### sign\_in\_for\_business\_email? - -> `optional` **sign\_in\_for\_business\_email**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L23) - -*** - -### subscriber\_count? - -> `optional` **subscriber\_count**: `string` - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count? - -> `optional` **video\_count**: `string` - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L22) - -*** - -### view\_count? - -> `optional` **view\_count**: `string` - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L16) - -*** - -### type - -> `static` **type**: `string` = `'AboutChannelView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/AboutChannelView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AboutChannelView.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AboutChannelView & { [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 AboutChannelView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AccountItem.md b/docs/api/namespaces/YTNodes/classes/AccountItem.md deleted file mode 100644 index 25fead3a..00000000 --- a/docs/api/namespaces/YTNodes/classes/AccountItem.md +++ /dev/null @@ -1,283 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AccountItem - -# Class: AccountItem - -Not a real renderer but we treat it as one to keep things organized. - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AccountItem() - -> **new AccountItem**(`data`): [`AccountItem`](AccountItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AccountItem`](AccountItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/AccountItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L22) - -## Properties - -### account\_byline - -> **account\_byline**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AccountItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L19) - -*** - -### account\_name - -> **account\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AccountItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L13) - -*** - -### account\_photo - -> **account\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/AccountItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L14) - -*** - -### channel\_handle - -> **channel\_handle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AccountItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L20) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/AccountItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L18) - -*** - -### has\_channel - -> **has\_channel**: `boolean` - -#### Defined in - -[src/parser/classes/AccountItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L17) - -*** - -### is\_disabled - -> **is\_disabled**: `boolean` - -#### Defined in - -[src/parser/classes/AccountItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L16) - -*** - -### is\_selected - -> **is\_selected**: `boolean` - -#### Defined in - -[src/parser/classes/AccountItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AccountItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/AccountItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItem.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AccountItem & { [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 AccountItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AccountItemSection.md b/docs/api/namespaces/YTNodes/classes/AccountItemSection.md deleted file mode 100644 index d63b8928..00000000 --- a/docs/api/namespaces/YTNodes/classes/AccountItemSection.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AccountItemSection - -# Class: AccountItemSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AccountItemSection() - -> **new AccountItemSection**(`data`): [`AccountItemSection`](AccountItemSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AccountItemSection`](AccountItemSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/AccountItemSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItemSection.ts#L14) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactLink`](CompactLink.md) \| [`AccountItem`](AccountItem.md)\> - -#### Defined in - -[src/parser/classes/AccountItemSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItemSection.ts#L11) - -*** - -### header - -> **header**: `null` \| [`AccountItemSectionHeader`](AccountItemSectionHeader.md) - -#### Defined in - -[src/parser/classes/AccountItemSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItemSection.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AccountItemSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/AccountItemSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AccountItemSection.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AccountItemSection & { [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 AccountItemSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ActiveAccountHeader.md b/docs/api/namespaces/YTNodes/classes/ActiveAccountHeader.md deleted file mode 100644 index eb2f94ca..00000000 --- a/docs/api/namespaces/YTNodes/classes/ActiveAccountHeader.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ActiveAccountHeader - -# Class: ActiveAccountHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ActiveAccountHeader() - -> **new ActiveAccountHeader**(`data`): [`ActiveAccountHeader`](ActiveAccountHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ActiveAccountHeader`](ActiveAccountHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ActiveAccountHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ActiveAccountHeader.ts#L16) - -## Properties - -### account\_name - -> **account\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ActiveAccountHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ActiveAccountHeader.ts#L10) - -*** - -### account\_photo - -> **account\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ActiveAccountHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ActiveAccountHeader.ts#L11) - -*** - -### channel\_handle - -> **channel\_handle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ActiveAccountHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ActiveAccountHeader.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ActiveAccountHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ActiveAccountHeader.ts#L12) - -*** - -### manage\_account\_title - -> **manage\_account\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ActiveAccountHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ActiveAccountHeader.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ActiveAccountHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ActiveAccountHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ActiveAccountHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ActiveAccountHeader & { [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 ActiveAccountHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md b/docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md deleted file mode 100644 index a99e8a63..00000000 --- a/docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AddBannerToLiveChatCommand - -# Class: AddBannerToLiveChatCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AddBannerToLiveChatCommand() - -> **new AddBannerToLiveChatCommand**(`data`): [`AddBannerToLiveChatCommand`](AddBannerToLiveChatCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AddBannerToLiveChatCommand`](AddBannerToLiveChatCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L11) - -## Properties - -### banner - -> **banner**: `null` \| [`LiveChatBanner`](LiveChatBanner.md) - -#### Defined in - -[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AddBannerToLiveChatCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AddBannerToLiveChatCommand & { [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 AddBannerToLiveChatCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AddChatItemAction.md b/docs/api/namespaces/YTNodes/classes/AddChatItemAction.md deleted file mode 100644 index dc3a26ba..00000000 --- a/docs/api/namespaces/YTNodes/classes/AddChatItemAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AddChatItemAction - -# Class: AddChatItemAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AddChatItemAction() - -> **new AddChatItemAction**(`data`): [`AddChatItemAction`](AddChatItemAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AddChatItemAction`](AddChatItemAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/AddChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddChatItemAction.ts#L11) - -## Properties - -### client\_id? - -> `optional` **client\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/AddChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddChatItemAction.ts#L9) - -*** - -### item - -> **item**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/AddChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddChatItemAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AddChatItemAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/AddChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddChatItemAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AddChatItemAction & { [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 AddChatItemAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md b/docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md deleted file mode 100644 index 70408fb3..00000000 --- a/docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AddLiveChatTickerItemAction - -# Class: AddLiveChatTickerItemAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AddLiveChatTickerItemAction() - -> **new AddLiveChatTickerItemAction**(`data`): [`AddLiveChatTickerItemAction`](AddLiveChatTickerItemAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AddLiveChatTickerItemAction`](AddLiveChatTickerItemAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L11) - -## Properties - -### duration\_sec - -> **duration\_sec**: `string` - -#### Defined in - -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L9) - -*** - -### item - -> **item**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AddLiveChatTickerItemAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AddLiveChatTickerItemAction & { [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 AddLiveChatTickerItemAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AddToPlaylistCommand.md b/docs/api/namespaces/YTNodes/classes/AddToPlaylistCommand.md deleted file mode 100644 index 551f046b..00000000 --- a/docs/api/namespaces/YTNodes/classes/AddToPlaylistCommand.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AddToPlaylistCommand - -# Class: AddToPlaylistCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AddToPlaylistCommand() - -> **new AddToPlaylistCommand**(`data`): [`AddToPlaylistCommand`](AddToPlaylistCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AddToPlaylistCommand`](AddToPlaylistCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/commands/AddToPlaylistCommand.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/AddToPlaylistCommand.ts#L14) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/commands/AddToPlaylistCommand.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/AddToPlaylistCommand.ts#L11) - -*** - -### list\_type - -> **list\_type**: `string` - -#### Defined in - -[src/parser/classes/commands/AddToPlaylistCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/AddToPlaylistCommand.ts#L10) - -*** - -### open\_miniplayer - -> **open\_miniplayer**: `boolean` - -#### Defined in - -[src/parser/classes/commands/AddToPlaylistCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/AddToPlaylistCommand.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/commands/AddToPlaylistCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/AddToPlaylistCommand.ts#L9) - -*** - -### video\_ids - -> **video\_ids**: `string`[] - -#### Defined in - -[src/parser/classes/commands/AddToPlaylistCommand.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/AddToPlaylistCommand.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'AddToPlaylistCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/commands/AddToPlaylistCommand.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/AddToPlaylistCommand.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AddToPlaylistCommand & { [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 AddToPlaylistCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AddToPlaylistServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/AddToPlaylistServiceEndpoint.md deleted file mode 100644 index 72f84698..00000000 --- a/docs/api/namespaces/YTNodes/classes/AddToPlaylistServiceEndpoint.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AddToPlaylistServiceEndpoint - -# Class: AddToPlaylistServiceEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`AddToPlaylistEndpoint`](AddToPlaylistEndpoint.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`AddToPlaylistServiceRequest`](../../APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md)\> - -## Constructors - -### new AddToPlaylistServiceEndpoint() - -> **new AddToPlaylistServiceEndpoint**(`data`): [`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts#L10) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AddToPlaylistServiceEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`AddToPlaylistServiceRequest`](../../APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md) - -#### Returns - -[`AddToPlaylistServiceRequest`](../../APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts#L19) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts#L15) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AddToPlaylistServiceEndpoint & { [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 AddToPlaylistServiceEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AlertWithButton.md b/docs/api/namespaces/YTNodes/classes/AlertWithButton.md deleted file mode 100644 index abd52fa1..00000000 --- a/docs/api/namespaces/YTNodes/classes/AlertWithButton.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AlertWithButton - -# Class: AlertWithButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AlertWithButton() - -> **new AlertWithButton**(`data`): [`AlertWithButton`](AlertWithButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AlertWithButton`](AlertWithButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/AlertWithButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AlertWithButton.ts#L13) - -## Properties - -### alert\_type - -> **alert\_type**: `string` - -#### Defined in - -[src/parser/classes/AlertWithButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AlertWithButton.ts#L10) - -*** - -### dismiss\_button - -> **dismiss\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/AlertWithButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AlertWithButton.ts#L11) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/AlertWithButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AlertWithButton.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AlertWithButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/AlertWithButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AlertWithButton.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AlertWithButton & { [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 AlertWithButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AnchoredSection.md b/docs/api/namespaces/YTNodes/classes/AnchoredSection.md deleted file mode 100644 index e9a45745..00000000 --- a/docs/api/namespaces/YTNodes/classes/AnchoredSection.md +++ /dev/null @@ -1,259 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AnchoredSection - -# Class: AnchoredSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AnchoredSection() - -> **new AnchoredSection**(`data`): [`AnchoredSection`](AnchoredSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AnchoredSection`](AnchoredSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ytkids/AnchoredSection.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/AnchoredSection.ts#L19) - -## Properties - -### category\_assets - -> **category\_assets**: `object` - -#### asset\_key - -> **asset\_key**: `string` - -#### background\_color - -> **background\_color**: `string` - -#### Defined in - -[src/parser/classes/ytkids/AnchoredSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/AnchoredSection.ts#L13) - -*** - -### category\_type - -> **category\_type**: `string` - -#### Defined in - -[src/parser/classes/ytkids/AnchoredSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/AnchoredSection.ts#L17) - -*** - -### content - -> **content**: `null` \| [`SectionList`](SectionList.md) - -#### Defined in - -[src/parser/classes/ytkids/AnchoredSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/AnchoredSection.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ytkids/AnchoredSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/AnchoredSection.ts#L12) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/ytkids/AnchoredSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/AnchoredSection.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AnchoredSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ytkids/AnchoredSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/AnchoredSection.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AnchoredSection & { [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 AnchoredSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md b/docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md deleted file mode 100644 index c6a5e5da..00000000 --- a/docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AppendContinuationItemsAction - -# Class: AppendContinuationItemsAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AppendContinuationItemsAction() - -> **new AppendContinuationItemsAction**(`data`): [`AppendContinuationItemsAction`](AppendContinuationItemsAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AppendContinuationItemsAction`](AppendContinuationItemsAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/actions/AppendContinuationItemsAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/AppendContinuationItemsAction.ts#L12) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/actions/AppendContinuationItemsAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/AppendContinuationItemsAction.ts#L9) - -*** - -### target - -> **target**: `string` - -#### Defined in - -[src/parser/classes/actions/AppendContinuationItemsAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/AppendContinuationItemsAction.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AppendContinuationItemsAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/actions/AppendContinuationItemsAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/AppendContinuationItemsAction.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AppendContinuationItemsAction & { [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 AppendContinuationItemsAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md b/docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md deleted file mode 100644 index 1ecc350e..00000000 --- a/docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AuthorCommentBadge - -# Class: AuthorCommentBadge - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AuthorCommentBadge() - -> **new AuthorCommentBadge**(`data`): [`AuthorCommentBadge`](AuthorCommentBadge.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AuthorCommentBadge`](AuthorCommentBadge.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/AuthorCommentBadge.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/AuthorCommentBadge.ts#L13) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/comments/AuthorCommentBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/AuthorCommentBadge.ts#L9) - -*** - -### style? - -> `optional` **style**: `string` - -#### Defined in - -[src/parser/classes/comments/AuthorCommentBadge.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/AuthorCommentBadge.ts#L11) - -*** - -### tooltip - -> **tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/AuthorCommentBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/AuthorCommentBadge.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AuthorCommentBadge'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/AuthorCommentBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/AuthorCommentBadge.ts#L5) - -## Accessors - -### orig\_badge - -> `get` **orig\_badge**(): [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Defined in - -[src/parser/classes/comments/AuthorCommentBadge.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/AuthorCommentBadge.ts#L31) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AuthorCommentBadge & { [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 AuthorCommentBadge & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/AvatarView.md b/docs/api/namespaces/YTNodes/classes/AvatarView.md deleted file mode 100644 index d366409d..00000000 --- a/docs/api/namespaces/YTNodes/classes/AvatarView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AvatarView - -# Class: AvatarView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new AvatarView() - -> **new AvatarView**(`data`): [`AvatarView`](AvatarView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`AvatarView`](AvatarView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/AvatarView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AvatarView.ts#L16) - -## Properties - -### avatar\_image\_size - -> **avatar\_image\_size**: `string` - -#### Defined in - -[src/parser/classes/AvatarView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AvatarView.ts#L14) - -*** - -### image - -> **image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/AvatarView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AvatarView.ts#L8) - -*** - -### image\_processor - -> **image\_processor**: `undefined` \| `object` - -#### Defined in - -[src/parser/classes/AvatarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AvatarView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'AvatarView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/AvatarView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/AvatarView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is AvatarView & { [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 AvatarView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/BackgroundPromo.md b/docs/api/namespaces/YTNodes/classes/BackgroundPromo.md deleted file mode 100644 index 6c9285e4..00000000 --- a/docs/api/namespaces/YTNodes/classes/BackgroundPromo.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / BackgroundPromo - -# Class: BackgroundPromo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new BackgroundPromo() - -> **new BackgroundPromo**(`data`): [`BackgroundPromo`](BackgroundPromo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`BackgroundPromo`](BackgroundPromo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/BackgroundPromo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackgroundPromo.ts#L15) - -## Properties - -### body\_text? - -> `optional` **body\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/BackgroundPromo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackgroundPromo.ts#L10) - -*** - -### cta\_button? - -> `optional` **cta\_button**: `null` \| [`Button`](Button.md) \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/BackgroundPromo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackgroundPromo.ts#L11) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/BackgroundPromo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackgroundPromo.ts#L12) - -*** - -### title? - -> `optional` **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/BackgroundPromo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackgroundPromo.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'BackgroundPromo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/BackgroundPromo.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackgroundPromo.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is BackgroundPromo & { [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 BackgroundPromo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/BackstagePost.md b/docs/api/namespaces/YTNodes/classes/BackstagePost.md deleted file mode 100644 index b5c29f49..00000000 --- a/docs/api/namespaces/YTNodes/classes/BackstagePost.md +++ /dev/null @@ -1,335 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / BackstagePost - -# Class: BackstagePost - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`Post`](Post.md) - -## Constructors - -### new BackstagePost() - -> **new BackstagePost**(`data`): [`BackstagePost`](BackstagePost.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`BackstagePost`](BackstagePost.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L27) - -## Properties - -### action\_buttons? - -> `optional` **action\_buttons**: `null` \| [`CommentActionButtons`](CommentActionButtons.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L21) - -*** - -### attachment - -> **attachment**: `undefined` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L25) - -*** - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L14) - -*** - -### content - -> **content**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L15) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L24) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L13) - -*** - -### menu? - -> `optional` **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L20) - -*** - -### poll\_status? - -> `optional` **poll\_status**: `string` - -#### Defined in - -[src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L17) - -*** - -### published - -> **published**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L16) - -*** - -### surface - -> **surface**: `string` - -#### Defined in - -[src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L23) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### vote\_button? - -> `optional` **vote\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L22) - -*** - -### vote\_count? - -> `optional` **vote\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L19) - -*** - -### vote\_status? - -> `optional` **vote\_status**: `string` - -#### Defined in - -[src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L18) - -*** - -### type - -> `static` **type**: `string` = `'BackstagePost'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is BackstagePost & { [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 BackstagePost & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/BadgeView.md b/docs/api/namespaces/YTNodes/classes/BadgeView.md deleted file mode 100644 index 1f0b9dcb..00000000 --- a/docs/api/namespaces/YTNodes/classes/BadgeView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / BadgeView - -# Class: BadgeView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new BadgeView() - -> **new BadgeView**(`data`): [`BadgeView`](BadgeView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`BadgeView`](BadgeView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/BadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BadgeView.ts#L9) - -## Properties - -### accessibility\_label - -> **accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/BadgeView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BadgeView.ts#L7) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/BadgeView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BadgeView.ts#L6) - -*** - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/BadgeView.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BadgeView.ts#L5) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `readonly` `static` **type**: `string` = `'YTNode'` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is BadgeView & { [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 BadgeView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/BrowseEndpoint.md b/docs/api/namespaces/YTNodes/classes/BrowseEndpoint.md deleted file mode 100644 index b0fe6fdf..00000000 --- a/docs/api/namespaces/YTNodes/classes/BrowseEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / BrowseEndpoint - -# Class: BrowseEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`BrowseRequest`](../../APIResponseTypes/type-aliases/BrowseRequest.md)\> - -## Constructors - -### new BrowseEndpoint() - -> **new BrowseEndpoint**(`data`): [`BrowseEndpoint`](BrowseEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`BrowseEndpoint`](BrowseEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/BrowseEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/BrowseEndpoint.ts#L10) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'BrowseEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/BrowseEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/BrowseEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`BrowseRequest`](../../APIResponseTypes/type-aliases/BrowseRequest.md) - -#### Returns - -[`BrowseRequest`](../../APIResponseTypes/type-aliases/BrowseRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/BrowseEndpoint.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/BrowseEndpoint.ts#L19) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/BrowseEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/BrowseEndpoint.ts#L15) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is BrowseEndpoint & { [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 BrowseEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md b/docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md deleted file mode 100644 index d2898ce7..00000000 --- a/docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / BrowserMediaSession - -# Class: BrowserMediaSession - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new BrowserMediaSession() - -> **new BrowserMediaSession**(`data`): [`BrowserMediaSession`](BrowserMediaSession.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`BrowserMediaSession`](BrowserMediaSession.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/BrowserMediaSession.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BrowserMediaSession.ts#L12) - -## Properties - -### album - -> **album**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/BrowserMediaSession.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BrowserMediaSession.ts#L9) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/BrowserMediaSession.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BrowserMediaSession.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'BrowserMediaSession'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/BrowserMediaSession.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BrowserMediaSession.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is BrowserMediaSession & { [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 BrowserMediaSession & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/BumperUserEduContentView.md b/docs/api/namespaces/YTNodes/classes/BumperUserEduContentView.md deleted file mode 100644 index 4535fbb4..00000000 --- a/docs/api/namespaces/YTNodes/classes/BumperUserEduContentView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / BumperUserEduContentView - -# Class: BumperUserEduContentView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new BumperUserEduContentView() - -> **new BumperUserEduContentView**(`data`): [`BumperUserEduContentView`](BumperUserEduContentView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`BumperUserEduContentView`](BumperUserEduContentView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/BumperUserEduContentView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/BumperUserEduContentView.ts#L12) - -## Properties - -### image\_color - -> **image\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/BumperUserEduContentView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/BumperUserEduContentView.ts#L10) - -*** - -### image\_name - -> **image\_name**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/BumperUserEduContentView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/BumperUserEduContentView.ts#L9) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/BumperUserEduContentView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/BumperUserEduContentView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'BumperUserEduContentView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/BumperUserEduContentView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/BumperUserEduContentView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is BumperUserEduContentView & { [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 BumperUserEduContentView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Button.md b/docs/api/namespaces/YTNodes/classes/Button.md deleted file mode 100644 index edffd653..00000000 --- a/docs/api/namespaces/YTNodes/classes/Button.md +++ /dev/null @@ -1,306 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Button - -# Class: Button - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`MenuNavigationItem`](MenuNavigationItem.md) -- [`MenuServiceItem`](MenuServiceItem.md) - -## Constructors - -### new Button() - -> **new Button**(`data`): [`Button`](Button.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Button`](Button.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Button.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L21) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/Button.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L19) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Button.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L18) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/Button.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L15) - -*** - -### is\_disabled? - -> `optional` **is\_disabled**: `boolean` - -#### Defined in - -[src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L16) - -*** - -### label? - -> `optional` **label**: `string` - -#### Defined in - -[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L11) - -*** - -### size? - -> `optional` **size**: `string` - -#### Defined in - -[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L14) - -*** - -### style? - -> `optional` **style**: `string` - -#### Defined in - -[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L13) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/Button.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L17) - -*** - -### text? - -> `optional` **text**: `string` - -#### Defined in - -[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L10) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Defined in - -[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Button'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Button.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Button & { [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 Button & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ButtonCardView.md b/docs/api/namespaces/YTNodes/classes/ButtonCardView.md deleted file mode 100644 index e5ca11ad..00000000 --- a/docs/api/namespaces/YTNodes/classes/ButtonCardView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ButtonCardView - -# Class: ButtonCardView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ButtonCardView() - -> **new ButtonCardView**(`data`): [`ButtonCardView`](ButtonCardView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ButtonCardView`](ButtonCardView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ButtonCardView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonCardView.ts#L12) - -## Properties - -### icon\_name - -> **icon\_name**: `string` - -#### Defined in - -[src/parser/classes/ButtonCardView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonCardView.ts#L9) - -*** - -### renderer\_context - -> **renderer\_context**: [`RendererContext`](../../Misc/classes/RendererContext.md) - -#### Defined in - -[src/parser/classes/ButtonCardView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonCardView.ts#L10) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/ButtonCardView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonCardView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ButtonCardView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ButtonCardView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonCardView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ButtonCardView & { [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 ButtonCardView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ButtonView.md b/docs/api/namespaces/YTNodes/classes/ButtonView.md deleted file mode 100644 index fec96f7a..00000000 --- a/docs/api/namespaces/YTNodes/classes/ButtonView.md +++ /dev/null @@ -1,481 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ButtonView - -# Class: ButtonView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ButtonView() - -> **new ButtonView**(`data`): [`ButtonView`](ButtonView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ButtonView`](ButtonView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ButtonView.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L38) - -## Properties - -### accessibility\_id? - -> `optional` **accessibility\_id**: `string` - -#### Defined in - -[src/parser/classes/ButtonView.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L30) - -*** - -### accessibility\_text? - -> `optional` **accessibility\_text**: `string` - -#### Defined in - -[src/parser/classes/ButtonView.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L36) - -*** - -### button\_size? - -> `optional` **button\_size**: `"BUTTON_VIEW_MODEL_SIZE_UNKNOWN"` \| `"BUTTON_VIEW_MODEL_SIZE_DEFAULT"` \| `"BUTTON_VIEW_MODEL_SIZE_COMPACT"` \| `"BUTTON_VIEW_MODEL_SIZE_XSMALL"` \| `"BUTTON_VIEW_MODEL_SIZE_LARGE"` \| `"BUTTON_VIEW_MODEL_SIZE_XLARGE"` \| `"BUTTON_VIEW_MODEL_SIZE_XXLARGE"` - -#### Defined in - -[src/parser/classes/ButtonView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L14) - -*** - -### button\_type? - -> `optional` **button\_type**: `"BUTTON_VIEW_MODEL_TYPE_UNKNOWN"` \| `"BUTTON_VIEW_MODEL_TYPE_FILLED"` \| `"BUTTON_VIEW_MODEL_TYPE_OUTLINE"` \| `"BUTTON_VIEW_MODEL_TYPE_TEXT"` \| `"BUTTON_VIEW_MODEL_TYPE_TONAL"` - -#### Defined in - -[src/parser/classes/ButtonView.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L28) - -*** - -### custom\_background\_color? - -> `optional` **custom\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/ButtonView.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L31) - -*** - -### custom\_border\_color? - -> `optional` **custom\_border\_color**: `number` - -#### Defined in - -[src/parser/classes/ButtonView.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L19) - -*** - -### custom\_dark\_theme\_border\_color? - -> `optional` **custom\_dark\_theme\_border\_color**: `number` - -#### Defined in - -[src/parser/classes/ButtonView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L23) - -*** - -### custom\_font\_color? - -> `optional` **custom\_font\_color**: `number` - -#### Defined in - -[src/parser/classes/ButtonView.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L27) - -*** - -### enable\_full\_width\_margins? - -> `optional` **enable\_full\_width\_margins**: `boolean` - -#### Defined in - -[src/parser/classes/ButtonView.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L26) - -*** - -### enable\_icon\_button? - -> `optional` **enable\_icon\_button**: `boolean` - -#### Defined in - -[src/parser/classes/ButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L11) - -*** - -### enabled? - -> `optional` **enabled**: `boolean` - -#### Defined in - -[src/parser/classes/ButtonView.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L29) - -*** - -### icon\_image? - -> `optional` **icon\_image**: `object` - -#### Defined in - -[src/parser/classes/ButtonView.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L22) - -*** - -### icon\_image\_flip\_for\_rtl? - -> `optional` **icon\_image\_flip\_for\_rtl**: `boolean` - -#### Defined in - -[src/parser/classes/ButtonView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L13) - -*** - -### icon\_name? - -> `optional` **icon\_name**: `string` - -#### Defined in - -[src/parser/classes/ButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L10) - -*** - -### icon\_position? - -> `optional` **icon\_position**: `"BUTTON_VIEW_MODEL_ICON_POSITION_UNKNOWN"` \| `"BUTTON_VIEW_MODEL_ICON_POSITION_TRAILING"` \| `"BUTTON_VIEW_MODEL_ICON_POSITION_LEADING"` \| `"BUTTON_VIEW_MODEL_ICON_POSITION_ABOVE"` \| `"BUTTON_VIEW_MODEL_ICON_POSITION_LEADING_TRAILING"` - -#### Defined in - -[src/parser/classes/ButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L15) - -*** - -### icon\_trailing? - -> `optional` **icon\_trailing**: `boolean` - -#### Defined in - -[src/parser/classes/ButtonView.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L35) - -*** - -### is\_full\_width? - -> `optional` **is\_full\_width**: `boolean` - -#### Defined in - -[src/parser/classes/ButtonView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L16) - -*** - -### on\_disabled\_tap? - -> `optional` **on\_disabled\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ButtonView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L18) - -*** - -### on\_long\_press? - -> `optional` **on\_long\_press**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ButtonView.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L32) - -*** - -### on\_tap? - -> `optional` **on\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ButtonView.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L20) - -*** - -### on\_visible? - -> `optional` **on\_visible**: `object` - -#### Defined in - -[src/parser/classes/ButtonView.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L34) - -*** - -### secondary\_icon\_image? - -> `optional` **secondary\_icon\_image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L9) - -*** - -### state? - -> `optional` **state**: `"BUTTON_VIEW_MODEL_STATE_UNKNOWN"` \| `"BUTTON_VIEW_MODEL_STATE_ACTIVE"` \| `"BUTTON_VIEW_MODEL_STATE_INACTIVE"` \| `"BUTTON_VIEW_MODEL_STATE_DISABLED"` - -#### Defined in - -[src/parser/classes/ButtonView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L17) - -*** - -### style? - -> `optional` **style**: `"BUTTON_VIEW_MODEL_STYLE_UNKNOWN"` \| `"BUTTON_VIEW_MODEL_STYLE_CTA"` \| `"BUTTON_VIEW_MODEL_STYLE_BRAND"` \| `"BUTTON_VIEW_MODEL_STYLE_ADS_CTA"` \| `"BUTTON_VIEW_MODEL_STYLE_OVERLAY"` \| `"BUTTON_VIEW_MODEL_STYLE_CTA_THEMED"` \| `"BUTTON_VIEW_MODEL_STYLE_BLACK_CTA"` \| `"BUTTON_VIEW_MODEL_STYLE_CUSTOM"` \| `"BUTTON_VIEW_MODEL_STYLE_MONO"` \| `"BUTTON_VIEW_MODEL_STYLE_OVERLAY_DARK"` \| `"BUTTON_VIEW_MODEL_STYLE_CTA_OVERLAY"` \| `"BUTTON_VIEW_MODEL_STYLE_BRAND_AI"` \| `"BUTTON_VIEW_MODEL_STYLE_YT_GRADIENT"` \| `"BUTTON_VIEW_MODEL_STYLE_BRAND_GRADIENT"` - -#### Defined in - -[src/parser/classes/ButtonView.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L21) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/ButtonView.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L25) - -*** - -### title? - -> `optional` **title**: `string` - -#### Defined in - -[src/parser/classes/ButtonView.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L24) - -*** - -### title\_formatted? - -> `optional` **title\_formatted**: `object` - -#### Defined in - -[src/parser/classes/ButtonView.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L33) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Defined in - -[src/parser/classes/ButtonView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ButtonView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ButtonView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ButtonView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ButtonView & { [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 ButtonView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md b/docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md deleted file mode 100644 index eef7bbc3..00000000 --- a/docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md +++ /dev/null @@ -1,321 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / C4TabbedHeader - -# Class: C4TabbedHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new C4TabbedHeader() - -> **new C4TabbedHeader**(`data`): [`C4TabbedHeader`](C4TabbedHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`C4TabbedHeader`](C4TabbedHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L28) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L15) - -*** - -### banner? - -> `optional` **banner**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L16) - -*** - -### channel\_handle? - -> `optional` **channel\_handle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L24) - -*** - -### channel\_id? - -> `optional` **channel\_id**: `string` - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L25) - -*** - -### header\_links? - -> `optional` **header\_links**: `null` \| [`ChannelHeaderLinks`](ChannelHeaderLinks.md) \| [`ChannelHeaderLinksView`](ChannelHeaderLinksView.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L23) - -*** - -### mobile\_banner? - -> `optional` **mobile\_banner**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L18) - -*** - -### sponsor\_button? - -> `optional` **sponsor\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L21) - -*** - -### subscribe\_button? - -> `optional` **subscribe\_button**: `null` \| [`Button`](Button.md) \| [`SubscribeButton`](SubscribeButton.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L22) - -*** - -### subscribers? - -> `optional` **subscribers**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L19) - -*** - -### tagline? - -> `optional` **tagline**: `null` \| [`ChannelTagline`](ChannelTagline.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L26) - -*** - -### tv\_banner? - -> `optional` **tv\_banner**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### videos\_count? - -> `optional` **videos\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L20) - -*** - -### type - -> `static` **type**: `string` = `'C4TabbedHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/C4TabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/C4TabbedHeader.ts#L13) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is C4TabbedHeader & { [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 C4TabbedHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CallToActionButton.md b/docs/api/namespaces/YTNodes/classes/CallToActionButton.md deleted file mode 100644 index f33aea8f..00000000 --- a/docs/api/namespaces/YTNodes/classes/CallToActionButton.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CallToActionButton - -# Class: CallToActionButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CallToActionButton() - -> **new CallToActionButton**(`data`): [`CallToActionButton`](CallToActionButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CallToActionButton`](CallToActionButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CallToActionButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CallToActionButton.ts#L12) - -## Properties - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/CallToActionButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CallToActionButton.ts#L9) - -*** - -### label - -> **label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CallToActionButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CallToActionButton.ts#L8) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/CallToActionButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CallToActionButton.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CallToActionButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CallToActionButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CallToActionButton.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CallToActionButton & { [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 CallToActionButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Card.md b/docs/api/namespaces/YTNodes/classes/Card.md deleted file mode 100644 index a7d25b01..00000000 --- a/docs/api/namespaces/YTNodes/classes/Card.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Card - -# Class: Card - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Card() - -> **new Card**(`data`): [`Card`](Card.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Card`](Card.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Card.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Card.ts#L19) - -## Properties - -### card\_id? - -> `optional` **card\_id**: `string` - -#### Defined in - -[src/parser/classes/Card.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Card.ts#L9) - -*** - -### content - -> **content**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Card.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Card.ts#L8) - -*** - -### cue\_ranges - -> **cue\_ranges**: `object`[] - -#### Defined in - -[src/parser/classes/Card.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Card.ts#L12) - -*** - -### feature? - -> `optional` **feature**: `string` - -#### Defined in - -[src/parser/classes/Card.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Card.ts#L10) - -*** - -### teaser - -> **teaser**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Card.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Card.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Card'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Card.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Card.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Card & { [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 Card & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CardCollection.md b/docs/api/namespaces/YTNodes/classes/CardCollection.md deleted file mode 100644 index ab6aca07..00000000 --- a/docs/api/namespaces/YTNodes/classes/CardCollection.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CardCollection - -# Class: CardCollection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CardCollection() - -> **new CardCollection**(`data`): [`CardCollection`](CardCollection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CardCollection`](CardCollection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CardCollection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CardCollection.ts#L12) - -## Properties - -### allow\_teaser\_dismiss - -> **allow\_teaser\_dismiss**: `boolean` - -#### Defined in - -[src/parser/classes/CardCollection.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CardCollection.ts#L10) - -*** - -### cards - -> **cards**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/CardCollection.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CardCollection.ts#L8) - -*** - -### header - -> **header**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CardCollection.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CardCollection.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CardCollection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CardCollection.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CardCollection.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CardCollection & { [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 CardCollection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CarouselItem.md b/docs/api/namespaces/YTNodes/classes/CarouselItem.md deleted file mode 100644 index bab738a6..00000000 --- a/docs/api/namespaces/YTNodes/classes/CarouselItem.md +++ /dev/null @@ -1,265 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CarouselItem - -# Class: CarouselItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CarouselItem() - -> **new CarouselItem**(`data`): [`CarouselItem`](CarouselItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CarouselItem`](CarouselItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CarouselItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L14) - -## Properties - -### background\_color - -> **background\_color**: `string` - -#### Defined in - -[src/parser/classes/CarouselItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L9) - -*** - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/CarouselItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L8) - -*** - -### layout\_style - -> **layout\_style**: `string` - -#### Defined in - -[src/parser/classes/CarouselItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L10) - -*** - -### pagination\_thumbnails - -> **pagination\_thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CarouselItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L11) - -*** - -### paginator\_alignment - -> **paginator\_alignment**: `string` - -#### Defined in - -[src/parser/classes/CarouselItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CarouselItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CarouselItem.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L6) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/CarouselItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItem.ts#L24) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CarouselItem & { [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 CarouselItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CarouselItemView.md b/docs/api/namespaces/YTNodes/classes/CarouselItemView.md deleted file mode 100644 index 20238596..00000000 --- a/docs/api/namespaces/YTNodes/classes/CarouselItemView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CarouselItemView - -# Class: CarouselItemView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CarouselItemView() - -> **new CarouselItemView**(`data`): [`CarouselItemView`](CarouselItemView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CarouselItemView`](CarouselItemView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CarouselItemView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItemView.ts#L11) - -## Properties - -### carousel\_item - -> **carousel\_item**: `null` \| [`TextCarouselItemView`](TextCarouselItemView.md) - -#### Defined in - -[src/parser/classes/CarouselItemView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItemView.ts#L9) - -*** - -### item\_type - -> **item\_type**: `string` - -#### Defined in - -[src/parser/classes/CarouselItemView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItemView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CarouselItemView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CarouselItemView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselItemView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CarouselItemView & { [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 CarouselItemView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CarouselLockup.md b/docs/api/namespaces/YTNodes/classes/CarouselLockup.md deleted file mode 100644 index f35f150e..00000000 --- a/docs/api/namespaces/YTNodes/classes/CarouselLockup.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CarouselLockup - -# Class: CarouselLockup - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CarouselLockup() - -> **new CarouselLockup**(`data`): [`CarouselLockup`](CarouselLockup.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CarouselLockup`](CarouselLockup.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CarouselLockup.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselLockup.ts#L12) - -## Properties - -### info\_rows - -> **info\_rows**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`InfoRow`](InfoRow.md)\> - -#### Defined in - -[src/parser/classes/CarouselLockup.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselLockup.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_lockup? - -> `optional` **video\_lockup**: `null` \| [`CompactVideo`](CompactVideo.md) - -#### Defined in - -[src/parser/classes/CarouselLockup.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselLockup.ts#L10) - -*** - -### type - -> `static` **type**: `string` = `'CarouselLockup'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CarouselLockup.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselLockup.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CarouselLockup & { [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 CarouselLockup & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CarouselTitleView.md b/docs/api/namespaces/YTNodes/classes/CarouselTitleView.md deleted file mode 100644 index bbf3e969..00000000 --- a/docs/api/namespaces/YTNodes/classes/CarouselTitleView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CarouselTitleView - -# Class: CarouselTitleView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CarouselTitleView() - -> **new CarouselTitleView**(`data`): [`CarouselTitleView`](CarouselTitleView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CarouselTitleView`](CarouselTitleView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CarouselTitleView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselTitleView.ts#L12) - -## Properties - -### next\_button - -> **next\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/CarouselTitleView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselTitleView.ts#L10) - -*** - -### previous\_button - -> **previous\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/CarouselTitleView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselTitleView.ts#L9) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/CarouselTitleView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselTitleView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CarouselTitleView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CarouselTitleView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CarouselTitleView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CarouselTitleView & { [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 CarouselTitleView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChangeEngagementPanelVisibilityAction.md b/docs/api/namespaces/YTNodes/classes/ChangeEngagementPanelVisibilityAction.md deleted file mode 100644 index 0fcb5ab7..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChangeEngagementPanelVisibilityAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChangeEngagementPanelVisibilityAction - -# Class: ChangeEngagementPanelVisibilityAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChangeEngagementPanelVisibilityAction() - -> **new ChangeEngagementPanelVisibilityAction**(`data`): [`ChangeEngagementPanelVisibilityAction`](ChangeEngagementPanelVisibilityAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChangeEngagementPanelVisibilityAction`](ChangeEngagementPanelVisibilityAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts#L10) - -## Properties - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### visibility - -> **visibility**: `string` - -#### Defined in - -[src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChangeEngagementPanelVisibilityAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/ChangeEngagementPanelVisibilityAction.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChangeEngagementPanelVisibilityAction & { [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 ChangeEngagementPanelVisibilityAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Channel.md b/docs/api/namespaces/YTNodes/classes/Channel.md deleted file mode 100644 index d46433fa..00000000 --- a/docs/api/namespaces/YTNodes/classes/Channel.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Channel - -# Class: Channel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Channel() - -> **new Channel**(`data`): [`Channel`](Channel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Channel`](Channel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Channel.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L22) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/Channel.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L13) - -*** - -### description\_snippet - -> **description\_snippet**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Channel.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L20) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Channel.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L18) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/Channel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L12) - -*** - -### long\_byline - -> **long\_byline**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Channel.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L16) - -*** - -### short\_byline - -> **short\_byline**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Channel.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L17) - -*** - -### subscribe\_button - -> **subscribe\_button**: `null` \| [`Button`](Button.md) \| [`SubscribeButton`](SubscribeButton.md) - -#### Defined in - -[src/parser/classes/Channel.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L19) - -*** - -### subscriber\_count - -> **subscriber\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Channel.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Channel.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'Channel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Channel.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Channel.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Channel & { [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 Channel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md b/docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md deleted file mode 100644 index 6d6fb33b..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md +++ /dev/null @@ -1,321 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelAboutFullMetadata - -# Class: ChannelAboutFullMetadata - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelAboutFullMetadata() - -> **new ChannelAboutFullMetadata**(`data`): [`ChannelAboutFullMetadata`](ChannelAboutFullMetadata.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelAboutFullMetadata`](ChannelAboutFullMetadata.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L30) - -## Properties - -### avatar - -> **avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L13) - -*** - -### buttons - -> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md)\> - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L28) - -*** - -### can\_reveal\_email - -> **can\_reveal\_email**: `boolean` - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L26) - -*** - -### canonical\_channel\_url - -> **canonical\_channel\_url**: `string` - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L14) - -*** - -### country - -> **country**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L27) - -*** - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L24) - -*** - -### email\_reveal - -> **email\_reveal**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L25) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L11) - -*** - -### joined\_date - -> **joined\_date**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L23) - -*** - -### name - -> **name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L12) - -*** - -### primary\_links - -> **primary\_links**: `object`[] - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_count - -> **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L22) - -*** - -### type - -> `static` **type**: `string` = `'ChannelAboutFullMetadata'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAboutFullMetadata.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelAboutFullMetadata & { [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 ChannelAboutFullMetadata & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md b/docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md deleted file mode 100644 index 1ed62260..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelAgeGate - -# Class: ChannelAgeGate - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelAgeGate() - -> **new ChannelAgeGate**(`data`): [`ChannelAgeGate`](ChannelAgeGate.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelAgeGate`](ChannelAgeGate.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L18) - -## Properties - -### avatar - -> **avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L12) - -*** - -### channel\_title - -> **channel\_title**: `string` - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L11) - -*** - -### header - -> **header**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L13) - -*** - -### main\_text - -> **main\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L14) - -*** - -### secondary\_text - -> **secondary\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L16) - -*** - -### sign\_in\_button - -> **sign\_in\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelAgeGate'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelAgeGate.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelAgeGate.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelAgeGate & { [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 ChannelAgeGate & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md b/docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md deleted file mode 100644 index 6cfa61c9..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelExternalLinkView - -# Class: ChannelExternalLinkView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelExternalLinkView() - -> **new ChannelExternalLinkView**(`data`): [`ChannelExternalLinkView`](ChannelExternalLinkView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelExternalLinkView`](ChannelExternalLinkView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelExternalLinkView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelExternalLinkView.ts#L13) - -## Properties - -### favicon - -> **favicon**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ChannelExternalLinkView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelExternalLinkView.ts#L11) - -*** - -### link - -> **link**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelExternalLinkView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelExternalLinkView.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelExternalLinkView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelExternalLinkView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelExternalLinkView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelExternalLinkView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelExternalLinkView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelExternalLinkView & { [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 ChannelExternalLinkView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md b/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md deleted file mode 100644 index 3e849d14..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelHeaderLinksView - -# Class: ChannelHeaderLinksView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelHeaderLinksView() - -> **new ChannelHeaderLinksView**(`data`): [`ChannelHeaderLinksView`](ChannelHeaderLinksView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelHeaderLinksView`](ChannelHeaderLinksView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelHeaderLinksView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelHeaderLinksView.ts#L11) - -## Properties - -### first\_link? - -> `optional` **first\_link**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelHeaderLinksView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelHeaderLinksView.ts#L8) - -*** - -### more? - -> `optional` **more**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelHeaderLinksView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelHeaderLinksView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelHeaderLinksView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelHeaderLinksView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelHeaderLinksView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelHeaderLinksView & { [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 ChannelHeaderLinksView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelMetadata.md b/docs/api/namespaces/YTNodes/classes/ChannelMetadata.md deleted file mode 100644 index 352f628a..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelMetadata.md +++ /dev/null @@ -1,341 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelMetadata - -# Class: ChannelMetadata - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelMetadata() - -> **new ChannelMetadata**(`data`): [`ChannelMetadata`](ChannelMetadata.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelMetadata`](ChannelMetadata.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L23) - -## Properties - -### android\_appindexing\_link - -> **android\_appindexing\_link**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L20) - -*** - -### android\_deep\_link - -> **android\_deep\_link**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L19) - -*** - -### available\_countries - -> **available\_countries**: `string`[] - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L18) - -*** - -### avatar - -> **avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L16) - -*** - -### description - -> **description**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L9) - -*** - -### external\_id - -> **external\_id**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L13) - -*** - -### ios\_appindexing\_link - -> **ios\_appindexing\_link**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L21) - -*** - -### is\_family\_safe - -> **is\_family\_safe**: `boolean` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L14) - -*** - -### keywords - -> **keywords**: `string`[] - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L15) - -*** - -### music\_artist\_name? - -> `optional` **music\_artist\_name**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L17) - -*** - -### rss\_url - -> **rss\_url**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L11) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### url - -> **url**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L10) - -*** - -### vanity\_channel\_url - -> **vanity\_channel\_url**: `string` - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'ChannelMetadata'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelMetadata.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelMetadata.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelMetadata & { [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 ChannelMetadata & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelOptions.md b/docs/api/namespaces/YTNodes/classes/ChannelOptions.md deleted file mode 100644 index 6e24d8f4..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelOptions.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelOptions - -# Class: ChannelOptions - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelOptions() - -> **new ChannelOptions**(`data`): [`ChannelOptions`](ChannelOptions.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelOptions`](ChannelOptions.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelOptions.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOptions.ts#L15) - -## Properties - -### avatar - -> **avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ChannelOptions.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOptions.ts#L10) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ChannelOptions.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOptions.ts#L11) - -*** - -### links - -> **links**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/ChannelOptions.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOptions.ts#L13) - -*** - -### name - -> **name**: `string` - -#### Defined in - -[src/parser/classes/ChannelOptions.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOptions.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelOptions'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelOptions.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOptions.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelOptions & { [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 ChannelOptions & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md b/docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md deleted file mode 100644 index 1ab065e7..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelOwnerEmptyState - -# Class: ChannelOwnerEmptyState - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelOwnerEmptyState() - -> **new ChannelOwnerEmptyState**(`data`): [`ChannelOwnerEmptyState`](ChannelOwnerEmptyState.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelOwnerEmptyState`](ChannelOwnerEmptyState.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelOwnerEmptyState.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOwnerEmptyState.ts#L12) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelOwnerEmptyState.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOwnerEmptyState.ts#L10) - -*** - -### illustration - -> **illustration**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ChannelOwnerEmptyState.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOwnerEmptyState.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelOwnerEmptyState'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelOwnerEmptyState.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelOwnerEmptyState.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelOwnerEmptyState & { [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 ChannelOwnerEmptyState & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md b/docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md deleted file mode 100644 index 90b6b3c3..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelSubMenu - -# Class: ChannelSubMenu - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelSubMenu() - -> **new ChannelSubMenu**(`data`): [`ChannelSubMenu`](ChannelSubMenu.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelSubMenu`](ChannelSubMenu.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelSubMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSubMenu.ts#L16) - -## Properties - -### content\_type\_sub\_menu\_items - -> **content\_type\_sub\_menu\_items**: `object`[] - -#### Defined in - -[src/parser/classes/ChannelSubMenu.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSubMenu.ts#L8) - -*** - -### sort\_setting - -> **sort\_setting**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/ChannelSubMenu.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSubMenu.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelSubMenu'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelSubMenu.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSubMenu.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelSubMenu & { [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 ChannelSubMenu & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelSwitcherHeader.md b/docs/api/namespaces/YTNodes/classes/ChannelSwitcherHeader.md deleted file mode 100644 index a6b17037..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelSwitcherHeader.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelSwitcherHeader - -# Class: ChannelSwitcherHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelSwitcherHeader() - -> **new ChannelSwitcherHeader**(`data`): [`ChannelSwitcherHeader`](ChannelSwitcherHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelSwitcherHeader`](ChannelSwitcherHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelSwitcherHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherHeader.ts#L12) - -## Properties - -### button? - -> `optional` **button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ChannelSwitcherHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherHeader.ts#L10) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/ChannelSwitcherHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherHeader.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelSwitcherHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelSwitcherHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherHeader.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelSwitcherHeader & { [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 ChannelSwitcherHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelSwitcherPage.md b/docs/api/namespaces/YTNodes/classes/ChannelSwitcherPage.md deleted file mode 100644 index c5865c71..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelSwitcherPage.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelSwitcherPage - -# Class: ChannelSwitcherPage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelSwitcherPage() - -> **new ChannelSwitcherPage**(`data`): [`ChannelSwitcherPage`](ChannelSwitcherPage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelSwitcherPage`](ChannelSwitcherPage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelSwitcherPage.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherPage.ts#L11) - -## Properties - -### contents - -> **contents**: `null` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ChannelSwitcherPage.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherPage.ts#L9) - -*** - -### header - -> **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/ChannelSwitcherPage.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherPage.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelSwitcherPage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelSwitcherPage.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelSwitcherPage.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelSwitcherPage & { [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 ChannelSwitcherPage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelTagline.md b/docs/api/namespaces/YTNodes/classes/ChannelTagline.md deleted file mode 100644 index 7655f769..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelTagline.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelTagline - -# Class: ChannelTagline - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelTagline() - -> **new ChannelTagline**(`data`): [`ChannelTagline`](ChannelTagline.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelTagline`](ChannelTagline.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L25) - -## Properties - -### content - -> **content**: `string` - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L9) - -*** - -### max\_lines - -> **max\_lines**: `number` - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L10) - -*** - -### more\_endpoint - -> **more\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) \| `object` - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L11) - -*** - -### more\_icon\_type - -> **more\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L21) - -*** - -### more\_label - -> **more\_label**: `string` - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L22) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L23) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelTagline'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelTagline.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelTagline.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelTagline & { [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 ChannelTagline & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md b/docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md deleted file mode 100644 index ef35da8d..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelThumbnailWithLink - -# Class: ChannelThumbnailWithLink - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelThumbnailWithLink() - -> **new ChannelThumbnailWithLink**(`data`): [`ChannelThumbnailWithLink`](ChannelThumbnailWithLink.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelThumbnailWithLink`](ChannelThumbnailWithLink.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelThumbnailWithLink.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelThumbnailWithLink.ts#L14) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/ChannelThumbnailWithLink.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelThumbnailWithLink.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ChannelThumbnailWithLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelThumbnailWithLink.ts#L11) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ChannelThumbnailWithLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelThumbnailWithLink.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChannelThumbnailWithLink'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelThumbnailWithLink.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelThumbnailWithLink.ts#L8) - -## Accessors - -### label - -> `get` **label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/ChannelThumbnailWithLink.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelThumbnailWithLink.ts#L27) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelThumbnailWithLink & { [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 ChannelThumbnailWithLink & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md b/docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md deleted file mode 100644 index 6b200c9d..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChannelVideoPlayer - -# Class: ChannelVideoPlayer - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChannelVideoPlayer() - -> **new ChannelVideoPlayer**(`data`): [`ChannelVideoPlayer`](ChannelVideoPlayer.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChannelVideoPlayer`](ChannelVideoPlayer.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelVideoPlayer.ts#L14) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelVideoPlayer.ts#L10) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelVideoPlayer.ts#L8) - -*** - -### published\_time - -> **published\_time**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelVideoPlayer.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelVideoPlayer.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_count - -> **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelVideoPlayer.ts#L11) - -*** - -### type - -> `static` **type**: `string` = `'ChannelVideoPlayer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChannelVideoPlayer.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChannelVideoPlayer & { [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 ChannelVideoPlayer & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChildVideo.md b/docs/api/namespaces/YTNodes/classes/ChildVideo.md deleted file mode 100644 index a6322ca4..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChildVideo.md +++ /dev/null @@ -1,249 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChildVideo - -# Class: ChildVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChildVideo() - -> **new ChildVideo**(`data`): [`ChildVideo`](ChildVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChildVideo`](ChildVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChildVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChildVideo.ts#L20) - -## Properties - -### duration - -> **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ChildVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChildVideo.ts#L13) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ChildVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChildVideo.ts#L18) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/ChildVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChildVideo.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChildVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChildVideo.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChildVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChildVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChildVideo.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChildVideo & { [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 ChildVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChipCloud.md b/docs/api/namespaces/YTNodes/classes/ChipCloud.md deleted file mode 100644 index 6a4c9b5d..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChipCloud.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChipCloud - -# Class: ChipCloud - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChipCloud() - -> **new ChipCloud**(`data`): [`ChipCloud`](ChipCloud.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChipCloud`](ChipCloud.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChipCloud.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloud.ts#L14) - -## Properties - -### chips - -> **chips**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ChipCloudChip`](ChipCloudChip.md)\> - -#### Defined in - -[src/parser/classes/ChipCloud.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloud.ts#L9) - -*** - -### horizontal\_scrollable - -> **horizontal\_scrollable**: `boolean` - -#### Defined in - -[src/parser/classes/ChipCloud.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloud.ts#L12) - -*** - -### next\_button - -> **next\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ChipCloud.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloud.ts#L10) - -*** - -### previous\_button - -> **previous\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ChipCloud.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloud.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChipCloud'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChipCloud.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloud.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChipCloud & { [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 ChipCloud & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChipCloudChip.md b/docs/api/namespaces/YTNodes/classes/ChipCloudChip.md deleted file mode 100644 index 106be306..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChipCloudChip.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChipCloudChip - -# Class: ChipCloudChip - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChipCloudChip() - -> **new ChipCloudChip**(`data`): [`ChipCloudChip`](ChipCloudChip.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChipCloudChip`](ChipCloudChip.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChipCloudChip.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloudChip.ts#L13) - -## Properties - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ChipCloudChip.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloudChip.ts#L10) - -*** - -### is\_selected - -> **is\_selected**: `boolean` - -#### Defined in - -[src/parser/classes/ChipCloudChip.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloudChip.ts#L9) - -*** - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ChipCloudChip.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloudChip.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChipCloudChip'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChipCloudChip.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipCloudChip.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChipCloudChip & { [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 ChipCloudChip & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ChipView.md b/docs/api/namespaces/YTNodes/classes/ChipView.md deleted file mode 100644 index 70ad611e..00000000 --- a/docs/api/namespaces/YTNodes/classes/ChipView.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ChipView - -# Class: ChipView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ChipView() - -> **new ChipView**(`data`): [`ChipView`](ChipView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ChipView`](ChipView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ChipView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipView.ts#L13) - -## Properties - -### chip\_entity\_key - -> **chip\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/ChipView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipView.ts#L11) - -*** - -### display\_type - -> **display\_type**: `string` - -#### Defined in - -[src/parser/classes/ChipView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipView.ts#L9) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ChipView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipView.ts#L10) - -*** - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ChipView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ChipView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ChipView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ChipView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ChipView & { [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 ChipView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ClientSideToggleMenuItem.md b/docs/api/namespaces/YTNodes/classes/ClientSideToggleMenuItem.md deleted file mode 100644 index 1df53cf4..00000000 --- a/docs/api/namespaces/YTNodes/classes/ClientSideToggleMenuItem.md +++ /dev/null @@ -1,293 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ClientSideToggleMenuItem - -# Class: ClientSideToggleMenuItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ClientSideToggleMenuItem() - -> **new ClientSideToggleMenuItem**(`data`): [`ClientSideToggleMenuItem`](ClientSideToggleMenuItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ClientSideToggleMenuItem`](ClientSideToggleMenuItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L23) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L15) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L10) - -*** - -### is\_toggled? - -> `optional` **is\_toggled**: `boolean` - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L13) - -*** - -### logging\_directives? - -> `optional` **logging\_directives**: `object` - -#### enable\_displaylogger\_experiment - -> **enable\_displaylogger\_experiment**: `boolean` - -#### visibility - -> **visibility**: `object` - -#### visibility.types - -> **types**: `string` - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L16) - -*** - -### menu\_item\_identifier - -> **menu\_item\_identifier**: `string` - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L14) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L9) - -*** - -### toggled\_icon\_type - -> **toggled\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L12) - -*** - -### toggled\_text - -> **toggled\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ClientSideToggleMenuItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ClientSideToggleMenuItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClientSideToggleMenuItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ClientSideToggleMenuItem & { [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 ClientSideToggleMenuItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ClipCreation.md b/docs/api/namespaces/YTNodes/classes/ClipCreation.md deleted file mode 100644 index f66bf75d..00000000 --- a/docs/api/namespaces/YTNodes/classes/ClipCreation.md +++ /dev/null @@ -1,301 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ClipCreation - -# Class: ClipCreation - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ClipCreation() - -> **new ClipCreation**(`data`): [`ClipCreation`](ClipCreation.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ClipCreation`](ClipCreation.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L27) - -## Properties - -### ad\_state\_overlay - -> **ad\_state\_overlay**: `null` \| [`ClipAdState`](ClipAdState.md) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L23) - -*** - -### cancel\_button - -> **cancel\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L22) - -*** - -### display\_name - -> **display\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L20) - -*** - -### external\_video\_id - -> **external\_video\_id**: `string` - -#### Defined in - -[src/parser/classes/ClipCreation.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L24) - -*** - -### publicity\_label - -> **publicity\_label**: `string` - -#### Defined in - -[src/parser/classes/ClipCreation.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L21) - -*** - -### publicity\_label\_icon - -> **publicity\_label\_icon**: `string` - -#### Defined in - -[src/parser/classes/ClipCreation.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L25) - -*** - -### save\_button - -> **save\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L19) - -*** - -### scrubber - -> **scrubber**: `null` \| [`ClipCreationScrubber`](ClipCreationScrubber.md) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L18) - -*** - -### title\_input - -> **title\_input**: `null` \| [`ClipCreationTextInput`](ClipCreationTextInput.md) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### user\_avatar - -> **user\_avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ClipCreation.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L16) - -*** - -### type - -> `static` **type**: `string` = `'ClipCreation'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ClipCreation.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreation.ts#L14) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ClipCreation & { [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 ClipCreation & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md b/docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md deleted file mode 100644 index 1b1a79a5..00000000 --- a/docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md +++ /dev/null @@ -1,281 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ClipCreationScrubber - -# Class: ClipCreationScrubber - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ClipCreationScrubber() - -> **new ClipCreationScrubber**(`data`): [`ClipCreationScrubber`](ClipCreationScrubber.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ClipCreationScrubber`](ClipCreationScrubber.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L17) - -## Properties - -### default\_length\_ms - -> **default\_length\_ms**: `number` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L11) - -*** - -### duration\_label? - -> `optional` **duration\_label**: `string` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L15) - -*** - -### end\_label? - -> `optional` **end\_label**: `string` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L14) - -*** - -### length\_template - -> **length\_template**: `string` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L8) - -*** - -### max\_length\_ms - -> **max\_length\_ms**: `number` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L9) - -*** - -### min\_length\_ms - -> **min\_length\_ms**: `number` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L10) - -*** - -### start\_label? - -> `optional` **start\_label**: `string` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### window\_size\_ms - -> **window\_size\_ms**: `number` - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'ClipCreationScrubber'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ClipCreationScrubber.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationScrubber.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ClipCreationScrubber & { [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 ClipCreationScrubber & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md b/docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md deleted file mode 100644 index 67adaa90..00000000 --- a/docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ClipCreationTextInput - -# Class: ClipCreationTextInput - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ClipCreationTextInput() - -> **new ClipCreationTextInput**(`data`): [`ClipCreationTextInput`](ClipCreationTextInput.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ClipCreationTextInput`](ClipCreationTextInput.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ClipCreationTextInput.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationTextInput.ts#L12) - -## Properties - -### max\_character\_limit - -> **max\_character\_limit**: `number` - -#### Defined in - -[src/parser/classes/ClipCreationTextInput.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationTextInput.ts#L10) - -*** - -### placeholder\_text - -> **placeholder\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ClipCreationTextInput.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationTextInput.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ClipCreationTextInput'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ClipCreationTextInput.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipCreationTextInput.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ClipCreationTextInput & { [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 ClipCreationTextInput & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ClipSection.md b/docs/api/namespaces/YTNodes/classes/ClipSection.md deleted file mode 100644 index 02145adc..00000000 --- a/docs/api/namespaces/YTNodes/classes/ClipSection.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ClipSection - -# Class: ClipSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ClipSection() - -> **new ClipSection**(`data`): [`ClipSection`](ClipSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ClipSection`](ClipSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ClipSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipSection.ts#L15) - -## Properties - -### contents - -> **contents**: `null` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ClipCreation`](ClipCreation.md)\> - -#### Defined in - -[src/parser/classes/ClipSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipSection.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ClipSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ClipSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ClipSection.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ClipSection & { [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 ClipSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md b/docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md deleted file mode 100644 index 86c86ea7..00000000 --- a/docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CollaboratorInfoCardContent - -# Class: CollaboratorInfoCardContent - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CollaboratorInfoCardContent() - -> **new CollaboratorInfoCardContent**(`data`): [`CollaboratorInfoCardContent`](CollaboratorInfoCardContent.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CollaboratorInfoCardContent`](CollaboratorInfoCardContent.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CollaboratorInfoCardContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollaboratorInfoCardContent.ts#L16) - -## Properties - -### channel\_avatar - -> **channel\_avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CollaboratorInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollaboratorInfoCardContent.ts#L10) - -*** - -### channel\_name - -> **channel\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CollaboratorInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollaboratorInfoCardContent.ts#L12) - -*** - -### custom\_text - -> **custom\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CollaboratorInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollaboratorInfoCardContent.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CollaboratorInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollaboratorInfoCardContent.ts#L14) - -*** - -### subscriber\_count - -> **subscriber\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CollaboratorInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollaboratorInfoCardContent.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CollaboratorInfoCardContent'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CollaboratorInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollaboratorInfoCardContent.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CollaboratorInfoCardContent & { [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 CollaboratorInfoCardContent & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CollageHeroImage.md b/docs/api/namespaces/YTNodes/classes/CollageHeroImage.md deleted file mode 100644 index a4d342b2..00000000 --- a/docs/api/namespaces/YTNodes/classes/CollageHeroImage.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CollageHeroImage - -# Class: CollageHeroImage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CollageHeroImage() - -> **new CollageHeroImage**(`data`): [`CollageHeroImage`](CollageHeroImage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CollageHeroImage`](CollageHeroImage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CollageHeroImage.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollageHeroImage.ts#L14) - -## Properties - -### bottom\_right - -> **bottom\_right**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CollageHeroImage.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollageHeroImage.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CollageHeroImage.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollageHeroImage.ts#L12) - -*** - -### left - -> **left**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CollageHeroImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollageHeroImage.ts#L9) - -*** - -### top\_right - -> **top\_right**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CollageHeroImage.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollageHeroImage.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CollageHeroImage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CollageHeroImage.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollageHeroImage.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CollageHeroImage & { [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 CollageHeroImage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md b/docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md deleted file mode 100644 index 1bbeb45d..00000000 --- a/docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md +++ /dev/null @@ -1,229 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CollectionThumbnailView - -# Class: CollectionThumbnailView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CollectionThumbnailView() - -> **new CollectionThumbnailView**(`data`): [`CollectionThumbnailView`](CollectionThumbnailView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CollectionThumbnailView`](CollectionThumbnailView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CollectionThumbnailView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollectionThumbnailView.ts#L14) - -## Properties - -### primary\_thumbnail - -> **primary\_thumbnail**: `null` \| [`ThumbnailView`](ThumbnailView.md) - -#### Defined in - -[src/parser/classes/CollectionThumbnailView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollectionThumbnailView.ts#L8) - -*** - -### stack\_color? - -> `optional` **stack\_color**: `object` - -#### dark\_theme - -> **dark\_theme**: `number` - -#### light\_theme - -> **light\_theme**: `number` - -#### Defined in - -[src/parser/classes/CollectionThumbnailView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollectionThumbnailView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CollectionThumbnailView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CollectionThumbnailView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CollectionThumbnailView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CollectionThumbnailView & { [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 CollectionThumbnailView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentActionButtons.md b/docs/api/namespaces/YTNodes/classes/CommentActionButtons.md deleted file mode 100644 index a7cacbd2..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentActionButtons.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentActionButtons - -# Class: CommentActionButtons - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentActionButtons() - -> **new CommentActionButtons**(`data`): [`CommentActionButtons`](CommentActionButtons.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentActionButtons`](CommentActionButtons.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentActionButtons.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentActionButtons.ts#L17) - -## Properties - -### creator\_heart - -> **creator\_heart**: `null` \| [`CreatorHeart`](CreatorHeart.md) - -#### Defined in - -[src/parser/classes/comments/CommentActionButtons.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentActionButtons.ts#L15) - -*** - -### dislike\_button - -> **dislike\_button**: `null` \| [`ToggleButton`](ToggleButton.md) - -#### Defined in - -[src/parser/classes/comments/CommentActionButtons.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentActionButtons.ts#L13) - -*** - -### like\_button - -> **like\_button**: `null` \| [`ToggleButton`](ToggleButton.md) - -#### Defined in - -[src/parser/classes/comments/CommentActionButtons.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentActionButtons.ts#L12) - -*** - -### reply\_button - -> **reply\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentActionButtons.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentActionButtons.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentActionButtons'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentActionButtons.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentActionButtons.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentActionButtons & { [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 CommentActionButtons & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentDialog.md b/docs/api/namespaces/YTNodes/classes/CommentDialog.md deleted file mode 100644 index 77b02f86..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentDialog.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentDialog - -# Class: CommentDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentDialog() - -> **new CommentDialog**(`data`): [`CommentDialog`](CommentDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentDialog`](CommentDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L21) - -## Properties - -### author\_thumbnail - -> **author\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L14) - -*** - -### cancel\_button - -> **cancel\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L16) - -*** - -### editable\_text - -> **editable\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L13) - -*** - -### emoji\_button - -> **emoji\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L18) - -*** - -### emoji\_picker - -> **emoji\_picker**: `null` \| [`EmojiPicker`](EmojiPicker.md) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L19) - -*** - -### placeholder - -> **placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L17) - -*** - -### submit\_button - -> **submit\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentDialog.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentDialog & { [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 CommentDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentReplies.md b/docs/api/namespaces/YTNodes/classes/CommentReplies.md deleted file mode 100644 index 6912860b..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentReplies.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentReplies - -# Class: CommentReplies - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentReplies() - -> **new CommentReplies**(`data`): [`CommentReplies`](CommentReplies.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentReplies`](CommentReplies.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentReplies.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplies.ts#L17) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/comments/CommentReplies.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplies.ts#L11) - -*** - -### has\_channel\_owner\_replied - -> **has\_channel\_owner\_replied**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentReplies.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplies.ts#L15) - -*** - -### hide\_replies - -> **hide\_replies**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentReplies.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplies.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_replies - -> **view\_replies**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentReplies.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplies.ts#L12) - -*** - -### view\_replies\_creator\_thumbnail - -> **view\_replies\_creator\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CommentReplies.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplies.ts#L14) - -*** - -### type - -> `static` **type**: `string` = `'CommentReplies'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentReplies.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplies.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentReplies & { [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 CommentReplies & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md b/docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md deleted file mode 100644 index c6bd5588..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentReplyDialog - -# Class: CommentReplyDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentReplyDialog() - -> **new CommentReplyDialog**(`data`): [`CommentReplyDialog`](CommentReplyDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentReplyDialog`](CommentReplyDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentReplyDialog.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplyDialog.ts#L18) - -## Properties - -### author\_thumbnail - -> **author\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CommentReplyDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplyDialog.ts#L14) - -*** - -### cancel\_button - -> **cancel\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentReplyDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplyDialog.ts#L13) - -*** - -### error\_message - -> **error\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentReplyDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplyDialog.ts#L16) - -*** - -### placeholder - -> **placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentReplyDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplyDialog.ts#L15) - -*** - -### reply\_button - -> **reply\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentReplyDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplyDialog.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentReplyDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentReplyDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentReplyDialog.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentReplyDialog & { [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 CommentReplyDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentSimplebox.md b/docs/api/namespaces/YTNodes/classes/CommentSimplebox.md deleted file mode 100644 index 994f37bd..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentSimplebox.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentSimplebox - -# Class: CommentSimplebox - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentSimplebox() - -> **new CommentSimplebox**(`data`): [`CommentSimplebox`](CommentSimplebox.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentSimplebox`](CommentSimplebox.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentSimplebox.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentSimplebox.ts#L18) - -## Properties - -### author\_thumbnail - -> **author\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CommentSimplebox.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentSimplebox.ts#L14) - -*** - -### avatar\_size - -> **avatar\_size**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentSimplebox.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentSimplebox.ts#L16) - -*** - -### cancel\_button - -> **cancel\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentSimplebox.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentSimplebox.ts#L13) - -*** - -### placeholder - -> **placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentSimplebox.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentSimplebox.ts#L15) - -*** - -### submit\_button - -> **submit\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/comments/CommentSimplebox.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentSimplebox.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentSimplebox'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentSimplebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentSimplebox.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentSimplebox & { [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 CommentSimplebox & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentThread.md b/docs/api/namespaces/YTNodes/classes/CommentThread.md deleted file mode 100644 index a5c1091b..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentThread.md +++ /dev/null @@ -1,315 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentThread - -# Class: CommentThread - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentThread() - -> **new CommentThread**(`data`): [`CommentThread`](CommentThread.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentThread`](CommentThread.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L26) - -## Properties - -### comment - -> **comment**: `null` \| [`CommentView`](CommentView.md) - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L17) - -*** - -### comment\_replies\_data - -> **comment\_replies\_data**: `null` \| [`CommentReplies`](CommentReplies.md) - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L19) - -*** - -### has\_replies - -> **has\_replies**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L21) - -*** - -### is\_moderated\_elq\_comment - -> **is\_moderated\_elq\_comment**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L20) - -*** - -### replies? - -> `optional` **replies**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CommentView`](CommentView.md)\> - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentThread'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L15) - -## Accessors - -### has\_continuation - -> `get` **has\_continuation**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L34) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### getContinuation() - -> **getContinuation**(): `Promise`\<[`CommentThread`](CommentThread.md)\> - -Retrieves next batch of replies. - -#### Returns - -`Promise`\<[`CommentThread`](CommentThread.md)\> - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L69) - -*** - -### getReplies() - -> **getReplies**(): `Promise`\<[`CommentThread`](CommentThread.md)\> - -Retrieves replies to this comment thread. - -#### Returns - -`Promise`\<[`CommentThread`](CommentThread.md)\> - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L43) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentThread & { [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 CommentThread & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) - -*** - -### setActions() - -> **setActions**(`actions`): `void` - -#### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -#### Returns - -`void` - -#### Defined in - -[src/parser/classes/comments/CommentThread.ts:95](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentThread.ts#L95) diff --git a/docs/api/namespaces/YTNodes/classes/CommentView.md b/docs/api/namespaces/YTNodes/classes/CommentView.md deleted file mode 100644 index 41e426c4..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentView.md +++ /dev/null @@ -1,697 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentView - -# Class: CommentView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentView() - -> **new CommentView**(`data`): [`CommentView`](CommentView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentView`](CommentView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:70](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L70) - -## Properties - -### author? - -> `optional` **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:62](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L62) - -*** - -### author\_is\_channel\_owner? - -> `optional` **author\_is\_channel\_owner**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L47) - -*** - -### comment\_id - -> **comment\_id**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L41) - -*** - -### content? - -> `optional` **content**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L45) - -*** - -### creator\_thumbnail\_url? - -> `optional` **creator\_thumbnail\_url**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:48](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L48) - -*** - -### dislike\_active\_tooltip? - -> `optional` **dislike\_active\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L55) - -*** - -### dislike\_command? - -> `optional` **dislike\_command**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L35) - -*** - -### dislike\_inactive\_tooltip? - -> `optional` **dislike\_inactive\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:56](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L56) - -*** - -### heart\_active\_tooltip? - -> `optional` **heart\_active\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:57](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L57) - -*** - -### is\_disliked? - -> `optional` **is\_disliked**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:65](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L65) - -*** - -### is\_hearted? - -> `optional` **is\_hearted**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:66](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L66) - -*** - -### is\_liked? - -> `optional` **is\_liked**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L64) - -*** - -### is\_member? - -> `optional` **is\_member**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:60](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L60) - -*** - -### is\_pinned - -> **is\_pinned**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L42) - -*** - -### keys - -> **keys**: `CommentKeys` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L43) - -*** - -### like\_active\_tooltip? - -> `optional` **like\_active\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:53](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L53) - -*** - -### like\_button\_a11y? - -> `optional` **like\_button\_a11y**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L49) - -*** - -### like\_command? - -> `optional` **like\_command**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L34) - -*** - -### like\_count? - -> `optional` **like\_count**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L50) - -*** - -### like\_count\_a11y? - -> `optional` **like\_count\_a11y**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:52](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L52) - -*** - -### like\_count\_liked? - -> `optional` **like\_count\_liked**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L51) - -*** - -### like\_inactive\_tooltip? - -> `optional` **like\_inactive\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:54](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L54) - -*** - -### member\_badge? - -> `optional` **member\_badge**: `MemberBadge` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:61](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L61) - -*** - -### prepare\_account\_command? - -> `optional` **prepare\_account\_command**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L39) - -*** - -### published\_time? - -> `optional` **published\_time**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L46) - -*** - -### reply\_command? - -> `optional` **reply\_command**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L38) - -*** - -### reply\_count? - -> `optional` **reply\_count**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:58](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L58) - -*** - -### reply\_count\_a11y? - -> `optional` **reply\_count\_a11y**: `string` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L59) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### undislike\_command? - -> `optional` **undislike\_command**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L37) - -*** - -### unlike\_command? - -> `optional` **unlike\_command**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L36) - -*** - -### voice\_reply\_container? - -> `optional` **voice\_reply\_container**: `null` \| [`VoiceReplyContainerView`](VoiceReplyContainerView.md) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:68](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L68) - -*** - -### type - -> `static` **type**: `string` = `'CommentView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L30) - -## Methods - -### applyMutations() - -> **applyMutations**(`comment`?, `toolbar_state`?, `toolbar_surface`?, `comment_surface`?): `void` - -#### Parameters - -• **comment?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -• **toolbar\_state?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -• **toolbar\_surface?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -• **comment\_surface?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -`void` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:85](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L85) - -*** - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### dislike() - -> **dislike**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Dislikes the comment. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -A promise that resolves to the API response. - -#### Throws - -If the Actions instance is not set for this comment or if the dislike command is not found. - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:167](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L167) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentView & { [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 CommentView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) - -*** - -### like() - -> **like**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Likes the comment. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -A promise that resolves to the API response. - -#### Throws - -If the Actions instance is not set for this comment or if the like command is not found. - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:149](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L149) - -*** - -### reply() - -> **reply**(`comment_text`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Replies to the comment. - -#### Parameters - -• **comment\_text**: `string` - -The text of the reply. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -A promise that resolves to the API response. - -#### Throws - -If the Actions instance is not set for this comment or if the reply command is not found. - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:222](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L222) - -*** - -### setActions() - -> **setActions**(`actions`): `void` - -#### Parameters - -• **actions**: `undefined` \| [`Actions`](../../../classes/Actions.md) - -#### Returns - -`void` - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:273](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L273) - -*** - -### translate() - -> **translate**(`target_language`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md) & `object`\> - -Translates the comment to the specified target language. - -#### Parameters - -• **target\_language**: `string` - -The target language to translate the comment to, e.g. 'en', 'ja'. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md) & `object`\> - -Resolves to an ApiResponse object with the translated content, if available. - -#### Throws - -if the Actions instance is not set for this comment or if the comment content is not found. - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:251](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L251) - -*** - -### undislike() - -> **undislike**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Undislikes the comment. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -A promise that resolves to the API response. - -#### Throws - -If the Actions instance is not set for this comment or if the undislike command is not found. - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:203](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L203) - -*** - -### unlike() - -> **unlike**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -Unlikes the comment. - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -A promise that resolves to the API response. - -#### Throws - -If the Actions instance is not set for this comment or if the unlike command is not found. - -#### Defined in - -[src/parser/classes/comments/CommentView.ts:185](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentView.ts#L185) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md b/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md deleted file mode 100644 index 916854a2..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentsEntryPointHeader - -# Class: CommentsEntryPointHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentsEntryPointHeader() - -> **new CommentsEntryPointHeader**(`data`): [`CommentsEntryPointHeader`](CommentsEntryPointHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentsEntryPointHeader`](CommentsEntryPointHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L19) - -## Properties - -### comment\_count? - -> `optional` **comment\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L13) - -*** - -### content\_renderer? - -> `optional` **content\_renderer**: `null` \| [`CommentsSimplebox`](CommentsSimplebox.md) \| [`CommentsEntryPointTeaser`](CommentsEntryPointTeaser.md) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L16) - -*** - -### header? - -> `optional` **header**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L12) - -*** - -### simplebox\_placeholder? - -> `optional` **simplebox\_placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L17) - -*** - -### teaser\_avatar? - -> `optional` **teaser\_avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L14) - -*** - -### teaser\_content? - -> `optional` **teaser\_content**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentsEntryPointHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointHeader.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentsEntryPointHeader & { [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 CommentsEntryPointHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md b/docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md deleted file mode 100644 index 35884f6e..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentsEntryPointTeaser - -# Class: CommentsEntryPointTeaser - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentsEntryPointTeaser() - -> **new CommentsEntryPointTeaser**(`data`): [`CommentsEntryPointTeaser`](CommentsEntryPointTeaser.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentsEntryPointTeaser`](CommentsEntryPointTeaser.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L12) - -## Properties - -### teaser\_avatar? - -> `optional` **teaser\_avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L9) - -*** - -### teaser\_content? - -> `optional` **teaser\_content**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentsEntryPointTeaser'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentsEntryPointTeaser & { [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 CommentsEntryPointTeaser & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsHeader.md b/docs/api/namespaces/YTNodes/classes/CommentsHeader.md deleted file mode 100644 index c61b37a5..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentsHeader.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentsHeader - -# Class: CommentsHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentsHeader() - -> **new CommentsHeader**(`data`): [`CommentsHeader`](CommentsHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentsHeader`](CommentsHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L27) - -## Properties - -### comments\_count - -> **comments\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L22) - -*** - -### count - -> **count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L21) - -*** - -### create\_renderer - -> **create\_renderer**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L23) - -*** - -### custom\_emojis? - -> `optional` **custom\_emojis**: `CustomEmoji`[] - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L25) - -*** - -### sort\_menu - -> **sort\_menu**: `null` \| [`SortFilterSubMenu`](SortFilterSubMenu.md) - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L24) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L20) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentsHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentsHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsHeader.ts#L18) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentsHeader & { [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 CommentsHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md b/docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md deleted file mode 100644 index 1f655c13..00000000 --- a/docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommentsSimplebox - -# Class: CommentsSimplebox - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CommentsSimplebox() - -> **new CommentsSimplebox**(`data`): [`CommentsSimplebox`](CommentsSimplebox.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CommentsSimplebox`](CommentsSimplebox.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CommentsSimplebox.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsSimplebox.ts#L12) - -## Properties - -### simplebox\_avatar - -> **simplebox\_avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CommentsSimplebox.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsSimplebox.ts#L9) - -*** - -### simplebox\_placeholder - -> **simplebox\_placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/CommentsSimplebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsSimplebox.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CommentsSimplebox'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CommentsSimplebox.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CommentsSimplebox.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CommentsSimplebox & { [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 CommentsSimplebox & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CompactChannel.md b/docs/api/namespaces/YTNodes/classes/CompactChannel.md deleted file mode 100644 index 52485bfb..00000000 --- a/docs/api/namespaces/YTNodes/classes/CompactChannel.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CompactChannel - -# Class: CompactChannel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CompactChannel() - -> **new CompactChannel**(`data`): [`CompactChannel`](CompactChannel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CompactChannel`](CompactChannel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L21) - -## Properties - -### channel\_id - -> **channel\_id**: `string` - -#### Defined in - -[src/parser/classes/CompactChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L12) - -*** - -### display\_name - -> **display\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L17) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L19) - -*** - -### subscriber\_count - -> **subscriber\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L16) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CompactChannel.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L11) - -*** - -### tv\_banner - -> **tv\_banner**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CompactChannel.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'CompactChannel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CompactChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactChannel.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CompactChannel & { [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 CompactChannel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CompactLink.md b/docs/api/namespaces/YTNodes/classes/CompactLink.md deleted file mode 100644 index 24290e10..00000000 --- a/docs/api/namespaces/YTNodes/classes/CompactLink.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CompactLink - -# Class: CompactLink - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CompactLink() - -> **new CompactLink**(`data`): [`CompactLink`](CompactLink.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CompactLink`](CompactLink.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CompactLink.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L16) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CompactLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L11) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/CompactLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L13) - -*** - -### secondary\_icon\_type? - -> `optional` **secondary\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/CompactLink.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L14) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/CompactLink.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L12) - -*** - -### subtitle? - -> `optional` **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L10) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/CompactLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CompactLink'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CompactLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactLink.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CompactLink & { [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 CompactLink & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CompactMovie.md b/docs/api/namespaces/YTNodes/classes/CompactMovie.md deleted file mode 100644 index e2f443eb..00000000 --- a/docs/api/namespaces/YTNodes/classes/CompactMovie.md +++ /dev/null @@ -1,319 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CompactMovie - -# Class: CompactMovie - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CompactMovie() - -> **new CompactMovie**(`data`): [`CompactMovie`](CompactMovie.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CompactMovie`](CompactMovie.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CompactMovie.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L31) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/CompactMovie.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L19) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/CompactMovie.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L27) - -*** - -### duration - -> **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/CompactMovie.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L21) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CompactMovie.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L26) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/CompactMovie.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L14) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/CompactMovie.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L29) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/CompactMovie.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L18) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CompactMovie.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L17) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactMovie.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L15) - -*** - -### top\_metadata\_items - -> **top\_metadata\_items**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactMovie.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### use\_vertical\_poster - -> **use\_vertical\_poster**: `boolean` - -#### Defined in - -[src/parser/classes/CompactMovie.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L28) - -*** - -### type - -> `static` **type**: `string` = `'CompactMovie'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CompactMovie.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactMovie.ts#L12) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CompactMovie & { [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 CompactMovie & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CompactStation.md b/docs/api/namespaces/YTNodes/classes/CompactStation.md deleted file mode 100644 index 6ff68f5f..00000000 --- a/docs/api/namespaces/YTNodes/classes/CompactStation.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CompactStation - -# Class: CompactStation - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CompactStation() - -> **new CompactStation**(`data`): [`CompactStation`](CompactStation.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CompactStation`](CompactStation.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CompactStation.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactStation.ts#L16) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactStation.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactStation.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CompactStation.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactStation.ts#L13) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CompactStation.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactStation.ts#L14) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactStation.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactStation.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactStation.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactStation.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'CompactStation'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CompactStation.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactStation.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CompactStation & { [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 CompactStation & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CompactVideo.md b/docs/api/namespaces/YTNodes/classes/CompactVideo.md deleted file mode 100644 index 7a0e63d9..00000000 --- a/docs/api/namespaces/YTNodes/classes/CompactVideo.md +++ /dev/null @@ -1,501 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CompactVideo - -# Class: CompactVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CompactVideo() - -> **new CompactVideo**(`data`): [`CompactVideo`](CompactVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CompactVideo`](CompactVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L35) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L19) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MetadataBadge`](MetadataBadge.md)\> - -#### Defined in - -[src/parser/classes/CompactVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L25) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L27) - -*** - -### is\_watched - -> **is\_watched**: `boolean` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L30) - -*** - -### length\_text? - -> `optional` **length\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L29) - -*** - -### long\_byline\_text? - -> `optional` **long\_byline\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L23) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L28) - -*** - -### published? - -> `optional` **published**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L24) - -*** - -### rich\_thumbnail? - -> `optional` **rich\_thumbnail**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L17) - -*** - -### service\_endpoint? - -> `optional` **service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L32) - -*** - -### service\_endpoints? - -> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/classes/CompactVideo.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L31) - -*** - -### short\_byline\_text? - -> `optional` **short\_byline\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L22) - -*** - -### short\_view\_count? - -> `optional` **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L21) - -*** - -### style? - -> `optional` **style**: `"COMPACT_VIDEO_STYLE_TYPE_UNKNOWN"` \| `"COMPACT_VIDEO_STYLE_TYPE_NORMAL"` \| `"COMPACT_VIDEO_STYLE_TYPE_PROMINENT_THUMBNAIL"` \| `"COMPACT_VIDEO_STYLE_TYPE_HERO"` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L33) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/CompactVideo.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L26) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/CompactVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L16) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L15) - -*** - -### view\_count? - -> `optional` **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L20) - -*** - -### type - -> `static` **type**: `string` = `'CompactVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L13) - -## Accessors - -### best\_thumbnail - -> `get` **best\_thumbnail**(): [`Thumbnail`](../../Misc/classes/Thumbnail.md) - -#### Returns - -[`Thumbnail`](../../Misc/classes/Thumbnail.md) - -#### Defined in - -[src/parser/classes/CompactVideo.ts:96](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L96) - -*** - -### duration - -> `get` **duration**(): `object` - -#### Returns - -`object` - -##### seconds - -> **seconds**: `number` - -##### text - -> **text**: `undefined` \| `string` = `length_text` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:87](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L87) - -*** - -### id - -> `get` **id**(): `string` - -#### Deprecated - -Use [`video_id`](CompactVideo.md#video_id) instead. - -#### Returns - -`string` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:83](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L83) - -*** - -### is\_fundraiser - -> `get` **is\_fundraiser**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:100](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L100) - -*** - -### is\_live - -> `get` **is\_live**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:104](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L104) - -*** - -### is\_new - -> `get` **is\_new**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:111](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L111) - -*** - -### is\_premiere - -> `get` **is\_premiere**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/CompactVideo.ts:115](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CompactVideo.ts#L115) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CompactVideo & { [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 CompactVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ConfirmDialog.md b/docs/api/namespaces/YTNodes/classes/ConfirmDialog.md deleted file mode 100644 index 87e303c9..00000000 --- a/docs/api/namespaces/YTNodes/classes/ConfirmDialog.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ConfirmDialog - -# Class: ConfirmDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ConfirmDialog() - -> **new ConfirmDialog**(`data`): [`ConfirmDialog`](ConfirmDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ConfirmDialog`](ConfirmDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ConfirmDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ConfirmDialog.ts#L14) - -## Properties - -### cancel\_button - -> **cancel\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ConfirmDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ConfirmDialog.ts#L11) - -*** - -### confirm\_button - -> **confirm\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ConfirmDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ConfirmDialog.ts#L10) - -*** - -### dialog\_messages - -> **dialog\_messages**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/ConfirmDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ConfirmDialog.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ConfirmDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ConfirmDialog.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ConfirmDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ConfirmDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ConfirmDialog.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ConfirmDialog & { [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 ConfirmDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ContentMetadataView.md b/docs/api/namespaces/YTNodes/classes/ContentMetadataView.md deleted file mode 100644 index 1df5450a..00000000 --- a/docs/api/namespaces/YTNodes/classes/ContentMetadataView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ContentMetadataView - -# Class: ContentMetadataView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ContentMetadataView() - -> **new ContentMetadataView**(`data`): [`ContentMetadataView`](ContentMetadataView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ContentMetadataView`](ContentMetadataView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ContentMetadataView.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentMetadataView.ts#L24) - -## Properties - -### delimiter - -> **delimiter**: `string` - -#### Defined in - -[src/parser/classes/ContentMetadataView.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentMetadataView.ts#L22) - -*** - -### metadata\_rows - -> **metadata\_rows**: `MetadataRow`[] - -#### Defined in - -[src/parser/classes/ContentMetadataView.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentMetadataView.ts#L21) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ContentMetadataView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ContentMetadataView.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentMetadataView.ts#L19) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ContentMetadataView & { [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 ContentMetadataView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md b/docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md deleted file mode 100644 index 2d958619..00000000 --- a/docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ContentPreviewImageView - -# Class: ContentPreviewImageView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ContentPreviewImageView() - -> **new ContentPreviewImageView**(`data`): [`ContentPreviewImageView`](ContentPreviewImageView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ContentPreviewImageView`](ContentPreviewImageView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ContentPreviewImageView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentPreviewImageView.ts#L11) - -## Properties - -### image - -> **image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ContentPreviewImageView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentPreviewImageView.ts#L8) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/ContentPreviewImageView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentPreviewImageView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ContentPreviewImageView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ContentPreviewImageView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContentPreviewImageView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ContentPreviewImageView & { [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 ContentPreviewImageView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ContinuationCommand.md b/docs/api/namespaces/YTNodes/classes/ContinuationCommand.md deleted file mode 100644 index 312577db..00000000 --- a/docs/api/namespaces/YTNodes/classes/ContinuationCommand.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ContinuationCommand - -# Class: ContinuationCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`ContinuationRequest`](../../APIResponseTypes/type-aliases/ContinuationRequest.md)\> - -## Constructors - -### new ContinuationCommand() - -> **new ContinuationCommand**(`data`): [`ContinuationCommand`](ContinuationCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ContinuationCommand`](ContinuationCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/commands/ContinuationCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ContinuationCommand.ts#L9) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ContinuationCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/commands/ContinuationCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ContinuationCommand.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`ContinuationRequest`](../../APIResponseTypes/type-aliases/ContinuationRequest.md) - -#### Returns - -[`ContinuationRequest`](../../APIResponseTypes/type-aliases/ContinuationRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/commands/ContinuationCommand.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ContinuationCommand.ts#L37) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/commands/ContinuationCommand.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ContinuationCommand.ts#L14) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ContinuationCommand & { [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 ContinuationCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ContinuationItem.md b/docs/api/namespaces/YTNodes/classes/ContinuationItem.md deleted file mode 100644 index 80900318..00000000 --- a/docs/api/namespaces/YTNodes/classes/ContinuationItem.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ContinuationItem - -# Class: ContinuationItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ContinuationItem() - -> **new ContinuationItem**(`data`): [`ContinuationItem`](ContinuationItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ContinuationItem`](ContinuationItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ContinuationItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContinuationItem.ts#L13) - -## Properties - -### button? - -> `optional` **button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ContinuationItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContinuationItem.ts#L10) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ContinuationItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContinuationItem.ts#L11) - -*** - -### trigger - -> **trigger**: `string` - -#### Defined in - -[src/parser/classes/ContinuationItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContinuationItem.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ContinuationItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ContinuationItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ContinuationItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ContinuationItem & { [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 ContinuationItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CopyLink.md b/docs/api/namespaces/YTNodes/classes/CopyLink.md deleted file mode 100644 index 87888cf5..00000000 --- a/docs/api/namespaces/YTNodes/classes/CopyLink.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CopyLink - -# Class: CopyLink - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CopyLink() - -> **new CopyLink**(`data`): [`CopyLink`](CopyLink.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CopyLink`](CopyLink.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CopyLink.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CopyLink.ts#L12) - -## Properties - -### copy\_button - -> **copy\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/CopyLink.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CopyLink.ts#L8) - -*** - -### short\_url - -> **short\_url**: `string` - -#### Defined in - -[src/parser/classes/CopyLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CopyLink.ts#L9) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/CopyLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CopyLink.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CopyLink'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CopyLink.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CopyLink.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CopyLink & { [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 CopyLink & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CreateCommentEndpoint.md b/docs/api/namespaces/YTNodes/classes/CreateCommentEndpoint.md deleted file mode 100644 index e14b4815..00000000 --- a/docs/api/namespaces/YTNodes/classes/CreateCommentEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CreateCommentEndpoint - -# Class: CreateCommentEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`CreateCommentRequest`](../../APIResponseTypes/type-aliases/CreateCommentRequest.md)\> - -## Constructors - -### new CreateCommentEndpoint() - -> **new CreateCommentEndpoint**(`data`): [`CreateCommentEndpoint`](CreateCommentEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CreateCommentEndpoint`](CreateCommentEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/CreateCommentEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreateCommentEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CreateCommentEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/CreateCommentEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreateCommentEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`CreateCommentRequest`](../../APIResponseTypes/type-aliases/CreateCommentRequest.md) - -#### Returns - -[`CreateCommentRequest`](../../APIResponseTypes/type-aliases/CreateCommentRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/CreateCommentEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreateCommentEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/CreateCommentEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreateCommentEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CreateCommentEndpoint & { [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 CreateCommentEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md b/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md deleted file mode 100644 index fa95450c..00000000 --- a/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CreatePlaylistDialog - -# Class: CreatePlaylistDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CreatePlaylistDialog() - -> **new CreatePlaylistDialog**(`data`): [`CreatePlaylistDialog`](CreatePlaylistDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CreatePlaylistDialog`](CreatePlaylistDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialog.ts#L16) - -## Properties - -### cancel\_button - -> **cancel\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialog.ts#L13) - -*** - -### create\_button - -> **create\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialog.ts#L14) - -*** - -### privacy\_option - -> **privacy\_option**: `null` \| [`Dropdown`](Dropdown.md) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialog.ts#L12) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/CreatePlaylistDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialog.ts#L10) - -*** - -### title\_placeholder - -> **title\_placeholder**: `string` - -#### Defined in - -[src/parser/classes/CreatePlaylistDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialog.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CreatePlaylistDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialog.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CreatePlaylistDialog & { [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 CreatePlaylistDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialogFormView.md b/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialogFormView.md deleted file mode 100644 index f2246755..00000000 --- a/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialogFormView.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CreatePlaylistDialogFormView - -# Class: CreatePlaylistDialogFormView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CreatePlaylistDialogFormView() - -> **new CreatePlaylistDialogFormView**(`data`): [`CreatePlaylistDialogFormView`](CreatePlaylistDialogFormView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CreatePlaylistDialogFormView`](CreatePlaylistDialogFormView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L16) - -## Properties - -### create\_playlist\_params\_collaboration\_disabled - -> **create\_playlist\_params\_collaboration\_disabled**: `string` - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L13) - -*** - -### create\_playlist\_params\_collaboration\_enabled - -> **create\_playlist\_params\_collaboration\_enabled**: `string` - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L12) - -*** - -### disable\_playlist\_collaborate - -> **disable\_playlist\_collaborate**: `boolean` - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L11) - -*** - -### playlist\_title - -> **playlist\_title**: `null` \| [`TextFieldView`](TextFieldView.md) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L9) - -*** - -### playlist\_visibility - -> **playlist\_visibility**: `null` \| [`DropdownView`](DropdownView.md) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_ids - -> **video\_ids**: `string`[] - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L14) - -*** - -### type - -> `static` **type**: `string` = `'CreatePlaylistDialogFormView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/CreatePlaylistDialogFormView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/CreatePlaylistDialogFormView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CreatePlaylistDialogFormView & { [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 CreatePlaylistDialogFormView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CreatePlaylistServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/CreatePlaylistServiceEndpoint.md deleted file mode 100644 index 28ff2e17..00000000 --- a/docs/api/namespaces/YTNodes/classes/CreatePlaylistServiceEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CreatePlaylistServiceEndpoint - -# Class: CreatePlaylistServiceEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`CreatePlaylistServiceRequest`](../../APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md)\> - -## Constructors - -### new CreatePlaylistServiceEndpoint() - -> **new CreatePlaylistServiceEndpoint**(`data`): [`CreatePlaylistServiceEndpoint`](CreatePlaylistServiceEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CreatePlaylistServiceEndpoint`](CreatePlaylistServiceEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CreatePlaylistServiceEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`CreatePlaylistServiceRequest`](../../APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md) - -#### Returns - -[`CreatePlaylistServiceRequest`](../../APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CreatePlaylistServiceEndpoint & { [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 CreatePlaylistServiceEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CreatorHeart.md b/docs/api/namespaces/YTNodes/classes/CreatorHeart.md deleted file mode 100644 index d78d5f26..00000000 --- a/docs/api/namespaces/YTNodes/classes/CreatorHeart.md +++ /dev/null @@ -1,279 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CreatorHeart - -# Class: CreatorHeart - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CreatorHeart() - -> **new CreatorHeart**(`data`): [`CreatorHeart`](CreatorHeart.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CreatorHeart`](CreatorHeart.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L20) - -## Properties - -### creator\_thumbnail - -> **creator\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L8) - -*** - -### heart\_color - -> **heart\_color**: `object` - -#### basic\_color\_palette\_data - -> **basic\_color\_palette\_data**: `object` - -#### basic\_color\_palette\_data.foreground\_title\_color - -> **foreground\_title\_color**: `string` - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L10) - -*** - -### heart\_icon\_type? - -> `optional` **heart\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L9) - -*** - -### hearted\_tooltip - -> **hearted\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L15) - -*** - -### is\_enabled - -> **is\_enabled**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L17) - -*** - -### is\_hearted - -> **is\_hearted**: `boolean` - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L16) - -*** - -### kennedy\_heart\_color\_string - -> **kennedy\_heart\_color\_string**: `string` - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'CreatorHeart'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/CreatorHeart.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/CreatorHeart.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CreatorHeart & { [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 CreatorHeart & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/CreatorHeartView.md b/docs/api/namespaces/YTNodes/classes/CreatorHeartView.md deleted file mode 100644 index f3d91b8e..00000000 --- a/docs/api/namespaces/YTNodes/classes/CreatorHeartView.md +++ /dev/null @@ -1,293 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CreatorHeartView - -# Class: CreatorHeartView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new CreatorHeartView() - -> **new CreatorHeartView**(`data`): [`CreatorHeartView`](CreatorHeartView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`CreatorHeartView`](CreatorHeartView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L23) - -## Properties - -### creator\_thumbnail - -> **creator\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L8) - -*** - -### engagement\_state\_key - -> **engagement\_state\_key**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L21) - -*** - -### hearted\_accessibility\_label - -> **hearted\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L19) - -*** - -### hearted\_hover\_text - -> **hearted\_hover\_text**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L18) - -*** - -### hearted\_icon\_name - -> **hearted\_icon\_name**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### unhearted\_accessibility\_label - -> **unhearted\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L20) - -*** - -### unhearted\_icon\_name - -> **unhearted\_icon\_name**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L10) - -*** - -### unhearted\_icon\_processor - -> **unhearted\_icon\_processor**: `object` - -#### border\_image\_processor - -> **border\_image\_processor**: `object` - -#### border\_image\_processor.image\_tint - -> **image\_tint**: `object` - -#### border\_image\_processor.image\_tint.color - -> **color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L11) - -*** - -### type - -> `static` **type**: `string` = `'CreatorHeartView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/CreatorHeartView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/CreatorHeartView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is CreatorHeartView & { [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 CreatorHeartView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md b/docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md deleted file mode 100644 index 13e51a23..00000000 --- a/docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DecoratedAvatarView - -# Class: DecoratedAvatarView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DecoratedAvatarView() - -> **new DecoratedAvatarView**(`data`): [`DecoratedAvatarView`](DecoratedAvatarView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DecoratedAvatarView`](DecoratedAvatarView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DecoratedAvatarView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedAvatarView.ts#L13) - -## Properties - -### a11y\_label - -> **a11y\_label**: `string` - -#### Defined in - -[src/parser/classes/DecoratedAvatarView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedAvatarView.ts#L10) - -*** - -### avatar - -> **avatar**: `null` \| [`AvatarView`](AvatarView.md) - -#### Defined in - -[src/parser/classes/DecoratedAvatarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedAvatarView.ts#L9) - -*** - -### renderer\_context - -> **renderer\_context**: [`RendererContext`](../../Misc/classes/RendererContext.md) - -#### Defined in - -[src/parser/classes/DecoratedAvatarView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedAvatarView.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DecoratedAvatarView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DecoratedAvatarView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedAvatarView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DecoratedAvatarView & { [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 DecoratedAvatarView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md b/docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md deleted file mode 100644 index 94ce4498..00000000 --- a/docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DecoratedPlayerBar - -# Class: DecoratedPlayerBar - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DecoratedPlayerBar() - -> **new DecoratedPlayerBar**(`data`): [`DecoratedPlayerBar`](DecoratedPlayerBar.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DecoratedPlayerBar`](DecoratedPlayerBar.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DecoratedPlayerBar.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedPlayerBar.ts#L13) - -## Properties - -### player\_bar - -> **player\_bar**: `null` \| [`MultiMarkersPlayerBar`](MultiMarkersPlayerBar.md) - -#### Defined in - -[src/parser/classes/DecoratedPlayerBar.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedPlayerBar.ts#L10) - -*** - -### player\_bar\_action\_button - -> **player\_bar\_action\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/DecoratedPlayerBar.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedPlayerBar.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DecoratedPlayerBar'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DecoratedPlayerBar.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DecoratedPlayerBar.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DecoratedPlayerBar & { [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 DecoratedPlayerBar & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md b/docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md deleted file mode 100644 index bac23e46..00000000 --- a/docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md +++ /dev/null @@ -1,311 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DefaultPromoPanel - -# Class: DefaultPromoPanel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DefaultPromoPanel() - -> **new DefaultPromoPanel**(`data`): [`DefaultPromoPanel`](DefaultPromoPanel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DefaultPromoPanel`](DefaultPromoPanel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L21) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L10) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L11) - -*** - -### large\_form\_factor\_background\_thumbnail - -> **large\_form\_factor\_background\_thumbnail**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L12) - -*** - -### metadata\_order - -> **metadata\_order**: `string` - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L18) - -*** - -### min\_panel\_display\_duration\_ms - -> **min\_panel\_display\_duration\_ms**: `number` - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L15) - -*** - -### min\_video\_play\_duration\_ms - -> **min\_video\_play\_duration\_ms**: `number` - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L16) - -*** - -### panel\_layout - -> **panel\_layout**: `string` - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L19) - -*** - -### scrim\_color\_values - -> **scrim\_color\_values**: `number`[] - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L14) - -*** - -### scrim\_duration - -> **scrim\_duration**: `number` - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L17) - -*** - -### small\_form\_factor\_background\_thumbnail - -> **small\_form\_factor\_background\_thumbnail**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DefaultPromoPanel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DefaultPromoPanel.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DefaultPromoPanel.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DefaultPromoPanel & { [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 DefaultPromoPanel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DeletePlaylistEndpoint.md b/docs/api/namespaces/YTNodes/classes/DeletePlaylistEndpoint.md deleted file mode 100644 index 2fa0272e..00000000 --- a/docs/api/namespaces/YTNodes/classes/DeletePlaylistEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DeletePlaylistEndpoint - -# Class: DeletePlaylistEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`DeletePlaylistServiceRequest`](../../APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md)\> - -## Constructors - -### new DeletePlaylistEndpoint() - -> **new DeletePlaylistEndpoint**(`data`): [`DeletePlaylistEndpoint`](DeletePlaylistEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DeletePlaylistEndpoint`](DeletePlaylistEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/DeletePlaylistEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/DeletePlaylistEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DeletePlaylistEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/DeletePlaylistEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/DeletePlaylistEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`DeletePlaylistServiceRequest`](../../APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md) - -#### Returns - -[`DeletePlaylistServiceRequest`](../../APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/DeletePlaylistEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/DeletePlaylistEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/DeletePlaylistEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/DeletePlaylistEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DeletePlaylistEndpoint & { [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 DeletePlaylistEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md b/docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md deleted file mode 100644 index a06e0d5d..00000000 --- a/docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md +++ /dev/null @@ -1,285 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DescriptionPreviewView - -# Class: DescriptionPreviewView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DescriptionPreviewView() - -> **new DescriptionPreviewView**(`data`): [`DescriptionPreviewView`](DescriptionPreviewView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DescriptionPreviewView`](DescriptionPreviewView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L26) - -## Properties - -### always\_show\_truncation\_text - -> **always\_show\_truncation\_text**: `boolean` - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L13) - -*** - -### description? - -> `optional` **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L10) - -*** - -### max\_lines? - -> `optional` **max\_lines**: `number` - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L11) - -*** - -### more\_endpoint? - -> `optional` **more\_endpoint**: `object` - -#### show\_engagement\_panel\_endpoint - -> **show\_engagement\_panel\_endpoint**: `object` - -#### show\_engagement\_panel\_endpoint.engagement\_panel - -> **engagement\_panel**: `null` \| [`EngagementPanelSectionList`](EngagementPanelSectionList.md) - -#### show\_engagement\_panel\_endpoint.engagement\_panel\_popup\_type - -> **engagement\_panel\_popup\_type**: `string` - -#### show\_engagement\_panel\_endpoint.identifier - -> **identifier**: `object` - -#### show\_engagement\_panel\_endpoint.identifier.surface - -> **surface**: `string` - -#### show\_engagement\_panel\_endpoint.identifier.tag - -> **tag**: `string` - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L14) - -*** - -### renderer\_context - -> **renderer\_context**: [`RendererContext`](../../Misc/classes/RendererContext.md) - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L24) - -*** - -### truncation\_text? - -> `optional` **truncation\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DescriptionPreviewView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DescriptionPreviewView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DescriptionPreviewView.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DescriptionPreviewView & { [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 DescriptionPreviewView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DialogView.md b/docs/api/namespaces/YTNodes/classes/DialogView.md deleted file mode 100644 index 0a6a0e75..00000000 --- a/docs/api/namespaces/YTNodes/classes/DialogView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DialogView - -# Class: DialogView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DialogView() - -> **new DialogView**(`data`): [`DialogView`](DialogView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DialogView`](DialogView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DialogView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DialogView.ts#L16) - -## Properties - -### custom\_content - -> **custom\_content**: `null` \| [`CreatePlaylistDialogFormView`](CreatePlaylistDialogFormView.md) \| [`ListView`](ListView.md) - -#### Defined in - -[src/parser/classes/DialogView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DialogView.ts#L14) - -*** - -### footer - -> **footer**: `null` \| [`PanelFooterView`](PanelFooterView.md) \| [`FormFooterView`](FormFooterView.md) - -#### Defined in - -[src/parser/classes/DialogView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DialogView.ts#L13) - -*** - -### header - -> **header**: `null` \| [`DialogHeaderView`](DialogHeaderView.md) - -#### Defined in - -[src/parser/classes/DialogView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DialogView.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DialogView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DialogView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DialogView.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DialogView & { [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 DialogView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DidYouMean.md b/docs/api/namespaces/YTNodes/classes/DidYouMean.md deleted file mode 100644 index bee549d9..00000000 --- a/docs/api/namespaces/YTNodes/classes/DidYouMean.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DidYouMean - -# Class: DidYouMean - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DidYouMean() - -> **new DidYouMean**(`data`): [`DidYouMean`](DidYouMean.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DidYouMean`](DidYouMean.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DidYouMean.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DidYouMean.ts#L13) - -## Properties - -### corrected\_query - -> **corrected\_query**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DidYouMean.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DidYouMean.ts#L10) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/DidYouMean.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DidYouMean.ts#L11) - -*** - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/DidYouMean.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DidYouMean.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DidYouMean'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DidYouMean.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DidYouMean.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DidYouMean & { [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 DidYouMean & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DislikeButtonView.md b/docs/api/namespaces/YTNodes/classes/DislikeButtonView.md deleted file mode 100644 index 9e81fb55..00000000 --- a/docs/api/namespaces/YTNodes/classes/DislikeButtonView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DislikeButtonView - -# Class: DislikeButtonView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DislikeButtonView() - -> **new DislikeButtonView**(`data`): [`DislikeButtonView`](DislikeButtonView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DislikeButtonView`](DislikeButtonView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DislikeButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DislikeButtonView.ts#L11) - -## Properties - -### dislike\_entity\_key - -> **dislike\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/DislikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DislikeButtonView.ts#L9) - -*** - -### toggle\_button - -> **toggle\_button**: `null` \| [`ToggleButtonView`](ToggleButtonView.md) - -#### Defined in - -[src/parser/classes/DislikeButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DislikeButtonView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DislikeButtonView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DislikeButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DislikeButtonView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DislikeButtonView & { [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 DislikeButtonView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DismissableDialog.md b/docs/api/namespaces/YTNodes/classes/DismissableDialog.md deleted file mode 100644 index c21722dd..00000000 --- a/docs/api/namespaces/YTNodes/classes/DismissableDialog.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DismissableDialog - -# Class: DismissableDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DismissableDialog() - -> **new DismissableDialog**(`data`): [`DismissableDialog`](DismissableDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DismissableDialog`](DismissableDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DismissableDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialog.ts#L13) - -## Properties - -### display\_style - -> **display\_style**: `string` - -#### Defined in - -[src/parser/classes/DismissableDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialog.ts#L11) - -*** - -### metadata - -> **metadata**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/DismissableDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialog.ts#L10) - -*** - -### sections - -> **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`DismissableDialogContentSection`](DismissableDialogContentSection.md)\> - -#### Defined in - -[src/parser/classes/DismissableDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialog.ts#L9) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/DismissableDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialog.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DismissableDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DismissableDialog.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialog.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DismissableDialog & { [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 DismissableDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DismissableDialogContentSection.md b/docs/api/namespaces/YTNodes/classes/DismissableDialogContentSection.md deleted file mode 100644 index 1578477a..00000000 --- a/docs/api/namespaces/YTNodes/classes/DismissableDialogContentSection.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DismissableDialogContentSection - -# Class: DismissableDialogContentSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DismissableDialogContentSection() - -> **new DismissableDialogContentSection**(`data`): [`DismissableDialogContentSection`](DismissableDialogContentSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DismissableDialogContentSection`](DismissableDialogContentSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DismissableDialogContentSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialogContentSection.ts#L11) - -## Properties - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DismissableDialogContentSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialogContentSection.ts#L9) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DismissableDialogContentSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialogContentSection.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DismissableDialogContentSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DismissableDialogContentSection.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DismissableDialogContentSection.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DismissableDialogContentSection & { [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 DismissableDialogContentSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DownloadButton.md b/docs/api/namespaces/YTNodes/classes/DownloadButton.md deleted file mode 100644 index 70ea7031..00000000 --- a/docs/api/namespaces/YTNodes/classes/DownloadButton.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DownloadButton - -# Class: DownloadButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DownloadButton() - -> **new DownloadButton**(`data`): [`DownloadButton`](DownloadButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DownloadButton`](DownloadButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DownloadButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DownloadButton.ts#L13) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/DownloadButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DownloadButton.ts#L10) - -*** - -### size - -> **size**: `string` - -#### Defined in - -[src/parser/classes/DownloadButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DownloadButton.ts#L9) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/DownloadButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DownloadButton.ts#L8) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/DownloadButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DownloadButton.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DownloadButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DownloadButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DownloadButton.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DownloadButton & { [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 DownloadButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DropdownItem.md b/docs/api/namespaces/YTNodes/classes/DropdownItem.md deleted file mode 100644 index 307aa635..00000000 --- a/docs/api/namespaces/YTNodes/classes/DropdownItem.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DropdownItem - -# Class: DropdownItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DropdownItem() - -> **new DropdownItem**(`data`): [`DropdownItem`](DropdownItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DropdownItem`](DropdownItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DropdownItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L16) - -## Properties - -### description? - -> `optional` **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DropdownItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L13) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/DropdownItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L14) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/DropdownItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L12) - -*** - -### label - -> **label**: `string` - -#### Defined in - -[src/parser/classes/DropdownItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L9) - -*** - -### selected - -> **selected**: `boolean` - -#### Defined in - -[src/parser/classes/DropdownItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### value? - -> `optional` **value**: `string` \| `number` - -#### Defined in - -[src/parser/classes/DropdownItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L11) - -*** - -### type - -> `static` **type**: `string` = `'DropdownItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DropdownItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DropdownItem & { [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 DropdownItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DropdownView.md b/docs/api/namespaces/YTNodes/classes/DropdownView.md deleted file mode 100644 index 371b8f29..00000000 --- a/docs/api/namespaces/YTNodes/classes/DropdownView.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DropdownView - -# Class: DropdownView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DropdownView() - -> **new DropdownView**(`data`): [`DropdownView`](DropdownView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DropdownView`](DropdownView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DropdownView.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L27) - -## Properties - -### disabled - -> **disabled**: `boolean` - -#### Defined in - -[src/parser/classes/DropdownView.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L22) - -*** - -### dropdown\_type - -> **dropdown\_type**: `string` - -#### Defined in - -[src/parser/classes/DropdownView.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L24) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/DropdownView.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L25) - -*** - -### label - -> **label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DropdownView.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L20) - -*** - -### options? - -> `optional` **options**: `Option`[] - -#### Defined in - -[src/parser/classes/DropdownView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L23) - -*** - -### placeholder\_text - -> **placeholder\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DropdownView.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L21) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DropdownView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DropdownView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DropdownView.ts#L18) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DropdownView & { [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 DropdownView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/DynamicTextView.md b/docs/api/namespaces/YTNodes/classes/DynamicTextView.md deleted file mode 100644 index f3a0d16f..00000000 --- a/docs/api/namespaces/YTNodes/classes/DynamicTextView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DynamicTextView - -# Class: DynamicTextView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new DynamicTextView() - -> **new DynamicTextView**(`data`): [`DynamicTextView`](DynamicTextView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`DynamicTextView`](DynamicTextView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/DynamicTextView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DynamicTextView.ts#L11) - -## Properties - -### max\_lines - -> **max\_lines**: `number` - -#### Defined in - -[src/parser/classes/DynamicTextView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DynamicTextView.ts#L9) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/DynamicTextView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DynamicTextView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'DynamicTextView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/DynamicTextView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/DynamicTextView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is DynamicTextView & { [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 DynamicTextView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md b/docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md deleted file mode 100644 index 3742fd2b..00000000 --- a/docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EmergencyOnebox - -# Class: EmergencyOnebox - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EmergencyOnebox() - -> **new EmergencyOnebox**(`data`): [`EmergencyOnebox`](EmergencyOnebox.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EmergencyOnebox`](EmergencyOnebox.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EmergencyOnebox.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmergencyOnebox.ts#L13) - -## Properties - -### first\_option - -> **first\_option**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/EmergencyOnebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmergencyOnebox.ts#L10) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/EmergencyOnebox.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmergencyOnebox.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EmergencyOnebox.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmergencyOnebox.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'EmergencyOnebox'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EmergencyOnebox.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmergencyOnebox.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EmergencyOnebox & { [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 EmergencyOnebox & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPicker.md b/docs/api/namespaces/YTNodes/classes/EmojiPicker.md deleted file mode 100644 index 461da081..00000000 --- a/docs/api/namespaces/YTNodes/classes/EmojiPicker.md +++ /dev/null @@ -1,331 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EmojiPicker - -# Class: EmojiPicker - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EmojiPicker() - -> **new EmojiPicker**(`data`): [`EmojiPicker`](EmojiPicker.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EmojiPicker`](EmojiPicker.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L23) - -## Properties - -### categories - -> **categories**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L10) - -*** - -### category\_buttons - -> **category\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L11) - -*** - -### clear\_search\_label - -> **clear\_search\_label**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L9) - -*** - -### pick\_skin\_tone - -> **pick\_skin\_tone**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L14) - -*** - -### search\_no\_results - -> **search\_no\_results**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L13) - -*** - -### search\_placeholder - -> **search\_placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L12) - -*** - -### skin\_tone\_dark\_label - -> **skin\_tone\_dark\_label**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L21) - -*** - -### skin\_tone\_generic\_label - -> **skin\_tone\_generic\_label**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L16) - -*** - -### skin\_tone\_light\_label - -> **skin\_tone\_light\_label**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L17) - -*** - -### skin\_tone\_medium\_dark\_label - -> **skin\_tone\_medium\_dark\_label**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L20) - -*** - -### skin\_tone\_medium\_label - -> **skin\_tone\_medium\_label**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L19) - -*** - -### skin\_tone\_medium\_light\_label - -> **skin\_tone\_medium\_light\_label**: `string` - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'EmojiPicker'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/EmojiPicker.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/EmojiPicker.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EmojiPicker & { [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 EmojiPicker & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md b/docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md deleted file mode 100644 index df45fecf..00000000 --- a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EmojiPickerCategory - -# Class: EmojiPickerCategory - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EmojiPickerCategory() - -> **new EmojiPickerCategory**(`data`): [`EmojiPickerCategory`](EmojiPickerCategory.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EmojiPickerCategory`](EmojiPickerCategory.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EmojiPickerCategory.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategory.ts#L14) - -## Properties - -### category\_id - -> **category\_id**: `string` - -#### Defined in - -[src/parser/classes/EmojiPickerCategory.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategory.ts#L8) - -*** - -### category\_type - -> **category\_type**: `string` - -#### Defined in - -[src/parser/classes/EmojiPickerCategory.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategory.ts#L12) - -*** - -### emoji\_ids - -> **emoji\_ids**: `string`[] - -#### Defined in - -[src/parser/classes/EmojiPickerCategory.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategory.ts#L10) - -*** - -### image\_loading\_lazy - -> **image\_loading\_lazy**: `boolean` - -#### Defined in - -[src/parser/classes/EmojiPickerCategory.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategory.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EmojiPickerCategory.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategory.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'EmojiPickerCategory'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EmojiPickerCategory.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategory.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EmojiPickerCategory & { [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 EmojiPickerCategory & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md b/docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md deleted file mode 100644 index 013ed958..00000000 --- a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EmojiPickerCategoryButton - -# Class: EmojiPickerCategoryButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EmojiPickerCategoryButton() - -> **new EmojiPickerCategoryButton**(`data`): [`EmojiPickerCategoryButton`](EmojiPickerCategoryButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EmojiPickerCategoryButton`](EmojiPickerCategoryButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EmojiPickerCategoryButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategoryButton.ts#L11) - -## Properties - -### category\_id - -> **category\_id**: `string` - -#### Defined in - -[src/parser/classes/EmojiPickerCategoryButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategoryButton.ts#L7) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/EmojiPickerCategoryButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategoryButton.ts#L8) - -*** - -### tooltip - -> **tooltip**: `string` - -#### Defined in - -[src/parser/classes/EmojiPickerCategoryButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategoryButton.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'EmojiPickerCategoryButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EmojiPickerCategoryButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerCategoryButton.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EmojiPickerCategoryButton & { [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 EmojiPickerCategoryButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md b/docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md deleted file mode 100644 index db471730..00000000 --- a/docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EmojiPickerUpsellCategory - -# Class: EmojiPickerUpsellCategory - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EmojiPickerUpsellCategory() - -> **new EmojiPickerUpsellCategory**(`data`): [`EmojiPickerUpsellCategory`](EmojiPickerUpsellCategory.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EmojiPickerUpsellCategory`](EmojiPickerUpsellCategory.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L16) - -## Properties - -### category\_id - -> **category\_id**: `string` - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L9) - -*** - -### emoji\_ids - -> **emoji\_ids**: `string`[] - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L14) - -*** - -### emoji\_tooltip - -> **emoji\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### upsell - -> **upsell**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L11) - -*** - -### type - -> `static` **type**: `string` = `'EmojiPickerUpsellCategory'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EmojiPickerUpsellCategory.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EmojiPickerUpsellCategory.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EmojiPickerUpsellCategory & { [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 EmojiPickerUpsellCategory & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md b/docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md deleted file mode 100644 index 90a25bea..00000000 --- a/docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EndScreenPlaylist - -# Class: EndScreenPlaylist - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EndScreenPlaylist() - -> **new EndScreenPlaylist**(`data`): [`EndScreenPlaylist`](EndScreenPlaylist.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EndScreenPlaylist`](EndScreenPlaylist.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L17) - -## Properties - -### author - -> **author**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L13) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L10) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L14) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'EndScreenPlaylist'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EndScreenPlaylist.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenPlaylist.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EndScreenPlaylist & { [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 EndScreenPlaylist & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EndScreenVideo.md b/docs/api/namespaces/YTNodes/classes/EndScreenVideo.md deleted file mode 100644 index 9e020dac..00000000 --- a/docs/api/namespaces/YTNodes/classes/EndScreenVideo.md +++ /dev/null @@ -1,299 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EndScreenVideo - -# Class: EndScreenVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EndScreenVideo() - -> **new EndScreenVideo**(`data`): [`EndScreenVideo`](EndScreenVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EndScreenVideo`](EndScreenVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L24) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L15) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L18) - -*** - -### duration - -> **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L19) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L16) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L11) - -*** - -### short\_view\_count - -> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L17) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L14) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'EndScreenVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EndScreenVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndScreenVideo.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EndScreenVideo & { [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 EndScreenVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EndscreenElement.md b/docs/api/namespaces/YTNodes/classes/EndscreenElement.md deleted file mode 100644 index 765fdb5c..00000000 --- a/docs/api/namespaces/YTNodes/classes/EndscreenElement.md +++ /dev/null @@ -1,381 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EndscreenElement - -# Class: EndscreenElement - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EndscreenElement() - -> **new EndscreenElement**(`data`): [`EndscreenElement`](EndscreenElement.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EndscreenElement`](EndscreenElement.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L29) - -## Properties - -### aspect\_ratio - -> **aspect\_ratio**: `number` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L24) - -*** - -### call\_to\_action? - -> `optional` **call\_to\_action**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L16) - -*** - -### end\_ms - -> **end\_ms**: `number` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L26) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L12) - -*** - -### hovercard\_button? - -> `optional` **hovercard\_button**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L17) - -*** - -### icon? - -> `optional` **icon**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L14) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L27) - -*** - -### image? - -> `optional` **image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L13) - -*** - -### is\_subscribe? - -> `optional` **is\_subscribe**: `boolean` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L18) - -*** - -### left - -> **left**: `number` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L21) - -*** - -### metadata? - -> `optional` **metadata**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L15) - -*** - -### playlist\_length? - -> `optional` **playlist\_length**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L19) - -*** - -### start\_ms - -> **start\_ms**: `number` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L25) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L10) - -*** - -### thumbnail\_overlays? - -> `optional` **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L20) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L11) - -*** - -### top - -> **top**: `number` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L22) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### width - -> **width**: `number` - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L23) - -*** - -### type - -> `static` **type**: `string` = `'EndscreenElement'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EndscreenElement.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EndscreenElement.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EndscreenElement & { [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 EndscreenElement & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md b/docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md deleted file mode 100644 index 5583f11e..00000000 --- a/docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md +++ /dev/null @@ -1,269 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EngagementPanelSectionList - -# Class: EngagementPanelSectionList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EngagementPanelSectionList() - -> **new EngagementPanelSectionList**(`data`): [`EngagementPanelSectionList`](EngagementPanelSectionList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EngagementPanelSectionList`](EngagementPanelSectionList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L25) - -## Properties - -### content - -> **content**: `null` \| [`SectionList`](SectionList.md) \| [`VideoAttributeView`](VideoAttributeView.md) \| [`ContinuationItem`](ContinuationItem.md) \| [`ClipSection`](ClipSection.md) \| [`MacroMarkersList`](MacroMarkersList.md) \| [`ProductList`](ProductList.md) \| [`StructuredDescriptionContent`](StructuredDescriptionContent.md) - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L16) - -*** - -### header - -> **header**: `null` \| [`EngagementPanelTitleHeader`](EngagementPanelTitleHeader.md) - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L15) - -*** - -### identifier? - -> `optional` **identifier**: `object` - -#### surface - -> **surface**: `string` - -#### tag - -> **tag**: `string` - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L19) - -*** - -### panel\_identifier? - -> `optional` **panel\_identifier**: `string` - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L18) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### visibility? - -> `optional` **visibility**: `string` - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L23) - -*** - -### type - -> `static` **type**: `string` = `'EngagementPanelSectionList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EngagementPanelSectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelSectionList.ts#L13) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EngagementPanelSectionList & { [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 EngagementPanelSectionList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md b/docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md deleted file mode 100644 index b4df0236..00000000 --- a/docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EngagementPanelTitleHeader - -# Class: EngagementPanelTitleHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EngagementPanelTitleHeader() - -> **new EngagementPanelTitleHeader**(`data`): [`EngagementPanelTitleHeader`](EngagementPanelTitleHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EngagementPanelTitleHeader`](EngagementPanelTitleHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EngagementPanelTitleHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelTitleHeader.ts#L14) - -## Properties - -### contextual\_info? - -> `optional` **contextual\_info**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EngagementPanelTitleHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelTitleHeader.ts#L11) - -*** - -### menu - -> **menu**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/EngagementPanelTitleHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelTitleHeader.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EngagementPanelTitleHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelTitleHeader.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### visibility\_button - -> **visibility\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/EngagementPanelTitleHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelTitleHeader.ts#L10) - -*** - -### type - -> `static` **type**: `string` = `'EngagementPanelTitleHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EngagementPanelTitleHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EngagementPanelTitleHeader.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EngagementPanelTitleHeader & { [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 EngagementPanelTitleHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md b/docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md deleted file mode 100644 index e7ef987c..00000000 --- a/docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md +++ /dev/null @@ -1,235 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EomSettingsDisclaimer - -# Class: EomSettingsDisclaimer - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new EomSettingsDisclaimer() - -> **new EomSettingsDisclaimer**(`data`): [`EomSettingsDisclaimer`](EomSettingsDisclaimer.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`EomSettingsDisclaimer`](EomSettingsDisclaimer.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/EomSettingsDisclaimer.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EomSettingsDisclaimer.ts#L14) - -## Properties - -### disclaimer - -> **disclaimer**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/EomSettingsDisclaimer.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EomSettingsDisclaimer.ts#L8) - -*** - -### info\_icon - -> **info\_icon**: `object` - -#### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/EomSettingsDisclaimer.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EomSettingsDisclaimer.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### usage\_scenario - -> **usage\_scenario**: `string` - -#### Defined in - -[src/parser/classes/EomSettingsDisclaimer.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EomSettingsDisclaimer.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'EomSettingsDisclaimer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/EomSettingsDisclaimer.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/EomSettingsDisclaimer.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is EomSettingsDisclaimer & { [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 EomSettingsDisclaimer & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md b/docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md deleted file mode 100644 index 7a8e0600..00000000 --- a/docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md +++ /dev/null @@ -1,257 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ExpandableMetadata - -# Class: ExpandableMetadata - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ExpandableMetadata() - -> **new ExpandableMetadata**(`data`): [`ExpandableMetadata`](ExpandableMetadata.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ExpandableMetadata`](ExpandableMetadata.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ExpandableMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableMetadata.ts#L23) - -## Properties - -### collapse\_button - -> **collapse\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ExpandableMetadata.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableMetadata.ts#L21) - -*** - -### expand\_button - -> **expand\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ExpandableMetadata.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableMetadata.ts#L20) - -*** - -### expanded\_content - -> **expanded\_content**: `null` \| [`HorizontalCardList`](HorizontalCardList.md) \| [`HorizontalList`](HorizontalList.md) - -#### Defined in - -[src/parser/classes/ExpandableMetadata.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableMetadata.ts#L19) - -*** - -### header? - -> `optional` **header**: `object` - -#### collapsed\_label - -> **collapsed\_label**: [`Text`](../../Misc/classes/Text.md) - -#### collapsed\_thumbnail - -> **collapsed\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### collapsed\_title - -> **collapsed\_title**: [`Text`](../../Misc/classes/Text.md) - -#### expanded\_title - -> **expanded\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ExpandableMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableMetadata.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ExpandableMetadata'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ExpandableMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableMetadata.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ExpandableMetadata & { [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 ExpandableMetadata & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandableTab.md b/docs/api/namespaces/YTNodes/classes/ExpandableTab.md deleted file mode 100644 index 2e50fbcb..00000000 --- a/docs/api/namespaces/YTNodes/classes/ExpandableTab.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ExpandableTab - -# Class: ExpandableTab - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ExpandableTab() - -> **new ExpandableTab**(`data`): [`ExpandableTab`](ExpandableTab.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ExpandableTab`](ExpandableTab.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ExpandableTab.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableTab.ts#L13) - -## Properties - -### content - -> **content**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/ExpandableTab.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableTab.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ExpandableTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableTab.ts#L9) - -*** - -### selected - -> **selected**: `boolean` - -#### Defined in - -[src/parser/classes/ExpandableTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableTab.ts#L10) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/ExpandableTab.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableTab.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ExpandableTab'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ExpandableTab.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableTab.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ExpandableTab & { [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 ExpandableTab & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md b/docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md deleted file mode 100644 index 064d0796..00000000 --- a/docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ExpandableVideoDescriptionBody - -# Class: ExpandableVideoDescriptionBody - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ExpandableVideoDescriptionBody() - -> **new ExpandableVideoDescriptionBody**(`data`): [`ExpandableVideoDescriptionBody`](ExpandableVideoDescriptionBody.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ExpandableVideoDescriptionBody`](ExpandableVideoDescriptionBody.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ExpandableVideoDescriptionBody.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableVideoDescriptionBody.ts#L13) - -## Properties - -### attributed\_description\_body\_text? - -> `optional` **attributed\_description\_body\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ExpandableVideoDescriptionBody.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableVideoDescriptionBody.ts#L11) - -*** - -### show\_less\_text - -> **show\_less\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ExpandableVideoDescriptionBody.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableVideoDescriptionBody.ts#L10) - -*** - -### show\_more\_text - -> **show\_more\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ExpandableVideoDescriptionBody.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableVideoDescriptionBody.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ExpandableVideoDescriptionBody'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ExpandableVideoDescriptionBody.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandableVideoDescriptionBody.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ExpandableVideoDescriptionBody & { [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 ExpandableVideoDescriptionBody & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md b/docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md deleted file mode 100644 index fc2eadee..00000000 --- a/docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md +++ /dev/null @@ -1,225 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ExpandedShelfContents - -# Class: ExpandedShelfContents - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ExpandedShelfContents() - -> **new ExpandedShelfContents**(`data`): [`ExpandedShelfContents`](ExpandedShelfContents.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ExpandedShelfContents`](ExpandedShelfContents.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ExpandedShelfContents.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandedShelfContents.ts#L9) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ExpandedShelfContents.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandedShelfContents.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ExpandedShelfContents'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ExpandedShelfContents.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandedShelfContents.ts#L5) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ExpandedShelfContents.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ExpandedShelfContents.ts#L15) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ExpandedShelfContents & { [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 ExpandedShelfContents & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Factoid.md b/docs/api/namespaces/YTNodes/classes/Factoid.md deleted file mode 100644 index b9199d26..00000000 --- a/docs/api/namespaces/YTNodes/classes/Factoid.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Factoid - -# Class: Factoid - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Factoid() - -> **new Factoid**(`data`): [`Factoid`](Factoid.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Factoid`](Factoid.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Factoid.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Factoid.ts#L12) - -## Properties - -### accessibility\_text - -> **accessibility\_text**: `string` - -#### Defined in - -[src/parser/classes/Factoid.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Factoid.ts#L10) - -*** - -### label - -> **label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Factoid.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Factoid.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### value - -> **value**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Factoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Factoid.ts#L9) - -*** - -### type - -> `static` **type**: `string` = `'Factoid'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Factoid.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Factoid.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Factoid & { [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 Factoid & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md b/docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md deleted file mode 100644 index fb4d54ac..00000000 --- a/docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / FancyDismissibleDialog - -# Class: FancyDismissibleDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new FancyDismissibleDialog() - -> **new FancyDismissibleDialog**(`data`): [`FancyDismissibleDialog`](FancyDismissibleDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`FancyDismissibleDialog`](FancyDismissibleDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/FancyDismissibleDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FancyDismissibleDialog.ts#L11) - -## Properties - -### confirm\_label - -> **confirm\_label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/FancyDismissibleDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FancyDismissibleDialog.ts#L9) - -*** - -### dialog\_message - -> **dialog\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/FancyDismissibleDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FancyDismissibleDialog.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'FancyDismissibleDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/FancyDismissibleDialog.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FancyDismissibleDialog.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is FancyDismissibleDialog & { [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 FancyDismissibleDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/FeedNudge.md b/docs/api/namespaces/YTNodes/classes/FeedNudge.md deleted file mode 100644 index ace97224..00000000 --- a/docs/api/namespaces/YTNodes/classes/FeedNudge.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / FeedNudge - -# Class: FeedNudge - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new FeedNudge() - -> **new FeedNudge**(`data`): [`FeedNudge`](FeedNudge.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`FeedNudge`](FeedNudge.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/FeedNudge.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L17) - -## Properties - -### apply\_modernized\_style - -> **apply\_modernized\_style**: `boolean` - -#### Defined in - -[src/parser/classes/FeedNudge.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L13) - -*** - -### background\_style - -> **background\_style**: `string` - -#### Defined in - -[src/parser/classes/FeedNudge.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L15) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/FeedNudge.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L12) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/FeedNudge.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/FeedNudge.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L10) - -*** - -### trim\_style - -> **trim\_style**: `string` - -#### Defined in - -[src/parser/classes/FeedNudge.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'FeedNudge'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/FeedNudge.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FeedNudge.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is FeedNudge & { [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 FeedNudge & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/FeedbackEndpoint.md b/docs/api/namespaces/YTNodes/classes/FeedbackEndpoint.md deleted file mode 100644 index 38b75337..00000000 --- a/docs/api/namespaces/YTNodes/classes/FeedbackEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / FeedbackEndpoint - -# Class: FeedbackEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`FeedbackRequest`](../../APIResponseTypes/type-aliases/FeedbackRequest.md)\> - -## Constructors - -### new FeedbackEndpoint() - -> **new FeedbackEndpoint**(`data`): [`FeedbackEndpoint`](FeedbackEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`FeedbackEndpoint`](FeedbackEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/FeedbackEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/FeedbackEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'FeedbackEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/FeedbackEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/FeedbackEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`FeedbackRequest`](../../APIResponseTypes/type-aliases/FeedbackRequest.md) - -#### Returns - -[`FeedbackRequest`](../../APIResponseTypes/type-aliases/FeedbackRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/FeedbackEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/FeedbackEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/FeedbackEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/FeedbackEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is FeedbackEndpoint & { [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 FeedbackEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md b/docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md deleted file mode 100644 index 40a64d9e..00000000 --- a/docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / FlexibleActionsView - -# Class: FlexibleActionsView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new FlexibleActionsView() - -> **new FlexibleActionsView**(`data`): [`FlexibleActionsView`](FlexibleActionsView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`FlexibleActionsView`](FlexibleActionsView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/FlexibleActionsView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FlexibleActionsView.ts#L16) - -## Properties - -### actions\_rows - -> **actions\_rows**: `ActionRow`[] - -#### Defined in - -[src/parser/classes/FlexibleActionsView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FlexibleActionsView.ts#L13) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/FlexibleActionsView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FlexibleActionsView.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'FlexibleActionsView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/FlexibleActionsView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FlexibleActionsView.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is FlexibleActionsView & { [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 FlexibleActionsView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/FormFooterView.md b/docs/api/namespaces/YTNodes/classes/FormFooterView.md deleted file mode 100644 index e4e1cdb7..00000000 --- a/docs/api/namespaces/YTNodes/classes/FormFooterView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / FormFooterView - -# Class: FormFooterView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new FormFooterView() - -> **new FormFooterView**(`data`): [`FormFooterView`](FormFooterView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`FormFooterView`](FormFooterView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/FormFooterView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FormFooterView.ts#L12) - -## Properties - -### container\_type - -> **container\_type**: `string` - -#### Defined in - -[src/parser/classes/FormFooterView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FormFooterView.ts#L10) - -*** - -### form\_id - -> **form\_id**: `string` - -#### Defined in - -[src/parser/classes/FormFooterView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FormFooterView.ts#L9) - -*** - -### panel\_footer - -> **panel\_footer**: `null` \| [`PanelFooterView`](PanelFooterView.md) - -#### Defined in - -[src/parser/classes/FormFooterView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FormFooterView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'FormFooterView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/FormFooterView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/FormFooterView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is FormFooterView & { [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 FormFooterView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GameDetails.md b/docs/api/namespaces/YTNodes/classes/GameDetails.md deleted file mode 100644 index 398a84da..00000000 --- a/docs/api/namespaces/YTNodes/classes/GameDetails.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GameDetails - -# Class: GameDetails - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GameDetails() - -> **new GameDetails**(`data`): [`GameDetails`](GameDetails.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GameDetails`](GameDetails.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GameDetails.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GameDetails.ts#L16) - -## Properties - -### box\_art - -> **box\_art**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/GameDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GameDetails.ts#L11) - -*** - -### box\_art\_overlay\_text - -> **box\_art\_overlay\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GameDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GameDetails.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GameDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GameDetails.ts#L13) - -*** - -### is\_official\_box\_art - -> **is\_official\_box\_art**: `boolean` - -#### Defined in - -[src/parser/classes/GameDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GameDetails.ts#L14) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GameDetails.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GameDetails.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GameDetails'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GameDetails.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GameDetails.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GameDetails & { [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 GameDetails & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GetAccountsListInnertubeEndpoint.md b/docs/api/namespaces/YTNodes/classes/GetAccountsListInnertubeEndpoint.md deleted file mode 100644 index 31f1b0e6..00000000 --- a/docs/api/namespaces/YTNodes/classes/GetAccountsListInnertubeEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GetAccountsListInnertubeEndpoint - -# Class: GetAccountsListInnertubeEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`GetAccountsListInnertubeRequest`](../../APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md)\> - -## Constructors - -### new GetAccountsListInnertubeEndpoint() - -> **new GetAccountsListInnertubeEndpoint**(`data`): [`GetAccountsListInnertubeEndpoint`](GetAccountsListInnertubeEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GetAccountsListInnertubeEndpoint`](GetAccountsListInnertubeEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GetAccountsListInnertubeEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`GetAccountsListInnertubeRequest`](../../APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md) - -#### Returns - -[`GetAccountsListInnertubeRequest`](../../APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GetAccountsListInnertubeEndpoint & { [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 GetAccountsListInnertubeEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GetKidsBlocklistPickerCommand.md b/docs/api/namespaces/YTNodes/classes/GetKidsBlocklistPickerCommand.md deleted file mode 100644 index abf5b800..00000000 --- a/docs/api/namespaces/YTNodes/classes/GetKidsBlocklistPickerCommand.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GetKidsBlocklistPickerCommand - -# Class: GetKidsBlocklistPickerCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`GetKidsBlocklistPickerRequest`](../../APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md)\> - -## Constructors - -### new GetKidsBlocklistPickerCommand() - -> **new GetKidsBlocklistPickerCommand**(`data`): [`GetKidsBlocklistPickerCommand`](GetKidsBlocklistPickerCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GetKidsBlocklistPickerCommand`](GetKidsBlocklistPickerCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GetKidsBlocklistPickerCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`GetKidsBlocklistPickerRequest`](../../APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md) - -#### Returns - -[`GetKidsBlocklistPickerRequest`](../../APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GetKidsBlocklistPickerCommand & { [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 GetKidsBlocklistPickerCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md b/docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md deleted file mode 100644 index 41527606..00000000 --- a/docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GetMultiPageMenuAction - -# Class: GetMultiPageMenuAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GetMultiPageMenuAction() - -> **new GetMultiPageMenuAction**(`data`): [`GetMultiPageMenuAction`](GetMultiPageMenuAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GetMultiPageMenuAction`](GetMultiPageMenuAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/actions/GetMultiPageMenuAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/GetMultiPageMenuAction.ts#L11) - -## Properties - -### menu - -> **menu**: `null` \| [`MultiPageMenu`](MultiPageMenu.md) - -#### Defined in - -[src/parser/classes/actions/GetMultiPageMenuAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/GetMultiPageMenuAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GetMultiPageMenuAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/actions/GetMultiPageMenuAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/GetMultiPageMenuAction.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GetMultiPageMenuAction & { [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 GetMultiPageMenuAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Grid.md b/docs/api/namespaces/YTNodes/classes/Grid.md deleted file mode 100644 index d6ee6e38..00000000 --- a/docs/api/namespaces/YTNodes/classes/Grid.md +++ /dev/null @@ -1,275 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Grid - -# Class: Grid - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Grid() - -> **new Grid**(`data`): [`Grid`](Grid.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Grid`](Grid.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Grid.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L14) - -## Properties - -### continuation - -> **continuation**: `null` \| `string` - -#### Defined in - -[src/parser/classes/Grid.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L11) - -*** - -### header? - -> `optional` **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Grid.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L12) - -*** - -### is\_collapsible? - -> `optional` **is\_collapsible**: `boolean` - -#### Defined in - -[src/parser/classes/Grid.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L8) - -*** - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Grid.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L7) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/Grid.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### visible\_row\_count? - -> `optional` **visible\_row\_count**: `string` - -#### Defined in - -[src/parser/classes/Grid.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L9) - -*** - -### type - -> `static` **type**: `string` = `'Grid'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Grid.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L5) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Grid.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Grid.ts#L39) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Grid & { [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 Grid & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GridChannel.md b/docs/api/namespaces/YTNodes/classes/GridChannel.md deleted file mode 100644 index 1924a1d7..00000000 --- a/docs/api/namespaces/YTNodes/classes/GridChannel.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GridChannel - -# Class: GridChannel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GridChannel() - -> **new GridChannel**(`data`): [`GridChannel`](GridChannel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GridChannel`](GridChannel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GridChannel.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L17) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/GridChannel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GridChannel.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L14) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/GridChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L10) - -*** - -### subscribe\_button - -> **subscribe\_button**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/GridChannel.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L15) - -*** - -### subscribers - -> **subscribers**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridChannel.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L13) - -*** - -### type - -> `static` **type**: `string` = `'GridChannel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GridChannel.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridChannel.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GridChannel & { [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 GridChannel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GridMix.md b/docs/api/namespaces/YTNodes/classes/GridMix.md deleted file mode 100644 index 7c1812a7..00000000 --- a/docs/api/namespaces/YTNodes/classes/GridMix.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GridMix - -# Class: GridMix - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GridMix() - -> **new GridMix**(`data`): [`GridMix`](GridMix.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GridMix`](GridMix.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GridMix.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L20) - -## Properties - -### author - -> **author**: `null` \| [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridMix.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GridMix.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L16) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/GridMix.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L10) - -*** - -### secondary\_endpoint - -> **secondary\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GridMix.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L17) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GridMix.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L18) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/GridMix.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridMix.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridMix.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L14) - -*** - -### video\_count\_short - -> **video\_count\_short**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridMix.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'GridMix'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GridMix.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMix.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GridMix & { [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 GridMix & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GridMovie.md b/docs/api/namespaces/YTNodes/classes/GridMovie.md deleted file mode 100644 index 3b7c9175..00000000 --- a/docs/api/namespaces/YTNodes/classes/GridMovie.md +++ /dev/null @@ -1,281 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GridMovie - -# Class: GridMovie - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GridMovie() - -> **new GridMovie**(`data`): [`GridMovie`](GridMovie.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GridMovie`](GridMovie.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GridMovie.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L20) - -## Properties - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MetadataBadge`](MetadataBadge.md)\> - -#### Defined in - -[src/parser/classes/GridMovie.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L16) - -*** - -### duration - -> **duration**: `null` \| [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridMovie.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GridMovie.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/GridMovie.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L11) - -*** - -### metadata - -> **metadata**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridMovie.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L17) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GridMovie.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L18) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/GridMovie.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridMovie.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GridMovie'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GridMovie.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridMovie.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GridMovie & { [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 GridMovie & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GridPlaylist.md b/docs/api/namespaces/YTNodes/classes/GridPlaylist.md deleted file mode 100644 index 5faff058..00000000 --- a/docs/api/namespaces/YTNodes/classes/GridPlaylist.md +++ /dev/null @@ -1,311 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GridPlaylist - -# Class: GridPlaylist - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GridPlaylist() - -> **new GridPlaylist**(`data`): [`GridPlaylist`](GridPlaylist.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GridPlaylist`](GridPlaylist.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L23) - -## Properties - -### author? - -> `optional` **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L13) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L11) - -*** - -### sidebar\_thumbnails - -> **sidebar\_thumbnails**: `null` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L19) - -*** - -### thumbnail\_renderer - -> **thumbnail\_renderer**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L18) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L17) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L20) - -*** - -### video\_count\_short - -> **video\_count\_short**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L21) - -*** - -### view\_playlist - -> **view\_playlist**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L16) - -*** - -### type - -> `static` **type**: `string` = `'GridPlaylist'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GridPlaylist.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridPlaylist.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GridPlaylist & { [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 GridPlaylist & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GridShelfView.md b/docs/api/namespaces/YTNodes/classes/GridShelfView.md deleted file mode 100644 index 0c3931ed..00000000 --- a/docs/api/namespaces/YTNodes/classes/GridShelfView.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GridShelfView - -# Class: GridShelfView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GridShelfView() - -> **new GridShelfView**(`data`): [`GridShelfView`](GridShelfView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GridShelfView`](GridShelfView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GridShelfView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L17) - -## Properties - -### content\_aspect\_ratio - -> **content\_aspect\_ratio**: `string` - -#### Defined in - -[src/parser/classes/GridShelfView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L11) - -*** - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GridShelfView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L9) - -*** - -### enable\_vertical\_expansion - -> **enable\_vertical\_expansion**: `boolean` - -#### Defined in - -[src/parser/classes/GridShelfView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L12) - -*** - -### header - -> **header**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/GridShelfView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L10) - -*** - -### min\_collapsed\_item\_count - -> **min\_collapsed\_item\_count**: `number` - -#### Defined in - -[src/parser/classes/GridShelfView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L15) - -*** - -### show\_less\_button - -> **show\_less\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/GridShelfView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L14) - -*** - -### show\_more\_button - -> **show\_more\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/GridShelfView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GridShelfView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GridShelfView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShelfView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GridShelfView & { [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 GridShelfView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GridShow.md b/docs/api/namespaces/YTNodes/classes/GridShow.md deleted file mode 100644 index 38cf5e79..00000000 --- a/docs/api/namespaces/YTNodes/classes/GridShow.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GridShow - -# Class: GridShow - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GridShow() - -> **new GridShow**(`data`): [`GridShow`](GridShow.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GridShow`](GridShow.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GridShow.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L20) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/GridShow.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L18) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GridShow.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L15) - -*** - -### long\_byline\_text - -> **long\_byline\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridShow.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L16) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ThumbnailOverlayBottomPanel`](ThumbnailOverlayBottomPanel.md)\> - -#### Defined in - -[src/parser/classes/GridShow.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L17) - -*** - -### thumbnail\_renderer - -> **thumbnail\_renderer**: `null` \| [`ShowCustomThumbnail`](ShowCustomThumbnail.md) - -#### Defined in - -[src/parser/classes/GridShow.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L14) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridShow.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GridShow'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GridShow.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridShow.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GridShow & { [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 GridShow & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GridVideo.md b/docs/api/namespaces/YTNodes/classes/GridVideo.md deleted file mode 100644 index 38cebf2f..00000000 --- a/docs/api/namespaces/YTNodes/classes/GridVideo.md +++ /dev/null @@ -1,393 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GridVideo - -# Class: GridVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GridVideo() - -> **new GridVideo**(`data`): [`GridVideo`](GridVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GridVideo`](GridVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GridVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L29) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L19) - -*** - -### buttons? - -> `optional` **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GridVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L24) - -*** - -### duration - -> **duration**: `null` \| [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L18) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L22) - -*** - -### is\_reminder\_set? - -> `optional` **is\_reminder\_set**: `boolean` - -#### Defined in - -[src/parser/classes/GridVideo.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L27) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L23) - -*** - -### published - -> **published**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L17) - -*** - -### rich\_thumbnail - -> **rich\_thumbnail**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L16) - -*** - -### short\_view\_count - -> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L21) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GridVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L15) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/GridVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L14) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### upcoming? - -> `optional` **upcoming**: `Date` - -#### Defined in - -[src/parser/classes/GridVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L25) - -*** - -### upcoming\_text? - -> `optional` **upcoming\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L26) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/GridVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L12) - -*** - -### views - -> **views**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GridVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L20) - -*** - -### type - -> `static` **type**: `string` = `'GridVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GridVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L10) - -## Accessors - -### id - -> `get` **id**(): `string` - -#### Deprecated - -Use [`video_id`](GridVideo.md#video_id) instead. - -#### Returns - -`string` - -#### Defined in - -[src/parser/classes/GridVideo.ts:60](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L60) - -*** - -### is\_upcoming - -> `get` **is\_upcoming**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/GridVideo.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GridVideo.ts#L64) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GridVideo & { [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 GridVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md b/docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md deleted file mode 100644 index 1fb4b004..00000000 --- a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GuideCollapsibleEntry - -# Class: GuideCollapsibleEntry - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GuideCollapsibleEntry() - -> **new GuideCollapsibleEntry**(`data`): [`GuideCollapsibleEntry`](GuideCollapsibleEntry.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GuideCollapsibleEntry`](GuideCollapsibleEntry.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GuideCollapsibleEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleEntry.ts#L13) - -## Properties - -### collapser\_item - -> **collapser\_item**: `null` \| [`GuideEntry`](GuideEntry.md) - -#### Defined in - -[src/parser/classes/GuideCollapsibleEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleEntry.ts#L10) - -*** - -### expandable\_items - -> **expandable\_items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GuideCollapsibleEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleEntry.ts#L11) - -*** - -### expander\_item - -> **expander\_item**: `null` \| [`GuideEntry`](GuideEntry.md) - -#### Defined in - -[src/parser/classes/GuideCollapsibleEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleEntry.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GuideCollapsibleEntry'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GuideCollapsibleEntry.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleEntry.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GuideCollapsibleEntry & { [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 GuideCollapsibleEntry & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md b/docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md deleted file mode 100644 index fae9e936..00000000 --- a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GuideCollapsibleSectionEntry - -# Class: GuideCollapsibleSectionEntry - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new GuideCollapsibleSectionEntry() - -> **new GuideCollapsibleSectionEntry**(`data`): [`GuideCollapsibleSectionEntry`](GuideCollapsibleSectionEntry.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GuideCollapsibleSectionEntry`](GuideCollapsibleSectionEntry.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GuideCollapsibleSectionEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleSectionEntry.ts#L13) - -## Properties - -### collapser\_icon - -> **collapser\_icon**: `string` - -#### Defined in - -[src/parser/classes/GuideCollapsibleSectionEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleSectionEntry.ts#L10) - -*** - -### expander\_icon - -> **expander\_icon**: `string` - -#### Defined in - -[src/parser/classes/GuideCollapsibleSectionEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleSectionEntry.ts#L9) - -*** - -### header\_entry - -> **header\_entry**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/GuideCollapsibleSectionEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleSectionEntry.ts#L8) - -*** - -### section\_items - -> **section\_items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/GuideCollapsibleSectionEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleSectionEntry.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GuideCollapsibleSectionEntry'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GuideCollapsibleSectionEntry.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideCollapsibleSectionEntry.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GuideCollapsibleSectionEntry & { [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 GuideCollapsibleSectionEntry & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md b/docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md deleted file mode 100644 index 1a30d46e..00000000 --- a/docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md +++ /dev/null @@ -1,295 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GuideDownloadsEntry - -# Class: GuideDownloadsEntry - -## Extends - -- [`GuideEntry`](GuideEntry.md) - -## Constructors - -### new GuideDownloadsEntry() - -> **new GuideDownloadsEntry**(`data`): [`GuideDownloadsEntry`](GuideDownloadsEntry.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GuideDownloadsEntry`](GuideDownloadsEntry.md) - -#### Overrides - -[`GuideEntry`](GuideEntry.md).[`constructor`](GuideEntry.md#constructors) - -#### Defined in - -[src/parser/classes/GuideDownloadsEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideDownloadsEntry.ts#L9) - -## Properties - -### always\_show - -> **always\_show**: `boolean` - -#### Defined in - -[src/parser/classes/GuideDownloadsEntry.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideDownloadsEntry.ts#L7) - -*** - -### badges? - -> `optional` **badges**: `any` - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`badges`](GuideEntry.md#badges) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`endpoint`](GuideEntry.md#endpoint) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L11) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`icon_type`](GuideEntry.md#icon_type) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L12) - -*** - -### is\_primary - -> **is\_primary**: `boolean` - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`is_primary`](GuideEntry.md#is_primary) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L15) - -*** - -### thumbnails? - -> `optional` **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`thumbnails`](GuideEntry.md#thumbnails) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`title`](GuideEntry.md#title) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`type`](GuideEntry.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GuideDownloadsEntry'` - -#### Overrides - -[`GuideEntry`](GuideEntry.md).[`type`](GuideEntry.md#type-1) - -#### Defined in - -[src/parser/classes/GuideDownloadsEntry.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideDownloadsEntry.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`as`](GuideEntry.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GuideDownloadsEntry & { [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 GuideDownloadsEntry & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`hasKey`](GuideEntry.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`is`](GuideEntry.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`GuideEntry`](GuideEntry.md).[`key`](GuideEntry.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/GuideEntry.md b/docs/api/namespaces/YTNodes/classes/GuideEntry.md deleted file mode 100644 index 42e0f6fa..00000000 --- a/docs/api/namespaces/YTNodes/classes/GuideEntry.md +++ /dev/null @@ -1,265 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / GuideEntry - -# Class: GuideEntry - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`GuideDownloadsEntry`](GuideDownloadsEntry.md) - -## Constructors - -### new GuideEntry() - -> **new GuideEntry**(`data`): [`GuideEntry`](GuideEntry.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`GuideEntry`](GuideEntry.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L17) - -## Properties - -### badges? - -> `optional` **badges**: `any` - -#### Defined in - -[src/parser/classes/GuideEntry.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L11) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/GuideEntry.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L12) - -*** - -### is\_primary - -> **is\_primary**: `boolean` - -#### Defined in - -[src/parser/classes/GuideEntry.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L15) - -*** - -### thumbnails? - -> `optional` **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/GuideEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'GuideEntry'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/GuideEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/GuideEntry.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is GuideEntry & { [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 GuideEntry & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/HashtagTile.md b/docs/api/namespaces/YTNodes/classes/HashtagTile.md deleted file mode 100644 index 1352235e..00000000 --- a/docs/api/namespaces/YTNodes/classes/HashtagTile.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / HashtagTile - -# Class: HashtagTile - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new HashtagTile() - -> **new HashtagTile**(`data`): [`HashtagTile`](HashtagTile.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`HashtagTile`](HashtagTile.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/HashtagTile.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L18) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/HashtagTile.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L13) - -*** - -### hashtag - -> **hashtag**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/HashtagTile.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L10) - -*** - -### hashtag\_background\_color - -> **hashtag\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/HashtagTile.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L14) - -*** - -### hashtag\_channel\_count - -> **hashtag\_channel\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/HashtagTile.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L16) - -*** - -### hashtag\_info\_text - -> **hashtag\_info\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/HashtagTile.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L11) - -*** - -### hashtag\_thumbnail - -> **hashtag\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/HashtagTile.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L12) - -*** - -### hashtag\_video\_count - -> **hashtag\_video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/HashtagTile.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'HashtagTile'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/HashtagTile.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HashtagTile.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is HashtagTile & { [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 HashtagTile & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md b/docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md deleted file mode 100644 index 358e25cd..00000000 --- a/docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / HeroPlaylistThumbnail - -# Class: HeroPlaylistThumbnail - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new HeroPlaylistThumbnail() - -> **new HeroPlaylistThumbnail**(`data`): [`HeroPlaylistThumbnail`](HeroPlaylistThumbnail.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`HeroPlaylistThumbnail`](HeroPlaylistThumbnail.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/HeroPlaylistThumbnail.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HeroPlaylistThumbnail.ts#L12) - -## Properties - -### on\_tap\_endpoint - -> **on\_tap\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/HeroPlaylistThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HeroPlaylistThumbnail.ts#L10) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/HeroPlaylistThumbnail.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HeroPlaylistThumbnail.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'HeroPlaylistThumbnail'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/HeroPlaylistThumbnail.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HeroPlaylistThumbnail.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is HeroPlaylistThumbnail & { [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 HeroPlaylistThumbnail & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/HideEngagementPanelEndpoint.md b/docs/api/namespaces/YTNodes/classes/HideEngagementPanelEndpoint.md deleted file mode 100644 index d87fbf31..00000000 --- a/docs/api/namespaces/YTNodes/classes/HideEngagementPanelEndpoint.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / HideEngagementPanelEndpoint - -# Class: HideEngagementPanelEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new HideEngagementPanelEndpoint() - -> **new HideEngagementPanelEndpoint**(`data`): [`HideEngagementPanelEndpoint`](HideEngagementPanelEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`HideEngagementPanelEndpoint`](HideEngagementPanelEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/HideEngagementPanelEndpoint.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/HideEngagementPanelEndpoint.ts#L9) - -## Properties - -### panel\_identifier - -> **panel\_identifier**: `string` - -#### Defined in - -[src/parser/classes/endpoints/HideEngagementPanelEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/HideEngagementPanelEndpoint.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'HideEngagementPanelEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/HideEngagementPanelEndpoint.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/HideEngagementPanelEndpoint.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is HideEngagementPanelEndpoint & { [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 HideEngagementPanelEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/HorizontalCardList.md b/docs/api/namespaces/YTNodes/classes/HorizontalCardList.md deleted file mode 100644 index a70ac75d..00000000 --- a/docs/api/namespaces/YTNodes/classes/HorizontalCardList.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / HorizontalCardList - -# Class: HorizontalCardList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new HorizontalCardList() - -> **new HorizontalCardList**(`data`): [`HorizontalCardList`](HorizontalCardList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`HorizontalCardList`](HorizontalCardList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/HorizontalCardList.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalCardList.ts#L18) - -## Properties - -### cards - -> **cards**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchRefinementCard`](SearchRefinementCard.md) \| [`MacroMarkersListItem`](MacroMarkersListItem.md) \| [`GameCard`](GameCard.md) \| [`VideoCard`](VideoCard.md) \| [`VideoAttributeView`](VideoAttributeView.md)\> - -#### Defined in - -[src/parser/classes/HorizontalCardList.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalCardList.ts#L13) - -*** - -### header - -> **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/HorizontalCardList.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalCardList.ts#L14) - -*** - -### next\_button - -> **next\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/HorizontalCardList.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalCardList.ts#L16) - -*** - -### previous\_button - -> **previous\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/HorizontalCardList.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalCardList.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'HorizontalCardList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/HorizontalCardList.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalCardList.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is HorizontalCardList & { [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 HorizontalCardList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/HorizontalList.md b/docs/api/namespaces/YTNodes/classes/HorizontalList.md deleted file mode 100644 index d1c354b9..00000000 --- a/docs/api/namespaces/YTNodes/classes/HorizontalList.md +++ /dev/null @@ -1,235 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / HorizontalList - -# Class: HorizontalList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new HorizontalList() - -> **new HorizontalList**(`data`): [`HorizontalList`](HorizontalList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`HorizontalList`](HorizontalList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/HorizontalList.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalList.ts#L10) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/HorizontalList.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalList.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### visible\_item\_count - -> **visible\_item\_count**: `string` - -#### Defined in - -[src/parser/classes/HorizontalList.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalList.ts#L7) - -*** - -### type - -> `static` **type**: `string` = `'HorizontalList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/HorizontalList.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalList.ts#L5) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/HorizontalList.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalList.ts#L17) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is HorizontalList & { [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 HorizontalList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md b/docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md deleted file mode 100644 index 5f68ee54..00000000 --- a/docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / HorizontalMovieList - -# Class: HorizontalMovieList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new HorizontalMovieList() - -> **new HorizontalMovieList**(`data`): [`HorizontalMovieList`](HorizontalMovieList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`HorizontalMovieList`](HorizontalMovieList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/HorizontalMovieList.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalMovieList.ts#L12) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/HorizontalMovieList.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalMovieList.ts#L8) - -*** - -### next\_button - -> **next\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/HorizontalMovieList.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalMovieList.ts#L10) - -*** - -### previous\_button - -> **previous\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/HorizontalMovieList.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalMovieList.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'HorizontalMovieList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/HorizontalMovieList.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalMovieList.ts#L6) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/HorizontalMovieList.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HorizontalMovieList.ts#L20) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is HorizontalMovieList & { [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 HorizontalMovieList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/HowThisWasMadeSectionView.md b/docs/api/namespaces/YTNodes/classes/HowThisWasMadeSectionView.md deleted file mode 100644 index 07754120..00000000 --- a/docs/api/namespaces/YTNodes/classes/HowThisWasMadeSectionView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / HowThisWasMadeSectionView - -# Class: HowThisWasMadeSectionView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new HowThisWasMadeSectionView() - -> **new HowThisWasMadeSectionView**(`data`): [`HowThisWasMadeSectionView`](HowThisWasMadeSectionView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`HowThisWasMadeSectionView`](HowThisWasMadeSectionView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/HowThisWasMadeSectionView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HowThisWasMadeSectionView.ts#L12) - -## Properties - -### body\_header? - -> `optional` **body\_header**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/HowThisWasMadeSectionView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HowThisWasMadeSectionView.ts#L10) - -*** - -### body\_text? - -> `optional` **body\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/HowThisWasMadeSectionView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HowThisWasMadeSectionView.ts#L9) - -*** - -### section\_title? - -> `optional` **section\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/HowThisWasMadeSectionView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HowThisWasMadeSectionView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'HowThisWasMadeSectionView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/HowThisWasMadeSectionView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/HowThisWasMadeSectionView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is HowThisWasMadeSectionView & { [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 HowThisWasMadeSectionView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/IconLink.md b/docs/api/namespaces/YTNodes/classes/IconLink.md deleted file mode 100644 index b5ef438e..00000000 --- a/docs/api/namespaces/YTNodes/classes/IconLink.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / IconLink - -# Class: IconLink - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new IconLink() - -> **new IconLink**(`data`): [`IconLink`](IconLink.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`IconLink`](IconLink.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/IconLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IconLink.ts#L13) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/IconLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IconLink.ts#L11) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/IconLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IconLink.ts#L9) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Defined in - -[src/parser/classes/IconLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IconLink.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'IconLink'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/IconLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IconLink.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is IconLink & { [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 IconLink & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ImageBannerView.md b/docs/api/namespaces/YTNodes/classes/ImageBannerView.md deleted file mode 100644 index 4533b610..00000000 --- a/docs/api/namespaces/YTNodes/classes/ImageBannerView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ImageBannerView - -# Class: ImageBannerView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ImageBannerView() - -> **new ImageBannerView**(`data`): [`ImageBannerView`](ImageBannerView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ImageBannerView`](ImageBannerView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ImageBannerView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ImageBannerView.ts#L11) - -## Properties - -### image - -> **image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ImageBannerView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ImageBannerView.ts#L8) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/ImageBannerView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ImageBannerView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ImageBannerView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ImageBannerView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ImageBannerView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ImageBannerView & { [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 ImageBannerView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md b/docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md deleted file mode 100644 index f7d7ab13..00000000 --- a/docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / IncludingResultsFor - -# Class: IncludingResultsFor - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new IncludingResultsFor() - -> **new IncludingResultsFor**(`data`): [`IncludingResultsFor`](IncludingResultsFor.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`IncludingResultsFor`](IncludingResultsFor.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L16) - -## Properties - -### corrected\_query - -> **corrected\_query**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L10) - -*** - -### corrected\_query\_endpoint - -> **corrected\_query\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L11) - -*** - -### including\_results\_for - -> **including\_results\_for**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L9) - -*** - -### original\_query? - -> `optional` **original\_query**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L13) - -*** - -### original\_query\_endpoint? - -> `optional` **original\_query\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L14) - -*** - -### search\_only\_for? - -> `optional` **search\_only\_for**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'IncludingResultsFor'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/IncludingResultsFor.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/IncludingResultsFor.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is IncludingResultsFor & { [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 IncludingResultsFor & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md b/docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md deleted file mode 100644 index 9f00eedf..00000000 --- a/docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / InfoPanelContainer - -# Class: InfoPanelContainer - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new InfoPanelContainer() - -> **new InfoPanelContainer**(`data`): [`InfoPanelContainer`](InfoPanelContainer.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`InfoPanelContainer`](InfoPanelContainer.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L19) - -## Properties - -### background - -> **background**: `string` - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L15) - -*** - -### content - -> **content**: `null` \| [`InfoPanelContent`](InfoPanelContent.md) - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L13) - -*** - -### header\_endpoint? - -> `optional` **header\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L14) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L17) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L11) - -*** - -### title\_style? - -> `optional` **title\_style**: `string` - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'InfoPanelContainer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/InfoPanelContainer.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContainer.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is InfoPanelContainer & { [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 InfoPanelContainer & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/InfoPanelContent.md b/docs/api/namespaces/YTNodes/classes/InfoPanelContent.md deleted file mode 100644 index 20ba50f9..00000000 --- a/docs/api/namespaces/YTNodes/classes/InfoPanelContent.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / InfoPanelContent - -# Class: InfoPanelContent - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new InfoPanelContent() - -> **new InfoPanelContent**(`data`): [`InfoPanelContent`](InfoPanelContent.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`InfoPanelContent`](InfoPanelContent.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L21) - -## Properties - -### attributed\_paragraphs? - -> `optional` **attributed\_paragraphs**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L14) - -*** - -### background - -> **background**: `string` - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L18) - -*** - -### inline\_link\_icon\_type? - -> `optional` **inline\_link\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L19) - -*** - -### paragraphs? - -> `optional` **paragraphs**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L13) - -*** - -### source - -> **source**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L12) - -*** - -### source\_endpoint - -> **source\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L16) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L15) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L11) - -*** - -### truncate\_paragraphs - -> **truncate\_paragraphs**: `boolean` - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'InfoPanelContent'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/InfoPanelContent.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InfoPanelContent.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is InfoPanelContent & { [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 InfoPanelContent & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md b/docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md deleted file mode 100644 index c8a8ecc7..00000000 --- a/docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / InteractiveTabbedHeader - -# Class: InteractiveTabbedHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new InteractiveTabbedHeader() - -> **new InteractiveTabbedHeader**(`data`): [`InteractiveTabbedHeader`](InteractiveTabbedHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`InteractiveTabbedHeader`](InteractiveTabbedHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L23) - -## Properties - -### auto\_generated - -> **auto\_generated**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L21) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MetadataBadge`](MetadataBadge.md)\> - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L17) - -*** - -### banner - -> **banner**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L19) - -*** - -### box\_art - -> **box\_art**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L18) - -*** - -### buttons - -> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`SubscribeButton`](SubscribeButton.md)\> - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L20) - -*** - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L15) - -*** - -### header\_type - -> **header\_type**: `string` - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L13) - -*** - -### metadata - -> **metadata**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L16) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'InteractiveTabbedHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/InteractiveTabbedHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/InteractiveTabbedHeader.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is InteractiveTabbedHeader & { [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 InteractiveTabbedHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ItemSection.md b/docs/api/namespaces/YTNodes/classes/ItemSection.md deleted file mode 100644 index 6c113a01..00000000 --- a/docs/api/namespaces/YTNodes/classes/ItemSection.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ItemSection - -# Class: ItemSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ItemSection() - -> **new ItemSection**(`data`): [`ItemSection`](ItemSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ItemSection`](ItemSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ItemSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSection.ts#L17) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ItemSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSection.ts#L13) - -*** - -### continuation? - -> `optional` **continuation**: `string` - -#### Defined in - -[src/parser/classes/ItemSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSection.ts#L15) - -*** - -### header - -> **header**: `null` \| [`ItemSectionHeader`](ItemSectionHeader.md) \| [`ItemSectionTabbedHeader`](ItemSectionTabbedHeader.md) \| [`CommentsHeader`](CommentsHeader.md) \| [`SortFilterHeader`](SortFilterHeader.md) \| [`FeedFilterChipBar`](FeedFilterChipBar.md) - -#### Defined in - -[src/parser/classes/ItemSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSection.ts#L12) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/ItemSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSection.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ItemSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ItemSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSection.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ItemSection & { [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 ItemSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ItemSectionTab.md b/docs/api/namespaces/YTNodes/classes/ItemSectionTab.md deleted file mode 100644 index 94133152..00000000 --- a/docs/api/namespaces/YTNodes/classes/ItemSectionTab.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ItemSectionTab - -# Class: ItemSectionTab - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ItemSectionTab() - -> **new ItemSectionTab**(`data`): [`ItemSectionTab`](ItemSectionTab.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ItemSectionTab`](ItemSectionTab.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ItemSectionTab.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTab.ts#L13) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ItemSectionTab.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTab.ts#L11) - -*** - -### selected - -> **selected**: `boolean` - -#### Defined in - -[src/parser/classes/ItemSectionTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTab.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ItemSectionTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTab.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Tab'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ItemSectionTab.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTab.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ItemSectionTab & { [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 ItemSectionTab & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md b/docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md deleted file mode 100644 index 2bcdd591..00000000 --- a/docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ItemSectionTabbedHeader - -# Class: ItemSectionTabbedHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ItemSectionTabbedHeader() - -> **new ItemSectionTabbedHeader**(`data`): [`ItemSectionTabbedHeader`](ItemSectionTabbedHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ItemSectionTabbedHeader`](ItemSectionTabbedHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ItemSectionTabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTabbedHeader.ts#L13) - -## Properties - -### end\_items? - -> `optional` **end\_items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ItemSectionTabbedHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTabbedHeader.ts#L11) - -*** - -### tabs - -> **tabs**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ItemSectionTab`](ItemSectionTab.md)\> - -#### Defined in - -[src/parser/classes/ItemSectionTabbedHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTabbedHeader.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ItemSectionTabbedHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTabbedHeader.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ItemSectionTabbedHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ItemSectionTabbedHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ItemSectionTabbedHeader.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ItemSectionTabbedHeader & { [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 ItemSectionTabbedHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md b/docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md deleted file mode 100644 index 22b65301..00000000 --- a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / KidsBlocklistPicker - -# Class: KidsBlocklistPicker - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new KidsBlocklistPicker() - -> **new KidsBlocklistPicker**(`data`): [`KidsBlocklistPicker`](KidsBlocklistPicker.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`KidsBlocklistPicker`](KidsBlocklistPicker.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L15) - -## Properties - -### child\_rows - -> **child\_rows**: `null` \| [`KidsBlocklistPickerItem`](KidsBlocklistPickerItem.md)[] - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L11) - -*** - -### done\_button - -> **done\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L12) - -*** - -### successful\_toast\_action\_message - -> **successful\_toast\_action\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'KidsBlocklistPicker'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is KidsBlocklistPicker & { [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 KidsBlocklistPicker & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md b/docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md deleted file mode 100644 index d8c233f6..00000000 --- a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md +++ /dev/null @@ -1,283 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / KidsBlocklistPickerItem - -# Class: KidsBlocklistPickerItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new KidsBlocklistPickerItem() - -> **new KidsBlocklistPickerItem**(`data`): [`KidsBlocklistPickerItem`](KidsBlocklistPickerItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`KidsBlocklistPickerItem`](KidsBlocklistPickerItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L21) - -## Properties - -### avatar - -> **avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L17) - -*** - -### block\_button - -> **block\_button**: `null` \| [`ToggleButton`](ToggleButton.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L18) - -*** - -### blocked\_entity\_key - -> **blocked\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L19) - -*** - -### child\_account\_description - -> **child\_account\_description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L16) - -*** - -### child\_display\_name - -> **child\_display\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'KidsBlocklistPickerItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### blockChannel() - -> **blockChannel**(): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L30) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is KidsBlocklistPickerItem & { [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 KidsBlocklistPickerItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) - -*** - -### setActions() - -> **setActions**(`actions`): `void` - -#### Parameters - -• **actions**: `undefined` \| [`Actions`](../../../classes/Actions.md) - -#### Returns - -`void` - -#### Defined in - -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L46) diff --git a/docs/api/namespaces/YTNodes/classes/KidsCategoriesHeader.md b/docs/api/namespaces/YTNodes/classes/KidsCategoriesHeader.md deleted file mode 100644 index dac18f09..00000000 --- a/docs/api/namespaces/YTNodes/classes/KidsCategoriesHeader.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / KidsCategoriesHeader - -# Class: KidsCategoriesHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new KidsCategoriesHeader() - -> **new KidsCategoriesHeader**(`data`): [`KidsCategoriesHeader`](KidsCategoriesHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`KidsCategoriesHeader`](KidsCategoriesHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L13) - -## Properties - -### category\_tabs - -> **category\_tabs**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`KidsCategoryTab`](KidsCategoryTab.md)\> - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L10) - -*** - -### privacy\_button - -> **privacy\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'kidsCategoriesHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is KidsCategoriesHeader & { [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 KidsCategoriesHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md b/docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md deleted file mode 100644 index 5c75a551..00000000 --- a/docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md +++ /dev/null @@ -1,249 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / KidsCategoryTab - -# Class: KidsCategoryTab - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new KidsCategoryTab() - -> **new KidsCategoryTab**(`data`): [`KidsCategoryTab`](KidsCategoryTab.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`KidsCategoryTab`](KidsCategoryTab.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoryTab.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoryTab.ts#L17) - -## Properties - -### category\_assets - -> **category\_assets**: `object` - -#### asset\_key - -> **asset\_key**: `string` - -#### background\_color - -> **background\_color**: `string` - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoryTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoryTab.ts#L10) - -*** - -### category\_type - -> **category\_type**: `string` - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoryTab.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoryTab.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoryTab.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoryTab.ts#L15) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoryTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoryTab.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'KidsCategoryTab'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ytkids/KidsCategoryTab.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ytkids/KidsCategoryTab.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is KidsCategoryTab & { [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 KidsCategoryTab & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LikeButton.md b/docs/api/namespaces/YTNodes/classes/LikeButton.md deleted file mode 100644 index 1795a905..00000000 --- a/docs/api/namespaces/YTNodes/classes/LikeButton.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LikeButton - -# Class: LikeButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LikeButton() - -> **new LikeButton**(`data`): [`LikeButton`](LikeButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LikeButton`](LikeButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LikeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButton.ts#L16) - -## Properties - -### endpoints? - -> `optional` **endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/classes/LikeButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButton.ts#L14) - -*** - -### like\_status - -> **like\_status**: `string` - -#### Defined in - -[src/parser/classes/LikeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButton.ts#L12) - -*** - -### likes\_allowed - -> **likes\_allowed**: `string` - -#### Defined in - -[src/parser/classes/LikeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButton.ts#L13) - -*** - -### target - -> **target**: `object` - -#### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/LikeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButton.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LikeButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LikeButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButton.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LikeButton & { [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 LikeButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LikeButtonView.md b/docs/api/namespaces/YTNodes/classes/LikeButtonView.md deleted file mode 100644 index 4a068ee6..00000000 --- a/docs/api/namespaces/YTNodes/classes/LikeButtonView.md +++ /dev/null @@ -1,239 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LikeButtonView - -# Class: LikeButtonView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LikeButtonView() - -> **new LikeButtonView**(`data`): [`LikeButtonView`](LikeButtonView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LikeButtonView`](LikeButtonView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LikeButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButtonView.ts#L15) - -## Properties - -### like\_status\_entity - -> **like\_status\_entity**: `object` - -#### key - -> **key**: `string` - -#### like\_status - -> **like\_status**: `string` - -#### Defined in - -[src/parser/classes/LikeButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButtonView.ts#L10) - -*** - -### like\_status\_entity\_key - -> **like\_status\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/LikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButtonView.ts#L9) - -*** - -### toggle\_button - -> **toggle\_button**: `null` \| [`ToggleButtonView`](ToggleButtonView.md) - -#### Defined in - -[src/parser/classes/LikeButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButtonView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LikeButtonView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LikeButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LikeButtonView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LikeButtonView & { [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 LikeButtonView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LikeEndpoint.md b/docs/api/namespaces/YTNodes/classes/LikeEndpoint.md deleted file mode 100644 index 95da3710..00000000 --- a/docs/api/namespaces/YTNodes/classes/LikeEndpoint.md +++ /dev/null @@ -1,255 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LikeEndpoint - -# Class: LikeEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`LikeRequest`](../../APIResponseTypes/type-aliases/LikeRequest.md)\> - -## Constructors - -### new LikeEndpoint() - -> **new LikeEndpoint**(`data`): [`LikeEndpoint`](LikeEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LikeEndpoint`](LikeEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/LikeEndpoint.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LikeEndpoint.ts#L13) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LikeEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/LikeEndpoint.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LikeEndpoint.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`LikeRequest`](../../APIResponseTypes/type-aliases/LikeRequest.md) - -#### Returns - -[`LikeRequest`](../../APIResponseTypes/type-aliases/LikeRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/LikeEndpoint.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LikeEndpoint.ts#L24) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/LikeEndpoint.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LikeEndpoint.ts#L18) - -*** - -### getParams() - -> **getParams**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/endpoints/LikeEndpoint.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LikeEndpoint.ts#L37) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LikeEndpoint & { [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 LikeEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ListItemView.md b/docs/api/namespaces/YTNodes/classes/ListItemView.md deleted file mode 100644 index 8ae94f75..00000000 --- a/docs/api/namespaces/YTNodes/classes/ListItemView.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ListItemView - -# Class: ListItemView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ListItemView() - -> **new ListItemView**(`data`): [`ListItemView`](ListItemView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ListItemView`](ListItemView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ListItemView.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ListItemView.ts#L20) - -## Properties - -### leading\_accessory - -> **leading\_accessory**: `null` \| [`AvatarView`](AvatarView.md) - -#### Defined in - -[src/parser/classes/ListItemView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ListItemView.ts#L16) - -*** - -### renderer\_context - -> **renderer\_context**: [`RendererContext`](../../Misc/classes/RendererContext.md) - -#### Defined in - -[src/parser/classes/ListItemView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ListItemView.ts#L17) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ListItemView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ListItemView.ts#L15) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ListItemView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ListItemView.ts#L14) - -*** - -### trailing\_buttons? - -> `optional` **trailing\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SubscribeButtonView`](SubscribeButtonView.md)\> - -#### Defined in - -[src/parser/classes/ListItemView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ListItemView.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ListItemView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ListItemView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ListItemView.ts#L12) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ListItemView & { [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 ListItemView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md b/docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md deleted file mode 100644 index 75c1de4a..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatActionPanel - -# Class: LiveChatActionPanel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatActionPanel() - -> **new LiveChatActionPanel**(`data`): [`LiveChatActionPanel`](LiveChatActionPanel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatActionPanel`](LiveChatActionPanel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/LiveChatActionPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/LiveChatActionPanel.ts#L12) - -## Properties - -### contents - -> **contents**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/livechat/LiveChatActionPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/LiveChatActionPanel.ts#L9) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/LiveChatActionPanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/LiveChatActionPanel.ts#L8) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/LiveChatActionPanel.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/LiveChatActionPanel.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatActionPanel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/LiveChatActionPanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/LiveChatActionPanel.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatActionPanel & { [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 LiveChatActionPanel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md b/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md deleted file mode 100644 index 2cd6c58e..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md +++ /dev/null @@ -1,267 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatAuthorBadge - -# Class: LiveChatAuthorBadge - -## Extends - -- [`MetadataBadge`](MetadataBadge.md) - -## Constructors - -### new LiveChatAuthorBadge() - -> **new LiveChatAuthorBadge**(`data`): [`LiveChatAuthorBadge`](LiveChatAuthorBadge.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatAuthorBadge`](LiveChatAuthorBadge.md) - -#### Overrides - -[`MetadataBadge`](MetadataBadge.md).[`constructor`](MetadataBadge.md#constructors) - -#### Defined in - -[src/parser/classes/LiveChatAuthorBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatAuthorBadge.ts#L10) - -## Properties - -### custom\_thumbnail - -> **custom\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/LiveChatAuthorBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatAuthorBadge.ts#L8) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`icon_type`](MetadataBadge.md#icon_type) - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L7) - -*** - -### label? - -> `optional` **label**: `string` - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`label`](MetadataBadge.md#label) - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L9) - -*** - -### style? - -> `optional` **style**: `string` - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`style`](MetadataBadge.md#style) - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L8) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`tooltip`](MetadataBadge.md#tooltip) - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`type`](MetadataBadge.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatAuthorBadge'` - -#### Overrides - -[`MetadataBadge`](MetadataBadge.md).[`type`](MetadataBadge.md#type-1) - -#### Defined in - -[src/parser/classes/LiveChatAuthorBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatAuthorBadge.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`as`](MetadataBadge.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatAuthorBadge & { [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 LiveChatAuthorBadge & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`hasKey`](MetadataBadge.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`is`](MetadataBadge.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`MetadataBadge`](MetadataBadge.md).[`key`](MetadataBadge.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md deleted file mode 100644 index be334d50..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatAutoModMessage - -# Class: LiveChatAutoModMessage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatAutoModMessage() - -> **new LiveChatAutoModMessage**(`data`): [`LiveChatAutoModMessage`](LiveChatAutoModMessage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatAutoModMessage`](LiveChatAutoModMessage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L19) - -## Properties - -### auto\_moderated\_item - -> **auto\_moderated\_item**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L14) - -*** - -### header\_text - -> **header\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L17) - -*** - -### menu\_endpoint? - -> `optional` **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L12) - -*** - -### moderation\_buttons - -> **moderation\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md)\> - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L13) - -*** - -### timestamp - -> **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatAutoModMessage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatAutoModMessage & { [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 LiveChatAutoModMessage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBanner.md b/docs/api/namespaces/YTNodes/classes/LiveChatBanner.md deleted file mode 100644 index f955c3a8..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBanner.md +++ /dev/null @@ -1,301 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatBanner - -# Class: LiveChatBanner - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatBanner() - -> **new LiveChatBanner**(`data`): [`LiveChatBanner`](LiveChatBanner.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatBanner`](LiveChatBanner.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L20) - -## Properties - -### action\_id - -> **action\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L11) - -*** - -### background\_type? - -> `optional` **background\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L15) - -*** - -### banner\_properties\_auto\_collapse\_delay\_seconds? - -> `optional` **banner\_properties\_auto\_collapse\_delay\_seconds**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L18) - -*** - -### banner\_properties\_is\_ephemeral? - -> `optional` **banner\_properties\_is\_ephemeral**: `boolean` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L17) - -*** - -### banner\_type - -> **banner\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L16) - -*** - -### contents - -> **contents**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L10) - -*** - -### header - -> **header**: `null` \| [`LiveChatBannerHeader`](LiveChatBannerHeader.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L9) - -*** - -### is\_stackable - -> **is\_stackable**: `boolean` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L14) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### viewer\_is\_creator? - -> `optional` **viewer\_is\_creator**: `boolean` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatBanner'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBanner.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBanner.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatBanner & { [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 LiveChatBanner & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerChatSummary.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerChatSummary.md deleted file mode 100644 index a3840aed..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBannerChatSummary.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatBannerChatSummary - -# Class: LiveChatBannerChatSummary - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatBannerChatSummary() - -> **new LiveChatBannerChatSummary**(`data`): [`LiveChatBannerChatSummary`](LiveChatBannerChatSummary.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatBannerChatSummary`](LiveChatBannerChatSummary.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts#L15) - -## Properties - -### chat\_summary - -> **chat\_summary**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts#L10) - -*** - -### dislike\_feedback\_button - -> **dislike\_feedback\_button**: `null` \| [`ToggleButtonView`](ToggleButtonView.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts#L13) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts#L11) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts#L9) - -*** - -### like\_feedback\_button - -> **like\_feedback\_button**: `null` \| [`ToggleButtonView`](ToggleButtonView.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatBannerChatSummary'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerChatSummary.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatBannerChatSummary & { [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 LiveChatBannerChatSummary & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md deleted file mode 100644 index 7cd565a8..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatBannerHeader - -# Class: LiveChatBannerHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatBannerHeader() - -> **new LiveChatBannerHeader**(`data`): [`LiveChatBannerHeader`](LiveChatBannerHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatBannerHeader`](LiveChatBannerHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L14) - -## Properties - -### context\_menu\_button - -> **context\_menu\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L12) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L11) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatBannerHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatBannerHeader & { [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 LiveChatBannerHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md deleted file mode 100644 index a86f7914..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatBannerPoll - -# Class: LiveChatBannerPoll - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatBannerPoll() - -> **new LiveChatBannerPoll**(`data`): [`LiveChatBannerPoll`](LiveChatBannerPoll.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatBannerPoll`](LiveChatBannerPoll.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L23) - -## Properties - -### author\_photo - -> **author\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L12) - -*** - -### choices - -> **choices**: `object`[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L14) - -*** - -### collapsed\_state\_entity\_key - -> **collapsed\_state\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L19) - -*** - -### context\_menu\_button - -> **context\_menu\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L21) - -*** - -### live\_chat\_poll\_state\_entity\_key - -> **live\_chat\_poll\_state\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L20) - -*** - -### poll\_question - -> **poll\_question**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatBannerPoll'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatBannerPoll & { [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 LiveChatBannerPoll & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerRedirect.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerRedirect.md deleted file mode 100644 index bbde454e..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBannerRedirect.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatBannerRedirect - -# Class: LiveChatBannerRedirect - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatBannerRedirect() - -> **new LiveChatBannerRedirect**(`data`): [`LiveChatBannerRedirect`](LiveChatBannerRedirect.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatBannerRedirect`](LiveChatBannerRedirect.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerRedirect.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerRedirect.ts#L16) - -## Properties - -### author\_photo - -> **author\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerRedirect.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerRedirect.ts#L12) - -*** - -### banner\_message - -> **banner\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerRedirect.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerRedirect.ts#L11) - -*** - -### context\_menu\_button - -> **context\_menu\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerRedirect.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerRedirect.ts#L14) - -*** - -### inline\_action\_button - -> **inline\_action\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerRedirect.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerRedirect.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatBannerRedirect'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatBannerRedirect.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatBannerRedirect.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatBannerRedirect & { [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 LiveChatBannerRedirect & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatDialog.md b/docs/api/namespaces/YTNodes/classes/LiveChatDialog.md deleted file mode 100644 index 5558a15e..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatDialog.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatDialog - -# Class: LiveChatDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatDialog() - -> **new LiveChatDialog**(`data`): [`LiveChatDialog`](LiveChatDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatDialog`](LiveChatDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LiveChatDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatDialog.ts#L12) - -## Properties - -### confirm\_button - -> **confirm\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/LiveChatDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatDialog.ts#L9) - -*** - -### dialog\_messages - -> **dialog\_messages**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/LiveChatDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatDialog.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LiveChatDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatDialog.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatDialog & { [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 LiveChatDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatHeader.md b/docs/api/namespaces/YTNodes/classes/LiveChatHeader.md deleted file mode 100644 index 73fef179..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatHeader.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatHeader - -# Class: LiveChatHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatHeader() - -> **new LiveChatHeader**(`data`): [`LiveChatHeader`](LiveChatHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatHeader`](LiveChatHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LiveChatHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatHeader.ts#L14) - -## Properties - -### collapse\_button - -> **collapse\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/LiveChatHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatHeader.ts#L11) - -*** - -### overflow\_menu - -> **overflow\_menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/LiveChatHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatHeader.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_selector - -> **view\_selector**: `null` \| [`SortFilterSubMenu`](SortFilterSubMenu.md) - -#### Defined in - -[src/parser/classes/LiveChatHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatHeader.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LiveChatHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatHeader & { [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 LiveChatHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatItemBumperView.md b/docs/api/namespaces/YTNodes/classes/LiveChatItemBumperView.md deleted file mode 100644 index 393baed1..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatItemBumperView.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatItemBumperView - -# Class: LiveChatItemBumperView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatItemBumperView() - -> **new LiveChatItemBumperView**(`data`): [`LiveChatItemBumperView`](LiveChatItemBumperView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatItemBumperView`](LiveChatItemBumperView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatItemBumperView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatItemBumperView.ts#L10) - -## Properties - -### content - -> **content**: `null` \| [`BumperUserEduContentView`](BumperUserEduContentView.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatItemBumperView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatItemBumperView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatItemBumperView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatItemBumperView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatItemBumperView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatItemBumperView & { [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 LiveChatItemBumperView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatItemContextMenuEndpoint.md b/docs/api/namespaces/YTNodes/classes/LiveChatItemContextMenuEndpoint.md deleted file mode 100644 index 8c7b8bef..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatItemContextMenuEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatItemContextMenuEndpoint - -# Class: LiveChatItemContextMenuEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`LiveChatItemContextMenuRequest`](../../APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md)\> - -## Constructors - -### new LiveChatItemContextMenuEndpoint() - -> **new LiveChatItemContextMenuEndpoint**(`data`): [`LiveChatItemContextMenuEndpoint`](LiveChatItemContextMenuEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatItemContextMenuEndpoint`](LiveChatItemContextMenuEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatItemContextMenuEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`LiveChatItemContextMenuRequest`](../../APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md) - -#### Returns - -[`LiveChatItemContextMenuRequest`](../../APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatItemContextMenuEndpoint & { [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 LiveChatItemContextMenuEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatItemList.md b/docs/api/namespaces/YTNodes/classes/LiveChatItemList.md deleted file mode 100644 index 2a698518..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatItemList.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatItemList - -# Class: LiveChatItemList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatItemList() - -> **new LiveChatItemList**(`data`): [`LiveChatItemList`](LiveChatItemList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatItemList`](LiveChatItemList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LiveChatItemList.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatItemList.ts#L11) - -## Properties - -### max\_items\_to\_display - -> **max\_items\_to\_display**: `string` - -#### Defined in - -[src/parser/classes/LiveChatItemList.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatItemList.ts#L8) - -*** - -### more\_comments\_below\_button - -> **more\_comments\_below\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/LiveChatItemList.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatItemList.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatItemList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LiveChatItemList.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatItemList.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatItemList & { [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 LiveChatItemList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md deleted file mode 100644 index ef623f01..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md +++ /dev/null @@ -1,301 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatMembershipItem - -# Class: LiveChatMembershipItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatMembershipItem() - -> **new LiveChatMembershipItem**(`data`): [`LiveChatMembershipItem`](LiveChatMembershipItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatMembershipItem`](LiveChatMembershipItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L21) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L17) - -*** - -### context\_menu\_accessibility\_label - -> **context\_menu\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L19) - -*** - -### header\_primary\_text? - -> `optional` **header\_primary\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L14) - -*** - -### header\_subtext - -> **header\_subtext**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L10) - -*** - -### menu\_endpoint - -> **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L18) - -*** - -### message? - -> `optional` **message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L16) - -*** - -### timestamp - -> **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L11) - -*** - -### timestamp\_text? - -> `optional` **timestamp\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L13) - -*** - -### timestamp\_usec - -> **timestamp\_usec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatMembershipItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatMembershipItem & { [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 LiveChatMembershipItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md b/docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md deleted file mode 100644 index 0e191317..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatMessageInput - -# Class: LiveChatMessageInput - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatMessageInput() - -> **new LiveChatMessageInput**(`data`): [`LiveChatMessageInput`](LiveChatMessageInput.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatMessageInput`](LiveChatMessageInput.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LiveChatMessageInput.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatMessageInput.ts#L15) - -## Properties - -### author\_name - -> **author\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/LiveChatMessageInput.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatMessageInput.ts#L10) - -*** - -### author\_photo - -> **author\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/LiveChatMessageInput.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatMessageInput.ts#L11) - -*** - -### send\_button - -> **send\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/LiveChatMessageInput.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatMessageInput.ts#L12) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/LiveChatMessageInput.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatMessageInput.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatMessageInput'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LiveChatMessageInput.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatMessageInput.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatMessageInput & { [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 LiveChatMessageInput & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatModeChangeMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatModeChangeMessage.md deleted file mode 100644 index 64c3fdc4..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatModeChangeMessage.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatModeChangeMessage - -# Class: LiveChatModeChangeMessage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatModeChangeMessage() - -> **new LiveChatModeChangeMessage**(`data`): [`LiveChatModeChangeMessage`](LiveChatModeChangeMessage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatModeChangeMessage`](LiveChatModeChangeMessage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L16) - -## Properties - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L9) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L8) - -*** - -### subtext - -> **subtext**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L11) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L10) - -*** - -### timestamp - -> **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L12) - -*** - -### timestamp\_text - -> **timestamp\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L14) - -*** - -### timestamp\_usec - -> **timestamp\_usec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatModeChangeMessage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatModeChangeMessage.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatModeChangeMessage & { [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 LiveChatModeChangeMessage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md deleted file mode 100644 index 9ca0682f..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md +++ /dev/null @@ -1,411 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatPaidMessage - -# Class: LiveChatPaidMessage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatPaidMessage() - -> **new LiveChatPaidMessage**(`data`): [`LiveChatPaidMessage`](LiveChatPaidMessage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatPaidMessage`](LiveChatPaidMessage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L36) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L16) - -*** - -### author\_name\_text\_color - -> **author\_name\_text\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L17) - -*** - -### body\_background\_color - -> **body\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L20) - -*** - -### body\_text\_color - -> **body\_text\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L21) - -*** - -### context\_menu\_accessibility\_label - -> **context\_menu\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L24) - -*** - -### creator\_heart\_button - -> **creator\_heart\_button**: `null` \| [`CreatorHeartView`](CreatorHeartView.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L32) - -*** - -### header\_background\_color - -> **header\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L18) - -*** - -### header\_overlay\_image? - -> `optional` **header\_overlay\_image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L29) - -*** - -### header\_text\_color - -> **header\_text\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L19) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L14) - -*** - -### is\_v2\_style - -> **is\_v2\_style**: `boolean` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L33) - -*** - -### lower\_bumper - -> **lower\_bumper**: `null` \| [`LiveChatItemBumperView`](LiveChatItemBumperView.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L31) - -*** - -### menu\_endpoint - -> **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L23) - -*** - -### message - -> **message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L15) - -*** - -### purchase\_amount - -> **purchase\_amount**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L22) - -*** - -### reply\_button - -> **reply\_button**: `null` \| [`PdgReplyButtonView`](PdgReplyButtonView.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L34) - -*** - -### text\_input\_background\_color - -> **text\_input\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L30) - -*** - -### timestamp - -> **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L25) - -*** - -### timestamp\_color - -> **timestamp\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L28) - -*** - -### timestamp\_text? - -> `optional` **timestamp\_text**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L27) - -*** - -### timestamp\_usec - -> **timestamp\_usec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L26) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatPaidMessage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L12) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatPaidMessage & { [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 LiveChatPaidMessage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md b/docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md deleted file mode 100644 index 2cf63e84..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md +++ /dev/null @@ -1,371 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatPaidSticker - -# Class: LiveChatPaidSticker - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatPaidSticker() - -> **new LiveChatPaidSticker**(`data`): [`LiveChatPaidSticker`](LiveChatPaidSticker.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatPaidSticker`](LiveChatPaidSticker.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L29) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L12) - -*** - -### author\_name\_text\_color - -> **author\_name\_text\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L16) - -*** - -### background\_color - -> **background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L15) - -*** - -### context\_menu - -> **context\_menu**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L23) - -*** - -### context\_menu\_accessibility\_label - -> **context\_menu\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L24) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L11) - -*** - -### is\_v2\_style - -> **is\_v2\_style**: `boolean` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L27) - -*** - -### menu\_endpoint - -> **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L22) - -*** - -### money\_chip\_background\_color - -> **money\_chip\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L13) - -*** - -### money\_chip\_text\_color - -> **money\_chip\_text\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L14) - -*** - -### purchase\_amount - -> **purchase\_amount**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L21) - -*** - -### sticker - -> **sticker**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L17) - -*** - -### sticker\_accessibility\_label - -> **sticker\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L18) - -*** - -### sticker\_display\_height - -> **sticker\_display\_height**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L20) - -*** - -### sticker\_display\_width - -> **sticker\_display\_width**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L19) - -*** - -### timestamp - -> **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L25) - -*** - -### timestamp\_usec - -> **timestamp\_usec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L26) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatPaidSticker'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatPaidSticker & { [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 LiveChatPaidSticker & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md b/docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md deleted file mode 100644 index 6640ecd9..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatParticipant - -# Class: LiveChatParticipant - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatParticipant() - -> **new LiveChatParticipant**(`data`): [`LiveChatParticipant`](LiveChatParticipant.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatParticipant`](LiveChatParticipant.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LiveChatParticipant.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatParticipant.ts#L13) - -## Properties - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/LiveChatParticipant.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatParticipant.ts#L11) - -*** - -### name - -> **name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/LiveChatParticipant.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatParticipant.ts#L9) - -*** - -### photo - -> **photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/LiveChatParticipant.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatParticipant.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatParticipant'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LiveChatParticipant.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LiveChatParticipant.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatParticipant & { [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 LiveChatParticipant & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md deleted file mode 100644 index 9b6058a1..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatPlaceholderItem - -# Class: LiveChatPlaceholderItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatPlaceholderItem() - -> **new LiveChatPlaceholderItem**(`data`): [`LiveChatPlaceholderItem`](LiveChatPlaceholderItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatPlaceholderItem`](LiveChatPlaceholderItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L10) - -## Properties - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L7) - -*** - -### timestamp - -> **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatPlaceholderItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatPlaceholderItem & { [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 LiveChatPlaceholderItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md deleted file mode 100644 index ca4f5cfc..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md +++ /dev/null @@ -1,341 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatProductItem - -# Class: LiveChatProductItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatProductItem() - -> **new LiveChatProductItem**(`data`): [`LiveChatProductItem`](LiveChatProductItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatProductItem`](LiveChatProductItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L27) - -## Properties - -### accessibility\_title - -> **accessibility\_title**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L13) - -*** - -### author\_photo - -> **author\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L22) - -*** - -### creator\_custom\_message - -> **creator\_custom\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L25) - -*** - -### creator\_message - -> **creator\_message**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L20) - -*** - -### creator\_name - -> **creator\_name**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L21) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L19) - -*** - -### from\_vendor\_text - -> **from\_vendor\_text**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L17) - -*** - -### information\_button - -> **information\_button**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L18) - -*** - -### information\_dialog - -> **information\_dialog**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L23) - -*** - -### is\_verified - -> **is\_verified**: `boolean` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L24) - -*** - -### price - -> **price**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L15) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L14) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### vendor\_name - -> **vendor\_name**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L16) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatProductItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatProductItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatProductItem.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatProductItem & { [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 LiveChatProductItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md b/docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md deleted file mode 100644 index 4ceb3576..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatRestrictedParticipation - -# Class: LiveChatRestrictedParticipation - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatRestrictedParticipation() - -> **new LiveChatRestrictedParticipation**(`data`): [`LiveChatRestrictedParticipation`](LiveChatRestrictedParticipation.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatRestrictedParticipation`](LiveChatRestrictedParticipation.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L11) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L9) - -*** - -### message - -> **message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatRestrictedParticipation'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatRestrictedParticipation & { [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 LiveChatRestrictedParticipation & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md deleted file mode 100644 index adbbe094..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatSponsorshipsGiftPurchaseAnnouncement - -# Class: LiveChatSponsorshipsGiftPurchaseAnnouncement - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatSponsorshipsGiftPurchaseAnnouncement() - -> **new LiveChatSponsorshipsGiftPurchaseAnnouncement**(`data`): [`LiveChatSponsorshipsGiftPurchaseAnnouncement`](LiveChatSponsorshipsGiftPurchaseAnnouncement.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatSponsorshipsGiftPurchaseAnnouncement`](LiveChatSponsorshipsGiftPurchaseAnnouncement.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts#L13) - -## Properties - -### author\_external\_channel\_id - -> **author\_external\_channel\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts#L10) - -*** - -### header - -> **header**: `null` \| [`LiveChatSponsorshipsHeader`](LiveChatSponsorshipsHeader.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts#L11) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts#L8) - -*** - -### timestamp\_usec - -> **timestamp\_usec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatSponsorshipsGiftPurchaseAnnouncement'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftPurchaseAnnouncement.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatSponsorshipsGiftPurchaseAnnouncement & { [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 LiveChatSponsorshipsGiftPurchaseAnnouncement & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md deleted file mode 100644 index 00296029..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatSponsorshipsGiftRedemptionAnnouncement - -# Class: LiveChatSponsorshipsGiftRedemptionAnnouncement - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatSponsorshipsGiftRedemptionAnnouncement() - -> **new LiveChatSponsorshipsGiftRedemptionAnnouncement**(`data`): [`LiveChatSponsorshipsGiftRedemptionAnnouncement`](LiveChatSponsorshipsGiftRedemptionAnnouncement.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatSponsorshipsGiftRedemptionAnnouncement`](LiveChatSponsorshipsGiftRedemptionAnnouncement.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L18) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L13) - -*** - -### context\_menu\_accessibility\_label - -> **context\_menu\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L16) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L10) - -*** - -### menu\_endpoint - -> **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L15) - -*** - -### message - -> **message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L14) - -*** - -### timestamp\_text - -> **timestamp\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L12) - -*** - -### timestamp\_usec - -> **timestamp\_usec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatSponsorshipsGiftRedemptionAnnouncement'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsGiftRedemptionAnnouncement.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatSponsorshipsGiftRedemptionAnnouncement & { [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 LiveChatSponsorshipsGiftRedemptionAnnouncement & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsHeader.md b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsHeader.md deleted file mode 100644 index 3123e25f..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsHeader.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatSponsorshipsHeader - -# Class: LiveChatSponsorshipsHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatSponsorshipsHeader() - -> **new LiveChatSponsorshipsHeader**(`data`): [`LiveChatSponsorshipsHeader`](LiveChatSponsorshipsHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatSponsorshipsHeader`](LiveChatSponsorshipsHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L21) - -## Properties - -### author\_badges - -> **author\_badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`LiveChatAuthorBadge`](LiveChatAuthorBadge.md)\> - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L15) - -*** - -### author\_name - -> **author\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L13) - -*** - -### author\_photo - -> **author\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L14) - -*** - -### context\_menu\_accessibility\_label - -> **context\_menu\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L18) - -*** - -### image - -> **image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L19) - -*** - -### menu\_endpoint - -> **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L17) - -*** - -### primary\_text - -> **primary\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatSponsorshipsHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatSponsorshipsHeader & { [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 LiveChatSponsorshipsHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md deleted file mode 100644 index 40a438de..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md +++ /dev/null @@ -1,301 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatTextMessage - -# Class: LiveChatTextMessage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatTextMessage() - -> **new LiveChatTextMessage**(`data`): [`LiveChatTextMessage`](LiveChatTextMessage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatTextMessage`](LiveChatTextMessage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L24) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L19) - -*** - -### before\_content\_buttons - -> **before\_content\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ButtonView`](ButtonView.md)\> - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L22) - -*** - -### context\_menu\_accessibility\_label? - -> `optional` **context\_menu\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L21) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L13) - -*** - -### inline\_action\_buttons - -> **inline\_action\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md)\> - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L15) - -*** - -### menu\_endpoint? - -> `optional` **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L20) - -*** - -### message - -> **message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L14) - -*** - -### timestamp - -> **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L16) - -*** - -### timestamp\_text? - -> `optional` **timestamp\_text**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L18) - -*** - -### timestamp\_usec - -> **timestamp\_usec**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatTextMessage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatTextMessage & { [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 LiveChatTextMessage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md deleted file mode 100644 index 5f1894c1..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md +++ /dev/null @@ -1,321 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatTickerPaidMessageItem - -# Class: LiveChatTickerPaidMessageItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatTickerPaidMessageItem() - -> **new LiveChatTickerPaidMessageItem**(`data`): [`LiveChatTickerPaidMessageItem`](LiveChatTickerPaidMessageItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatTickerPaidMessageItem`](LiveChatTickerPaidMessageItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L25) - -## Properties - -### amount? - -> `optional` **amount**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L14) - -*** - -### amount\_text\_color - -> **amount\_text\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L15) - -*** - -### animation\_origin - -> **animation\_origin**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L22) - -*** - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L13) - -*** - -### duration\_sec - -> **duration\_sec**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L18) - -*** - -### end\_background\_color - -> **end\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L17) - -*** - -### full\_duration\_sec - -> **full\_duration\_sec**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L19) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L12) - -*** - -### open\_engagement\_panel\_command - -> **open\_engagement\_panel\_command**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L23) - -*** - -### show\_item - -> **show\_item**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L20) - -*** - -### show\_item\_endpoint - -> **show\_item\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L21) - -*** - -### start\_background\_color - -> **start\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatTickerPaidMessageItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatTickerPaidMessageItem & { [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 LiveChatTickerPaidMessageItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md deleted file mode 100644 index f3e03d2c..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md +++ /dev/null @@ -1,301 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatTickerPaidStickerItem - -# Class: LiveChatTickerPaidStickerItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatTickerPaidStickerItem() - -> **new LiveChatTickerPaidStickerItem**(`data`): [`LiveChatTickerPaidStickerItem`](LiveChatTickerPaidStickerItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatTickerPaidStickerItem`](LiveChatTickerPaidStickerItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L23) - -## Properties - -### author\_external\_channel\_id - -> **author\_external\_channel\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L10) - -*** - -### author\_photo - -> **author\_photo**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L11) - -*** - -### duration\_sec - -> **duration\_sec**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L14) - -*** - -### end\_background\_color - -> **end\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L13) - -*** - -### full\_duration\_sec - -> **full\_duration\_sec**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L9) - -*** - -### show\_item - -> **show\_item**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L16) - -*** - -### show\_item\_endpoint - -> **show\_item\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L17) - -*** - -### start\_background\_color - -> **start\_background\_color**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L12) - -*** - -### ticker\_thumbnails - -> **ticker\_thumbnails**: `object`[] - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatTickerPaidStickerItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatTickerPaidStickerItem & { [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 LiveChatTickerPaidStickerItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md deleted file mode 100644 index 6d755971..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatTickerSponsorItem - -# Class: LiveChatTickerSponsorItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatTickerSponsorItem() - -> **new LiveChatTickerSponsorItem**(`data`): [`LiveChatTickerSponsorItem`](LiveChatTickerSponsorItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatTickerSponsorItem`](LiveChatTickerSponsorItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L14) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L11) - -*** - -### detail - -> **detail**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L10) - -*** - -### duration\_sec - -> **duration\_sec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L12) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatTickerSponsorItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatTickerSponsorItem & { [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 LiveChatTickerSponsorItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md deleted file mode 100644 index be475d52..00000000 --- a/docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md +++ /dev/null @@ -1,281 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LiveChatViewerEngagementMessage - -# Class: LiveChatViewerEngagementMessage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LiveChatViewerEngagementMessage() - -> **new LiveChatViewerEngagementMessage**(`data`): [`LiveChatViewerEngagementMessage`](LiveChatViewerEngagementMessage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LiveChatViewerEngagementMessage`](LiveChatViewerEngagementMessage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L19) - -## Properties - -### action\_button - -> **action\_button**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L15) - -*** - -### context\_menu\_accessibility\_label? - -> `optional` **context\_menu\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L17) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L13) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L10) - -*** - -### menu\_endpoint? - -> `optional` **menu\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L16) - -*** - -### message - -> **message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L14) - -*** - -### timestamp? - -> `optional` **timestamp**: `number` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L11) - -*** - -### timestamp\_usec? - -> `optional` **timestamp\_usec**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LiveChatViewerEngagementMessage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatViewerEngagementMessage & { [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 LiveChatViewerEngagementMessage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LockupMetadataView.md b/docs/api/namespaces/YTNodes/classes/LockupMetadataView.md deleted file mode 100644 index b0ccc241..00000000 --- a/docs/api/namespaces/YTNodes/classes/LockupMetadataView.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LockupMetadataView - -# Class: LockupMetadataView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LockupMetadataView() - -> **new LockupMetadataView**(`data`): [`LockupMetadataView`](LockupMetadataView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LockupMetadataView`](LockupMetadataView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LockupMetadataView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupMetadataView.ts#L17) - -## Properties - -### image - -> **image**: `null` \| [`AvatarStackView`](AvatarStackView.md) \| [`DecoratedAvatarView`](DecoratedAvatarView.md) - -#### Defined in - -[src/parser/classes/LockupMetadataView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupMetadataView.ts#L14) - -*** - -### menu\_button - -> **menu\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/LockupMetadataView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupMetadataView.ts#L15) - -*** - -### metadata - -> **metadata**: `null` \| [`ContentMetadataView`](ContentMetadataView.md) - -#### Defined in - -[src/parser/classes/LockupMetadataView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupMetadataView.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/LockupMetadataView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupMetadataView.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LockupMetadataView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LockupMetadataView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupMetadataView.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LockupMetadataView & { [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 LockupMetadataView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/LockupView.md b/docs/api/namespaces/YTNodes/classes/LockupView.md deleted file mode 100644 index db7fa434..00000000 --- a/docs/api/namespaces/YTNodes/classes/LockupView.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / LockupView - -# Class: LockupView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new LockupView() - -> **new LockupView**(`data`): [`LockupView`](LockupView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`LockupView`](LockupView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/LockupView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupView.ts#L17) - -## Properties - -### content\_id - -> **content\_id**: `string` - -#### Defined in - -[src/parser/classes/LockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupView.ts#L13) - -*** - -### content\_image - -> **content\_image**: `null` \| [`ThumbnailView`](ThumbnailView.md) \| [`CollectionThumbnailView`](CollectionThumbnailView.md) - -#### Defined in - -[src/parser/classes/LockupView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupView.ts#L11) - -*** - -### content\_type - -> **content\_type**: `"UNSPECIFIED"` \| `"VIDEO"` \| `"PLAYLIST"` \| `"SHORT"` \| `"CHANNEL"` \| `"ALBUM"` \| `"PRODUCT"` \| `"GAME"` \| `"CLIP"` \| `"PODCAST"` \| `"SOURCE"` \| `"SHOPPING_COLLECTION"` \| `"MOVIE"` - -#### Defined in - -[src/parser/classes/LockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupView.ts#L14) - -*** - -### metadata - -> **metadata**: `null` \| [`LockupMetadataView`](LockupMetadataView.md) - -#### Defined in - -[src/parser/classes/LockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupView.ts#L12) - -*** - -### renderer\_context - -> **renderer\_context**: [`RendererContext`](../../Misc/classes/RendererContext.md) - -#### Defined in - -[src/parser/classes/LockupView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupView.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'LockupView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/LockupView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/LockupView.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is LockupView & { [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 LockupView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md b/docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md deleted file mode 100644 index 2c44f8c9..00000000 --- a/docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MacroMarkersInfoItem - -# Class: MacroMarkersInfoItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MacroMarkersInfoItem() - -> **new MacroMarkersInfoItem**(`data`): [`MacroMarkersInfoItem`](MacroMarkersInfoItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MacroMarkersInfoItem`](MacroMarkersInfoItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MacroMarkersInfoItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersInfoItem.ts#L12) - -## Properties - -### info\_text - -> **info\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MacroMarkersInfoItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersInfoItem.ts#L9) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/MacroMarkersInfoItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersInfoItem.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MacroMarkersInfoItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MacroMarkersInfoItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersInfoItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MacroMarkersInfoItem & { [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 MacroMarkersInfoItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md b/docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md deleted file mode 100644 index 58bd725b..00000000 --- a/docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md +++ /dev/null @@ -1,323 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MacroMarkersListEntity - -# Class: MacroMarkersListEntity - -Represents a list of markers for a video. Can contain different types of markers: -- MARKER_TYPE_HEATMAP: Heat map markers showing audience engagement data -- Other marker types may exist but are not currently handled - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MacroMarkersListEntity() - -> **new MacroMarkersListEntity**(`data`): [`MacroMarkersListEntity`](MacroMarkersListEntity.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MacroMarkersListEntity`](MacroMarkersListEntity.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L30) - -## Properties - -### external\_video\_id - -> **external\_video\_id**: `string` - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L17) - -*** - -### marker\_entity\_key - -> **marker\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L16) - -*** - -### marker\_type - -> **marker\_type**: `string` - -The type of markers in this entity (e.g., 'MARKER_TYPE_HEATMAP') - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L19) - -*** - -### markers - -> **markers**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`HeatMarker`](HeatMarker.md)\> - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L20) - -*** - -### max\_height\_dp - -> **max\_height\_dp**: `number` - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L21) - -*** - -### min\_height\_dp - -> **min\_height\_dp**: `number` - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L22) - -*** - -### show\_hide\_animation\_duration\_millis - -> **show\_hide\_animation\_duration\_millis**: `number` - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L23) - -*** - -### timed\_marker\_decorations - -> **timed\_marker\_decorations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`TimedMarkerDecoration`](TimedMarkerDecoration.md)\> - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L24) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MacroMarkersListEntity'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L14) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MacroMarkersListEntity & { [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 MacroMarkersListEntity & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### isHeatmap() - -> **isHeatmap**(): `boolean` - -Checks if this MacroMarkersListEntity represents heatmap data. -Only heatmap markers can be converted to Heatmap objects. - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:65](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L65) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) - -*** - -### toHeatmap() - -> **toHeatmap**(): `null` \| [`Heatmap`](Heatmap.md) - -Converts this MacroMarkersListEntity to a Heatmap object -for compatibility with existing code. Only works for heatmap markers. - -#### Returns - -`null` \| [`Heatmap`](Heatmap.md) - -Heatmap object if this entity contains heatmap data, null otherwise - -#### Defined in - -[src/parser/classes/MacroMarkersListEntity.ts:74](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListEntity.ts#L74) diff --git a/docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md b/docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md deleted file mode 100644 index 1aa8e2b8..00000000 --- a/docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MacroMarkersListItem - -# Class: MacroMarkersListItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MacroMarkersListItem() - -> **new MacroMarkersListItem**(`data`): [`MacroMarkersListItem`](MacroMarkersListItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MacroMarkersListItem`](MacroMarkersListItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L18) - -## Properties - -### is\_highlighted - -> **is\_highlighted**: `boolean` - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L16) - -*** - -### layout - -> **layout**: `string` - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L15) - -*** - -### on\_tap\_endpoint - -> **on\_tap\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L14) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L13) - -*** - -### time\_description - -> **time\_description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MacroMarkersListItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MacroMarkersListItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MacroMarkersListItem.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MacroMarkersListItem & { [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 MacroMarkersListItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md b/docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md deleted file mode 100644 index c27600d0..00000000 --- a/docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MarkChatItemAsDeletedAction - -# Class: MarkChatItemAsDeletedAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MarkChatItemAsDeletedAction() - -> **new MarkChatItemAsDeletedAction**(`data`): [`MarkChatItemAsDeletedAction`](MarkChatItemAsDeletedAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MarkChatItemAsDeletedAction`](MarkChatItemAsDeletedAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L11) - -## Properties - -### deleted\_state\_message - -> **deleted\_state\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L8) - -*** - -### target\_item\_id - -> **target\_item\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MarkChatItemAsDeletedAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MarkChatItemAsDeletedAction & { [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 MarkChatItemAsDeletedAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md b/docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md deleted file mode 100644 index c22fdc82..00000000 --- a/docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MarkChatItemsByAuthorAsDeletedAction - -# Class: MarkChatItemsByAuthorAsDeletedAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MarkChatItemsByAuthorAsDeletedAction() - -> **new MarkChatItemsByAuthorAsDeletedAction**(`data`): [`MarkChatItemsByAuthorAsDeletedAction`](MarkChatItemsByAuthorAsDeletedAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MarkChatItemsByAuthorAsDeletedAction`](MarkChatItemsByAuthorAsDeletedAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L11) - -## Properties - -### deleted\_state\_message - -> **deleted\_state\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L8) - -*** - -### external\_channel\_id - -> **external\_channel\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MarkChatItemsByAuthorAsDeletedAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MarkChatItemsByAuthorAsDeletedAction & { [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 MarkChatItemsByAuthorAsDeletedAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Menu.md b/docs/api/namespaces/YTNodes/classes/Menu.md deleted file mode 100644 index d8fb740b..00000000 --- a/docs/api/namespaces/YTNodes/classes/Menu.md +++ /dev/null @@ -1,269 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Menu - -# Class: Menu - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Menu() - -> **new Menu**(`data`): [`Menu`](Menu.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Menu`](Menu.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/menus/Menu.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L22) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/menus/Menu.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L20) - -*** - -### flexible\_items - -> **flexible\_items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MenuFlexibleItem`](MenuFlexibleItem.md)\> - -#### Defined in - -[src/parser/classes/menus/Menu.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L18) - -*** - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/menus/Menu.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L17) - -*** - -### top\_level\_buttons - -> **top\_level\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`ToggleButton`](ToggleButton.md) \| [`ButtonView`](ButtonView.md) \| [`SegmentedLikeDislikeButtonView`](SegmentedLikeDislikeButtonView.md) \| [`LikeButton`](LikeButton.md) \| [`FlexibleActionsView`](FlexibleActionsView.md)\> - -#### Defined in - -[src/parser/classes/menus/Menu.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L19) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Menu'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/menus/Menu.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L15) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/menus/Menu.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L41) - -*** - -### label - -> `get` **label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/menus/Menu.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/Menu.ts#L36) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Menu & { [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 Menu & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MenuFlexibleItem.md b/docs/api/namespaces/YTNodes/classes/MenuFlexibleItem.md deleted file mode 100644 index 97c77ad5..00000000 --- a/docs/api/namespaces/YTNodes/classes/MenuFlexibleItem.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MenuFlexibleItem - -# Class: MenuFlexibleItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MenuFlexibleItem() - -> **new MenuFlexibleItem**(`data`): [`MenuFlexibleItem`](MenuFlexibleItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MenuFlexibleItem`](MenuFlexibleItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/menus/MenuFlexibleItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuFlexibleItem.ts#L17) - -## Properties - -### menu\_item - -> **menu\_item**: `null` \| [`MenuServiceItem`](MenuServiceItem.md) \| [`MenuServiceItemDownload`](MenuServiceItemDownload.md) - -#### Defined in - -[src/parser/classes/menus/MenuFlexibleItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuFlexibleItem.ts#L14) - -*** - -### top\_level\_button - -> **top\_level\_button**: `null` \| [`Button`](Button.md) \| [`ButtonView`](ButtonView.md) \| [`DownloadButton`](DownloadButton.md) - -#### Defined in - -[src/parser/classes/menus/MenuFlexibleItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuFlexibleItem.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MenuFlexibleItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/menus/MenuFlexibleItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuFlexibleItem.ts#L12) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MenuFlexibleItem & { [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 MenuFlexibleItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md b/docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md deleted file mode 100644 index 51bae522..00000000 --- a/docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md +++ /dev/null @@ -1,341 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MenuNavigationItem - -# Class: MenuNavigationItem - -## Extends - -- [`Button`](Button.md) - -## Constructors - -### new MenuNavigationItem() - -> **new MenuNavigationItem**(`data`): [`MenuNavigationItem`](MenuNavigationItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MenuNavigationItem`](MenuNavigationItem.md) - -#### Overrides - -[`Button`](Button.md).[`constructor`](Button.md#constructors) - -#### Defined in - -[src/parser/classes/menus/MenuNavigationItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuNavigationItem.ts#L7) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Inherited from - -[`Button`](Button.md).[`accessibility`](Button.md#accessibility) - -#### Defined in - -[src/parser/classes/Button.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L19) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Inherited from - -[`Button`](Button.md).[`endpoint`](Button.md#endpoint) - -#### Defined in - -[src/parser/classes/Button.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L18) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Inherited from - -[`Button`](Button.md).[`icon_type`](Button.md#icon_type) - -#### Defined in - -[src/parser/classes/Button.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L15) - -*** - -### is\_disabled? - -> `optional` **is\_disabled**: `boolean` - -#### Inherited from - -[`Button`](Button.md).[`is_disabled`](Button.md#is_disabled) - -#### Defined in - -[src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L16) - -*** - -### label? - -> `optional` **label**: `string` - -#### Inherited from - -[`Button`](Button.md).[`label`](Button.md#label) - -#### Defined in - -[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L11) - -*** - -### size? - -> `optional` **size**: `string` - -#### Inherited from - -[`Button`](Button.md).[`size`](Button.md#size) - -#### Defined in - -[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L14) - -*** - -### style? - -> `optional` **style**: `string` - -#### Inherited from - -[`Button`](Button.md).[`style`](Button.md#style) - -#### Defined in - -[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L13) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Inherited from - -[`Button`](Button.md).[`target_id`](Button.md#target_id) - -#### Defined in - -[src/parser/classes/Button.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L17) - -*** - -### text? - -> `optional` **text**: `string` - -#### Inherited from - -[`Button`](Button.md).[`text`](Button.md#text) - -#### Defined in - -[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L10) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Inherited from - -[`Button`](Button.md).[`tooltip`](Button.md#tooltip) - -#### Defined in - -[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`Button`](Button.md).[`type`](Button.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MenuNavigationItem'` - -#### Overrides - -[`Button`](Button.md).[`type`](Button.md#type-1) - -#### Defined in - -[src/parser/classes/menus/MenuNavigationItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuNavigationItem.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`Button`](Button.md).[`as`](Button.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MenuNavigationItem & { [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 MenuNavigationItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`Button`](Button.md).[`hasKey`](Button.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`Button`](Button.md).[`is`](Button.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`Button`](Button.md).[`key`](Button.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MenuServiceItem.md b/docs/api/namespaces/YTNodes/classes/MenuServiceItem.md deleted file mode 100644 index 43acf733..00000000 --- a/docs/api/namespaces/YTNodes/classes/MenuServiceItem.md +++ /dev/null @@ -1,341 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MenuServiceItem - -# Class: MenuServiceItem - -## Extends - -- [`Button`](Button.md) - -## Constructors - -### new MenuServiceItem() - -> **new MenuServiceItem**(`data`): [`MenuServiceItem`](MenuServiceItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MenuServiceItem`](MenuServiceItem.md) - -#### Overrides - -[`Button`](Button.md).[`constructor`](Button.md#constructors) - -#### Defined in - -[src/parser/classes/menus/MenuServiceItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuServiceItem.ts#L7) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Inherited from - -[`Button`](Button.md).[`accessibility`](Button.md#accessibility) - -#### Defined in - -[src/parser/classes/Button.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L19) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Inherited from - -[`Button`](Button.md).[`endpoint`](Button.md#endpoint) - -#### Defined in - -[src/parser/classes/Button.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L18) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Inherited from - -[`Button`](Button.md).[`icon_type`](Button.md#icon_type) - -#### Defined in - -[src/parser/classes/Button.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L15) - -*** - -### is\_disabled? - -> `optional` **is\_disabled**: `boolean` - -#### Inherited from - -[`Button`](Button.md).[`is_disabled`](Button.md#is_disabled) - -#### Defined in - -[src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L16) - -*** - -### label? - -> `optional` **label**: `string` - -#### Inherited from - -[`Button`](Button.md).[`label`](Button.md#label) - -#### Defined in - -[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L11) - -*** - -### size? - -> `optional` **size**: `string` - -#### Inherited from - -[`Button`](Button.md).[`size`](Button.md#size) - -#### Defined in - -[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L14) - -*** - -### style? - -> `optional` **style**: `string` - -#### Inherited from - -[`Button`](Button.md).[`style`](Button.md#style) - -#### Defined in - -[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L13) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Inherited from - -[`Button`](Button.md).[`target_id`](Button.md#target_id) - -#### Defined in - -[src/parser/classes/Button.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L17) - -*** - -### text? - -> `optional` **text**: `string` - -#### Inherited from - -[`Button`](Button.md).[`text`](Button.md#text) - -#### Defined in - -[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L10) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Inherited from - -[`Button`](Button.md).[`tooltip`](Button.md#tooltip) - -#### Defined in - -[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Button.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`Button`](Button.md).[`type`](Button.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MenuServiceItem'` - -#### Overrides - -[`Button`](Button.md).[`type`](Button.md#type-1) - -#### Defined in - -[src/parser/classes/menus/MenuServiceItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuServiceItem.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`Button`](Button.md).[`as`](Button.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MenuServiceItem & { [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 MenuServiceItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`Button`](Button.md).[`hasKey`](Button.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`Button`](Button.md).[`is`](Button.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`Button`](Button.md).[`key`](Button.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md b/docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md deleted file mode 100644 index d28822d9..00000000 --- a/docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MenuServiceItemDownload - -# Class: MenuServiceItemDownload - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MenuServiceItemDownload() - -> **new MenuServiceItemDownload**(`data`): [`MenuServiceItemDownload`](MenuServiceItemDownload.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MenuServiceItemDownload`](MenuServiceItemDownload.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/menus/MenuServiceItemDownload.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuServiceItemDownload.ts#L11) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/menus/MenuServiceItemDownload.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuServiceItemDownload.ts#L9) - -*** - -### has\_separator - -> **has\_separator**: `boolean` - -#### Defined in - -[src/parser/classes/menus/MenuServiceItemDownload.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuServiceItemDownload.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MenuServiceItemDownload'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/menus/MenuServiceItemDownload.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MenuServiceItemDownload.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MenuServiceItemDownload & { [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 MenuServiceItemDownload & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MerchandiseItem.md b/docs/api/namespaces/YTNodes/classes/MerchandiseItem.md deleted file mode 100644 index 6fce39b8..00000000 --- a/docs/api/namespaces/YTNodes/classes/MerchandiseItem.md +++ /dev/null @@ -1,311 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MerchandiseItem - -# Class: MerchandiseItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MerchandiseItem() - -> **new MerchandiseItem**(`data`): [`MerchandiseItem`](MerchandiseItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MerchandiseItem`](MerchandiseItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L21) - -## Properties - -### additional\_fees\_text - -> **additional\_fees\_text**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L17) - -*** - -### button\_accessibility\_text - -> **button\_accessibility\_text**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L15) - -*** - -### button\_text - -> **button\_text**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L14) - -*** - -### description - -> **description**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L10) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L19) - -*** - -### from\_vendor\_text - -> **from\_vendor\_text**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L16) - -*** - -### price - -> **price**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L12) - -*** - -### region\_format - -> **region\_format**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L18) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L11) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### vendor\_name - -> **vendor\_name**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L13) - -*** - -### type - -> `static` **type**: `string` = `'MerchandiseItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MerchandiseItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MerchandiseItem & { [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 MerchandiseItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md b/docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md deleted file mode 100644 index 64e1a231..00000000 --- a/docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MerchandiseShelf - -# Class: MerchandiseShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MerchandiseShelf() - -> **new MerchandiseShelf**(`data`): [`MerchandiseShelf`](MerchandiseShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MerchandiseShelf`](MerchandiseShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MerchandiseShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseShelf.ts#L11) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/MerchandiseShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseShelf.ts#L9) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/MerchandiseShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseShelf.ts#L8) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/MerchandiseShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseShelf.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MerchandiseShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MerchandiseShelf.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseShelf.ts#L5) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/MerchandiseShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MerchandiseShelf.ts#L19) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MerchandiseShelf & { [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 MerchandiseShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MetadataBadge.md b/docs/api/namespaces/YTNodes/classes/MetadataBadge.md deleted file mode 100644 index ba919aee..00000000 --- a/docs/api/namespaces/YTNodes/classes/MetadataBadge.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MetadataBadge - -# Class: MetadataBadge - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`LiveChatAuthorBadge`](LiveChatAuthorBadge.md) - -## Constructors - -### new MetadataBadge() - -> **new MetadataBadge**(`data`): [`MetadataBadge`](MetadataBadge.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MetadataBadge`](MetadataBadge.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L12) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L7) - -*** - -### label? - -> `optional` **label**: `string` - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L9) - -*** - -### style? - -> `optional` **style**: `string` - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L8) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MetadataBadge'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MetadataBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataBadge.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MetadataBadge & { [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 MetadataBadge & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md b/docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md deleted file mode 100644 index d8575cd0..00000000 --- a/docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MetadataRowHeader - -# Class: MetadataRowHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MetadataRowHeader() - -> **new MetadataRowHeader**(`data`): [`MetadataRowHeader`](MetadataRowHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MetadataRowHeader`](MetadataRowHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MetadataRowHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataRowHeader.ts#L11) - -## Properties - -### content - -> **content**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MetadataRowHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataRowHeader.ts#L8) - -*** - -### has\_divider\_line - -> **has\_divider\_line**: `boolean` - -#### Defined in - -[src/parser/classes/MetadataRowHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataRowHeader.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MetadataRowHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MetadataRowHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MetadataRowHeader.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MetadataRowHeader & { [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 MetadataRowHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MicroformatData.md b/docs/api/namespaces/YTNodes/classes/MicroformatData.md deleted file mode 100644 index d1ba2c6e..00000000 --- a/docs/api/namespaces/YTNodes/classes/MicroformatData.md +++ /dev/null @@ -1,431 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MicroformatData - -# Class: MicroformatData - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MicroformatData() - -> **new MicroformatData**(`data`): [`MicroformatData`](MicroformatData.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MicroformatData`](MicroformatData.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MicroformatData.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L32) - -## Properties - -### android\_package - -> **android\_package**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L14) - -*** - -### app\_name - -> **app\_name**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L13) - -*** - -### available\_countries - -> **available\_countries**: `string`[] - -#### Defined in - -[src/parser/classes/MicroformatData.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L30) - -*** - -### description - -> **description**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L10) - -*** - -### ios\_app\_arguments - -> **ios\_app\_arguments**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L16) - -*** - -### ios\_app\_store\_id - -> **ios\_app\_store\_id**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L15) - -*** - -### is\_family\_safe - -> **is\_family\_safe**: `boolean` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L28) - -*** - -### is\_unlisted - -> **is\_unlisted**: `boolean` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L27) - -*** - -### noindex - -> **noindex**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L26) - -*** - -### og\_type - -> **og\_type**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L17) - -*** - -### schema\_dot\_org\_type - -> **schema\_dot\_org\_type**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L25) - -*** - -### site\_name - -> **site\_name**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L12) - -*** - -### tags - -> **tags**: `string`[] - -#### Defined in - -[src/parser/classes/MicroformatData.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L29) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MicroformatData.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L11) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L9) - -*** - -### twitter\_card\_type - -> **twitter\_card\_type**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L23) - -*** - -### twitter\_site\_handle - -> **twitter\_site\_handle**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L24) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### url\_applinks\_android - -> **url\_applinks\_android**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L20) - -*** - -### url\_applinks\_ios - -> **url\_applinks\_ios**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L19) - -*** - -### url\_applinks\_web - -> **url\_applinks\_web**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L18) - -*** - -### url\_canonical - -> **url\_canonical**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L8) - -*** - -### url\_twitter\_android - -> **url\_twitter\_android**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L22) - -*** - -### url\_twitter\_ios - -> **url\_twitter\_ios**: `string` - -#### Defined in - -[src/parser/classes/MicroformatData.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L21) - -*** - -### type - -> `static` **type**: `string` = `'MicroformatData'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MicroformatData.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MicroformatData.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MicroformatData & { [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 MicroformatData & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MobileTopbar.md b/docs/api/namespaces/YTNodes/classes/MobileTopbar.md deleted file mode 100644 index 5ae5d3a0..00000000 --- a/docs/api/namespaces/YTNodes/classes/MobileTopbar.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MobileTopbar - -# Class: MobileTopbar - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MobileTopbar() - -> **new MobileTopbar**(`data`): [`MobileTopbar`](MobileTopbar.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MobileTopbar`](MobileTopbar.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/mweb/MobileTopbar.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/MobileTopbar.ts#L13) - -## Properties - -### buttons - -> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/mweb/MobileTopbar.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/MobileTopbar.ts#L10) - -*** - -### logo\_type? - -> `optional` **logo\_type**: `string` - -#### Defined in - -[src/parser/classes/mweb/MobileTopbar.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/MobileTopbar.ts#L11) - -*** - -### placeholder\_text - -> **placeholder\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/mweb/MobileTopbar.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/MobileTopbar.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MobileTopbar'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/mweb/MobileTopbar.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/MobileTopbar.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MobileTopbar & { [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 MobileTopbar & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md b/docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md deleted file mode 100644 index 912f9b6e..00000000 --- a/docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ModalWithTitleAndButton - -# Class: ModalWithTitleAndButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ModalWithTitleAndButton() - -> **new ModalWithTitleAndButton**(`data`): [`ModalWithTitleAndButton`](ModalWithTitleAndButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ModalWithTitleAndButton`](ModalWithTitleAndButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ModalWithTitleAndButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ModalWithTitleAndButton.ts#L13) - -## Properties - -### button - -> **button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ModalWithTitleAndButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ModalWithTitleAndButton.ts#L11) - -*** - -### content - -> **content**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ModalWithTitleAndButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ModalWithTitleAndButton.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ModalWithTitleAndButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ModalWithTitleAndButton.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ModalWithTitleAndButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ModalWithTitleAndButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ModalWithTitleAndButton.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ModalWithTitleAndButton & { [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 ModalWithTitleAndButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md b/docs/api/namespaces/YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md deleted file mode 100644 index ae41df30..00000000 --- a/docs/api/namespaces/YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ModifyChannelNotificationPreferenceEndpoint - -# Class: ModifyChannelNotificationPreferenceEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`ModifyChannelNotificationPreferenceRequest`](../../APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md)\> - -## Constructors - -### new ModifyChannelNotificationPreferenceEndpoint() - -> **new ModifyChannelNotificationPreferenceEndpoint**(`data`): [`ModifyChannelNotificationPreferenceEndpoint`](ModifyChannelNotificationPreferenceEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ModifyChannelNotificationPreferenceEndpoint`](ModifyChannelNotificationPreferenceEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ModifyChannelNotificationPreferenceEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`ModifyChannelNotificationPreferenceRequest`](../../APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md) - -#### Returns - -[`ModifyChannelNotificationPreferenceRequest`](../../APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ModifyChannelNotificationPreferenceEndpoint & { [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 ModifyChannelNotificationPreferenceEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Movie.md b/docs/api/namespaces/YTNodes/classes/Movie.md deleted file mode 100644 index f9a95f12..00000000 --- a/docs/api/namespaces/YTNodes/classes/Movie.md +++ /dev/null @@ -1,339 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Movie - -# Class: Movie - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Movie() - -> **new Movie**(`data`): [`Movie`](Movie.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Movie`](Movie.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Movie.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L32) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/Movie.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L19) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Movie.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L27) - -*** - -### description\_snippet? - -> `optional` **description\_snippet**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Movie.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L15) - -*** - -### duration - -> **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/Movie.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L21) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Movie.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L26) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/Movie.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L13) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/Movie.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L30) - -*** - -### show\_action\_menu - -> **show\_action\_menu**: `boolean` - -#### Defined in - -[src/parser/classes/Movie.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L29) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Movie.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L18) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/Movie.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L17) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Movie.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L14) - -*** - -### top\_metadata\_items - -> **top\_metadata\_items**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Movie.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### use\_vertical\_poster - -> **use\_vertical\_poster**: `boolean` - -#### Defined in - -[src/parser/classes/Movie.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L28) - -*** - -### type - -> `static` **type**: `string` = `'Movie'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Movie.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Movie.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Movie & { [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 Movie & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MultiPageMenu.md b/docs/api/namespaces/YTNodes/classes/MultiPageMenu.md deleted file mode 100644 index 466ba334..00000000 --- a/docs/api/namespaces/YTNodes/classes/MultiPageMenu.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MultiPageMenu - -# Class: MultiPageMenu - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MultiPageMenu() - -> **new MultiPageMenu**(`data`): [`MultiPageMenu`](MultiPageMenu.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MultiPageMenu`](MultiPageMenu.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/menus/MultiPageMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenu.ts#L13) - -## Properties - -### header - -> **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/menus/MultiPageMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenu.ts#L9) - -*** - -### sections - -> **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/menus/MultiPageMenu.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenu.ts#L10) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/menus/MultiPageMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenu.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MultiPageMenu'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/menus/MultiPageMenu.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenu.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MultiPageMenu & { [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 MultiPageMenu & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md b/docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md deleted file mode 100644 index 17352d0a..00000000 --- a/docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md +++ /dev/null @@ -1,235 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MultiPageMenuNotificationSection - -# Class: MultiPageMenuNotificationSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MultiPageMenuNotificationSection() - -> **new MultiPageMenuNotificationSection**(`data`): [`MultiPageMenuNotificationSection`](MultiPageMenuNotificationSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MultiPageMenuNotificationSection`](MultiPageMenuNotificationSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L14) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ContinuationItem`](ContinuationItem.md) \| [`Message`](Message.md) \| [`Notification`](Notification.md)\> - -#### Defined in - -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L12) - -*** - -### notification\_section\_title? - -> `optional` **notification\_section\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MultiPageMenuNotificationSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L9) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ContinuationItem`](ContinuationItem.md) \| [`Message`](Message.md) \| [`Notification`](Notification.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ContinuationItem`](ContinuationItem.md) \| [`Message`](Message.md) \| [`Notification`](Notification.md)\> - -#### Defined in - -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L25) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MultiPageMenuNotificationSection & { [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 MultiPageMenuNotificationSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md b/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md deleted file mode 100644 index 99dc6aba..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md +++ /dev/null @@ -1,311 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicCardShelf - -# Class: MusicCardShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicCardShelf() - -> **new MusicCardShelf**(`data`): [`MusicCardShelf`](MusicCardShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicCardShelf`](MusicCardShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L27) - -## Properties - -### buttons - -> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md)\> - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L18) - -*** - -### contents? - -> `optional` **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L25) - -*** - -### end\_icon\_type? - -> `optional` **end\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L22) - -*** - -### header - -> **header**: `null` \| [`MusicCardShelfHeaderBasic`](MusicCardShelfHeaderBasic.md) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L21) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L19) - -*** - -### on\_tap - -> **on\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L20) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L17) - -*** - -### subtitle\_badges - -> **subtitle\_badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicInlineBadge`](MusicInlineBadge.md)\> - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L23) - -*** - -### thumbnail - -> **thumbnail**: `null` \| [`MusicThumbnail`](MusicThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L15) - -*** - -### thumbnail\_overlay - -> **thumbnail\_overlay**: `null` \| [`MusicItemThumbnailOverlay`](MusicItemThumbnailOverlay.md) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L24) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicCardShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicCardShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCardShelf.ts#L13) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicCardShelf & { [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 MusicCardShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md b/docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md deleted file mode 100644 index c1edec38..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicCarouselShelf - -# Class: MusicCarouselShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicCarouselShelf() - -> **new MusicCarouselShelf**(`data`): [`MusicCarouselShelf`](MusicCarouselShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicCarouselShelf`](MusicCarouselShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicCarouselShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelf.ts#L17) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicMultiRowListItem`](MusicMultiRowListItem.md) \| [`MusicNavigationButton`](MusicNavigationButton.md) \| [`MusicResponsiveListItem`](MusicResponsiveListItem.md) \| [`MusicTwoRowItem`](MusicTwoRowItem.md)\> - -#### Defined in - -[src/parser/classes/MusicCarouselShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelf.ts#L14) - -*** - -### header - -> **header**: `null` \| [`MusicCarouselShelfBasicHeader`](MusicCarouselShelfBasicHeader.md) - -#### Defined in - -[src/parser/classes/MusicCarouselShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelf.ts#L13) - -*** - -### num\_items\_per\_column? - -> `optional` **num\_items\_per\_column**: `number` - -#### Defined in - -[src/parser/classes/MusicCarouselShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelf.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicCarouselShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicCarouselShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelf.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicCarouselShelf & { [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 MusicCarouselShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md b/docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md deleted file mode 100644 index 9903def4..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicCarouselShelfBasicHeader - -# Class: MusicCarouselShelfBasicHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicCarouselShelfBasicHeader() - -> **new MusicCarouselShelfBasicHeader**(`data`): [`MusicCarouselShelfBasicHeader`](MusicCarouselShelfBasicHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicCarouselShelfBasicHeader`](MusicCarouselShelfBasicHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L17) - -## Properties - -### end\_icons? - -> `optional` **end\_icons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`IconLink`](IconLink.md)\> - -#### Defined in - -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L15) - -*** - -### more\_content? - -> `optional` **more\_content**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L14) - -*** - -### strapline? - -> `optional` **strapline**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L12) - -*** - -### thumbnail? - -> `optional` **thumbnail**: `null` \| [`MusicThumbnail`](MusicThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicCarouselShelfBasicHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicCarouselShelfBasicHeader & { [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 MusicCarouselShelfBasicHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md b/docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md deleted file mode 100644 index c86f289b..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicDescriptionShelf - -# Class: MusicDescriptionShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicDescriptionShelf() - -> **new MusicDescriptionShelf**(`data`): [`MusicDescriptionShelf`](MusicDescriptionShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicDescriptionShelf`](MusicDescriptionShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicDescriptionShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDescriptionShelf.ts#L13) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicDescriptionShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDescriptionShelf.ts#L8) - -*** - -### footer - -> **footer**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicDescriptionShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDescriptionShelf.ts#L11) - -*** - -### max\_collapsed\_lines? - -> `optional` **max\_collapsed\_lines**: `string` - -#### Defined in - -[src/parser/classes/MusicDescriptionShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDescriptionShelf.ts#L9) - -*** - -### max\_expanded\_lines? - -> `optional` **max\_expanded\_lines**: `string` - -#### Defined in - -[src/parser/classes/MusicDescriptionShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDescriptionShelf.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicDescriptionShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicDescriptionShelf.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDescriptionShelf.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicDescriptionShelf & { [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 MusicDescriptionShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md b/docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md deleted file mode 100644 index 07ae72cc..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md +++ /dev/null @@ -1,323 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicDetailHeader - -# Class: MusicDetailHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicDetailHeader() - -> **new MusicDetailHeader**(`data`): [`MusicDetailHeader`](MusicDetailHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicDetailHeader`](MusicDetailHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L27) - -## Properties - -### author? - -> `optional` **author**: `object` - -#### channel\_id - -> **channel\_id**: `undefined` \| `string` - -#### endpoint - -> **endpoint**: `undefined` \| [`NavigationEndpoint`](NavigationEndpoint.md) - -#### name - -> **name**: `string` - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L20) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L19) - -*** - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L12) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L25) - -*** - -### second\_subtitle - -> **second\_subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L14) - -*** - -### song\_count - -> **song\_count**: `string` - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L16) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L13) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L18) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L11) - -*** - -### total\_duration - -> **total\_duration**: `string` - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### year - -> **year**: `string` - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'MusicDetailHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDetailHeader.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicDetailHeader & { [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 MusicDetailHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md b/docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md deleted file mode 100644 index 50473a37..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicDownloadStateBadge - -# Class: MusicDownloadStateBadge - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicDownloadStateBadge() - -> **new MusicDownloadStateBadge**(`data`): [`MusicDownloadStateBadge`](MusicDownloadStateBadge.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicDownloadStateBadge`](MusicDownloadStateBadge.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicDownloadStateBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDownloadStateBadge.ts#L10) - -## Properties - -### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/parser/classes/MusicDownloadStateBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDownloadStateBadge.ts#L7) - -*** - -### supported\_download\_states - -> **supported\_download\_states**: `string`[] - -#### Defined in - -[src/parser/classes/MusicDownloadStateBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDownloadStateBadge.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicDownloadStateBadge'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicDownloadStateBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicDownloadStateBadge.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicDownloadStateBadge & { [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 MusicDownloadStateBadge & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md b/docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md deleted file mode 100644 index dca5d397..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicEditablePlaylistDetailHeader - -# Class: MusicEditablePlaylistDetailHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicEditablePlaylistDetailHeader() - -> **new MusicEditablePlaylistDetailHeader**(`data`): [`MusicEditablePlaylistDetailHeader`](MusicEditablePlaylistDetailHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicEditablePlaylistDetailHeader`](MusicEditablePlaylistDetailHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L11) - -## Properties - -### edit\_header - -> **edit\_header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L8) - -*** - -### header - -> **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L7) - -*** - -### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicEditablePlaylistDetailHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicEditablePlaylistDetailHeader & { [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 MusicEditablePlaylistDetailHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicElementHeader.md b/docs/api/namespaces/YTNodes/classes/MusicElementHeader.md deleted file mode 100644 index 8829886f..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicElementHeader.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicElementHeader - -# Class: MusicElementHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicElementHeader() - -> **new MusicElementHeader**(`data`): [`MusicElementHeader`](MusicElementHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicElementHeader`](MusicElementHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicElementHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicElementHeader.ts#L10) - -## Properties - -### element - -> **element**: `null` \| [`Element`](Element.md) - -#### Defined in - -[src/parser/classes/MusicElementHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicElementHeader.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicElementHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicElementHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicElementHeader.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicElementHeader & { [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 MusicElementHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md b/docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md deleted file mode 100644 index 3204b2d9..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicImmersiveHeader - -# Class: MusicImmersiveHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicImmersiveHeader() - -> **new MusicImmersiveHeader**(`data`): [`MusicImmersiveHeader`](MusicImmersiveHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicImmersiveHeader`](MusicImmersiveHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L26) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L23) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L17) - -*** - -### more\_button - -> **more\_button**: `null` \| [`ToggleButton`](ToggleButton.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L18) - -*** - -### play\_button - -> **play\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L19) - -*** - -### share\_endpoint? - -> `optional` **share\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L20) - -*** - -### start\_radio\_button - -> **start\_radio\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L21) - -*** - -### subscription\_button - -> **subscription\_button**: `null` \| [`SubscribeButton`](SubscribeButton.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L22) - -*** - -### thumbnail - -> **thumbnail**: `null` \| [`MusicThumbnail`](MusicThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L24) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicImmersiveHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicImmersiveHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicImmersiveHeader.ts#L14) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicImmersiveHeader & { [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 MusicImmersiveHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md b/docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md deleted file mode 100644 index 642f841f..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md +++ /dev/null @@ -1,235 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicInlineBadge - -# Class: MusicInlineBadge - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicInlineBadge() - -> **new MusicInlineBadge**(`data`): [`MusicInlineBadge`](MusicInlineBadge.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicInlineBadge`](MusicInlineBadge.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicInlineBadge.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicInlineBadge.ts#L11) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/MusicInlineBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicInlineBadge.ts#L9) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/MusicInlineBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicInlineBadge.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicInlineBadge'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicInlineBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicInlineBadge.ts#L6) - -## Accessors - -### label - -> `get` **label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/MusicInlineBadge.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicInlineBadge.ts#L23) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicInlineBadge & { [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 MusicInlineBadge & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md b/docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md deleted file mode 100644 index d282cbc8..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicItemThumbnailOverlay - -# Class: MusicItemThumbnailOverlay - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicItemThumbnailOverlay() - -> **new MusicItemThumbnailOverlay**(`data`): [`MusicItemThumbnailOverlay`](MusicItemThumbnailOverlay.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicItemThumbnailOverlay`](MusicItemThumbnailOverlay.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicItemThumbnailOverlay.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicItemThumbnailOverlay.ts#L12) - -## Properties - -### content - -> **content**: `null` \| [`MusicPlayButton`](MusicPlayButton.md) - -#### Defined in - -[src/parser/classes/MusicItemThumbnailOverlay.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicItemThumbnailOverlay.ts#L8) - -*** - -### content\_position - -> **content\_position**: `string` - -#### Defined in - -[src/parser/classes/MusicItemThumbnailOverlay.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicItemThumbnailOverlay.ts#L9) - -*** - -### display\_style - -> **display\_style**: `string` - -#### Defined in - -[src/parser/classes/MusicItemThumbnailOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicItemThumbnailOverlay.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicItemThumbnailOverlay'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicItemThumbnailOverlay.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicItemThumbnailOverlay.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicItemThumbnailOverlay & { [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 MusicItemThumbnailOverlay & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md b/docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md deleted file mode 100644 index c93437bb..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicLargeCardItemCarousel - -# Class: MusicLargeCardItemCarousel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicLargeCardItemCarousel() - -> **new MusicLargeCardItemCarousel**(`data`): [`MusicLargeCardItemCarousel`](MusicLargeCardItemCarousel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicLargeCardItemCarousel`](MusicLargeCardItemCarousel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicLargeCardItemCarousel.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicLargeCardItemCarousel.ts#L49) - -## Properties - -### header - -> **header**: `any` - -#### Defined in - -[src/parser/classes/MusicLargeCardItemCarousel.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicLargeCardItemCarousel.ts#L47) - -*** - -### panels - -> **panels**: `Panel`[] - -#### Defined in - -[src/parser/classes/MusicLargeCardItemCarousel.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicLargeCardItemCarousel.ts#L46) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicLargeCardItemCarousel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicLargeCardItemCarousel.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicLargeCardItemCarousel.ts#L44) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicLargeCardItemCarousel & { [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 MusicLargeCardItemCarousel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md b/docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md deleted file mode 100644 index 32b90423..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicMultiRowListItem - -# Class: MusicMultiRowListItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicMultiRowListItem() - -> **new MusicMultiRowListItem**(`data`): [`MusicMultiRowListItem`](MusicMultiRowListItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicMultiRowListItem`](MusicMultiRowListItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L23) - -## Properties - -### description? - -> `optional` **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L20) - -*** - -### display\_style? - -> `optional` **display\_style**: `string` - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L21) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L16) - -*** - -### on\_tap - -> **on\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L15) - -*** - -### overlay - -> **overlay**: `null` \| [`MusicItemThumbnailOverlay`](MusicItemThumbnailOverlay.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L14) - -*** - -### second\_title? - -> `optional` **second\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L19) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L17) - -*** - -### thumbnail - -> **thumbnail**: `null` \| [`MusicThumbnail`](MusicThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicMultiRowListItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicMultiRowListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicMultiRowListItem.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicMultiRowListItem & { [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 MusicMultiRowListItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md b/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md deleted file mode 100644 index 9212712d..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicMultiSelectMenuItem - -# Class: MusicMultiSelectMenuItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicMultiSelectMenuItem() - -> **new MusicMultiSelectMenuItem**(`data`): [`MusicMultiSelectMenuItem`](MusicMultiSelectMenuItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicMultiSelectMenuItem`](MusicMultiSelectMenuItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L15) - -## Properties - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L12) - -*** - -### form\_item\_entity\_key - -> **form\_item\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L10) - -*** - -### selected - -> **selected**: `boolean` - -#### Defined in - -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L13) - -*** - -### selected\_icon\_type? - -> `optional` **selected\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L11) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicMultiSelectMenuItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicMultiSelectMenuItem & { [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 MusicMultiSelectMenuItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md b/docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md deleted file mode 100644 index 59219e49..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicNavigationButton - -# Class: MusicNavigationButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicNavigationButton() - -> **new MusicNavigationButton**(`data`): [`MusicNavigationButton`](MusicNavigationButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicNavigationButton`](MusicNavigationButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicNavigationButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicNavigationButton.ts#L12) - -## Properties - -### button\_text - -> **button\_text**: `string` - -#### Defined in - -[src/parser/classes/MusicNavigationButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicNavigationButton.ts#L9) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicNavigationButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicNavigationButton.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicNavigationButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicNavigationButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicNavigationButton.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicNavigationButton & { [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 MusicNavigationButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicPlayButton.md b/docs/api/namespaces/YTNodes/classes/MusicPlayButton.md deleted file mode 100644 index 90265d72..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicPlayButton.md +++ /dev/null @@ -1,289 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicPlayButton - -# Class: MusicPlayButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicPlayButton() - -> **new MusicPlayButton**(`data`): [`MusicPlayButton`](MusicPlayButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicPlayButton`](MusicPlayButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L16) - -## Properties - -### accessibility\_pause\_data? - -> `optional` **accessibility\_pause\_data**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L14) - -*** - -### accessibility\_play\_data? - -> `optional` **accessibility\_play\_data**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L13) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L9) - -*** - -### icon\_color - -> **icon\_color**: `string` - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L12) - -*** - -### pause\_icon\_type - -> **pause\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L11) - -*** - -### play\_icon\_type - -> **play\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicPlayButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L7) - -## Accessors - -### pause\_label - -> `get` **pause\_label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L43) - -*** - -### play\_label - -> `get` **play\_label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/MusicPlayButton.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlayButton.ts#L39) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicPlayButton & { [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 MusicPlayButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md b/docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md deleted file mode 100644 index 05a14a91..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicPlaylistEditHeader - -# Class: MusicPlaylistEditHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicPlaylistEditHeader() - -> **new MusicPlaylistEditHeader**(`data`): [`MusicPlaylistEditHeader`](MusicPlaylistEditHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicPlaylistEditHeader`](MusicPlaylistEditHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L18) - -## Properties - -### edit\_description - -> **edit\_description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L12) - -*** - -### edit\_title - -> **edit\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L15) - -*** - -### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L14) - -*** - -### privacy - -> **privacy**: `string` - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L13) - -*** - -### privacy\_dropdown - -> **privacy\_dropdown**: `null` \| [`Dropdown`](Dropdown.md) - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L16) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicPlaylistEditHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicPlaylistEditHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistEditHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicPlaylistEditHeader & { [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 MusicPlaylistEditHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md b/docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md deleted file mode 100644 index ab03e397..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicPlaylistShelf - -# Class: MusicPlaylistShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicPlaylistShelf() - -> **new MusicPlaylistShelf**(`data`): [`MusicPlaylistShelf`](MusicPlaylistShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicPlaylistShelf`](MusicPlaylistShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicPlaylistShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistShelf.ts#L14) - -## Properties - -### collapsed\_item\_count - -> **collapsed\_item\_count**: `number` - -#### Defined in - -[src/parser/classes/MusicPlaylistShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistShelf.ts#L11) - -*** - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ContinuationItem`](ContinuationItem.md) \| [`MusicResponsiveListItem`](MusicResponsiveListItem.md)\> - -#### Defined in - -[src/parser/classes/MusicPlaylistShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistShelf.ts#L10) - -*** - -### continuation - -> **continuation**: `null` \| `string` - -#### Defined in - -[src/parser/classes/MusicPlaylistShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistShelf.ts#L12) - -*** - -### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/parser/classes/MusicPlaylistShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistShelf.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicPlaylistShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicPlaylistShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicPlaylistShelf.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicPlaylistShelf & { [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 MusicPlaylistShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md deleted file mode 100644 index 9469692b..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicResponsiveHeader - -# Class: MusicResponsiveHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicResponsiveHeader() - -> **new MusicResponsiveHeader**(`data`): [`MusicResponsiveHeader`](MusicResponsiveHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicResponsiveHeader`](MusicResponsiveHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L28) - -## Properties - -### buttons - -> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`ToggleButton`](ToggleButton.md) \| [`DownloadButton`](DownloadButton.md) \| [`Menu`](Menu.md) \| [`MusicPlayButton`](MusicPlayButton.md)\> - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L19) - -*** - -### description? - -> `optional` **description**: `null` \| [`MusicDescriptionShelf`](MusicDescriptionShelf.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L26) - -*** - -### second\_subtitle - -> **second\_subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L24) - -*** - -### strapline\_text\_one - -> **strapline\_text\_one**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L22) - -*** - -### strapline\_thumbnail - -> **strapline\_thumbnail**: `null` \| [`MusicThumbnail`](MusicThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L23) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L21) - -*** - -### subtitle\_badge? - -> `optional` **subtitle\_badge**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicInlineBadge`](MusicInlineBadge.md)\> - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L25) - -*** - -### thumbnail - -> **thumbnail**: `null` \| [`MusicThumbnail`](MusicThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L18) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L20) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicResponsiveHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicResponsiveHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveHeader.ts#L16) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicResponsiveHeader & { [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 MusicResponsiveHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md deleted file mode 100644 index 8b2f2270..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md +++ /dev/null @@ -1,477 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicResponsiveListItem - -# Class: MusicResponsiveListItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicResponsiveListItem() - -> **new MusicResponsiveListItem**(`data`): [`MusicResponsiveListItem`](MusicResponsiveListItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicResponsiveListItem`](MusicResponsiveListItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:77](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L77) - -## Properties - -### album? - -> `optional` **album**: `object` - -#### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### id? - -> `optional` **id**: `string` - -#### name - -> **name**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L44) - -*** - -### artists? - -> `optional` **artists**: `object`[] - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:50](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L50) - -*** - -### author? - -> `optional` **author**: `object` - -#### channel\_id? - -> `optional` **channel\_id**: `string` - -#### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### name - -> **name**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:69](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L69) - -*** - -### authors? - -> `optional` **authors**: `object`[] - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:57](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L57) - -*** - -### badges? - -> `optional` **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L33) - -*** - -### duration? - -> `optional` **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L39) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L29) - -*** - -### fixed\_columns - -> **fixed\_columns**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItemFixedColumn`](MusicResponsiveListItemFixedColumn.md)\> - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L27) - -*** - -### flex\_columns - -> **flex\_columns**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItemFlexColumn`](MusicResponsiveListItemFlexColumn.md)\> - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L26) - -*** - -### id? - -> `optional` **id**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L37) - -*** - -### index? - -> `optional` **index**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L31) - -*** - -### item\_count? - -> `optional` **item\_count**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:74](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L74) - -*** - -### item\_type - -> **item\_type**: `undefined` \| `"endpoint"` \| `"unknown"` \| `"video"` \| `"playlist"` \| `"album"` \| `"artist"` \| `"library_artist"` \| `"non_music_track"` \| `"song"` \| `"podcast_show"` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L30) - -*** - -### menu? - -> `optional` **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L34) - -*** - -### name? - -> `optional` **name**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:63](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L63) - -*** - -### overlay? - -> `optional` **overlay**: `null` \| [`MusicItemThumbnailOverlay`](MusicItemThumbnailOverlay.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L35) - -*** - -### song\_count? - -> `optional` **song\_count**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:66](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L66) - -*** - -### subscribers? - -> `optional` **subscribers**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:65](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L65) - -*** - -### subtitle? - -> `optional` **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:64](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L64) - -*** - -### thumbnail? - -> `optional` **thumbnail**: `null` \| [`MusicThumbnail`](MusicThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L32) - -*** - -### title? - -> `optional` **title**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L38) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### views? - -> `optional` **views**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:56](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L56) - -*** - -### year? - -> `optional` **year**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:75](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L75) - -*** - -### type - -> `static` **type**: `string` = `'MusicResponsiveListItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L24) - -## Accessors - -### thumbnails - -> `get` **thumbnails**(): [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Returns - -[`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MusicResponsiveListItem.ts:334](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItem.ts#L334) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicResponsiveListItem & { [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 MusicResponsiveListItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md deleted file mode 100644 index 852688f2..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicResponsiveListItemFixedColumn - -# Class: MusicResponsiveListItemFixedColumn - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicResponsiveListItemFixedColumn() - -> **new MusicResponsiveListItemFixedColumn**(`data`): [`MusicResponsiveListItemFixedColumn`](MusicResponsiveListItemFixedColumn.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicResponsiveListItemFixedColumn`](MusicResponsiveListItemFixedColumn.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L11) - -## Properties - -### display\_priority - -> **display\_priority**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L9) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'musicResponsiveListItemFlexColumnRenderer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicResponsiveListItemFixedColumn & { [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 MusicResponsiveListItemFixedColumn & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md deleted file mode 100644 index 43522e3a..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicResponsiveListItemFlexColumn - -# Class: MusicResponsiveListItemFlexColumn - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicResponsiveListItemFlexColumn() - -> **new MusicResponsiveListItemFlexColumn**(`data`): [`MusicResponsiveListItemFlexColumn`](MusicResponsiveListItemFlexColumn.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicResponsiveListItemFlexColumn`](MusicResponsiveListItemFlexColumn.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L11) - -## Properties - -### display\_priority - -> **display\_priority**: `string` - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L9) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicResponsiveListItemFlexColumn'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicResponsiveListItemFlexColumn & { [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 MusicResponsiveListItemFlexColumn & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicShelf.md b/docs/api/namespaces/YTNodes/classes/MusicShelf.md deleted file mode 100644 index 74456a65..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicShelf.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicShelf - -# Class: MusicShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicShelf() - -> **new MusicShelf**(`data`): [`MusicShelf`](MusicShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicShelf`](MusicShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L19) - -## Properties - -### bottom\_button? - -> `optional` **bottom\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/MusicShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L16) - -*** - -### bottom\_text? - -> `optional` **bottom\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L15) - -*** - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItem`](MusicResponsiveListItem.md)\> - -#### Defined in - -[src/parser/classes/MusicShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L12) - -*** - -### continuation? - -> `optional` **continuation**: `string` - -#### Defined in - -[src/parser/classes/MusicShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L14) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L13) - -*** - -### subheaders? - -> `optional` **subheaders**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/MusicShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L17) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicShelf.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicShelf & { [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 MusicShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md b/docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md deleted file mode 100644 index fdf7efc0..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicSortFilterButton - -# Class: MusicSortFilterButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicSortFilterButton() - -> **new MusicSortFilterButton**(`data`): [`MusicSortFilterButton`](MusicSortFilterButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicSortFilterButton`](MusicSortFilterButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicSortFilterButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicSortFilterButton.ts#L13) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/MusicSortFilterButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicSortFilterButton.ts#L10) - -*** - -### menu - -> **menu**: `null` \| [`MusicMultiSelectMenu`](MusicMultiSelectMenu.md) - -#### Defined in - -[src/parser/classes/MusicSortFilterButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicSortFilterButton.ts#L11) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/MusicSortFilterButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicSortFilterButton.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicSortFilterButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicSortFilterButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicSortFilterButton.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicSortFilterButton & { [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 MusicSortFilterButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md b/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md deleted file mode 100644 index d5137f0e..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicTastebuilderShelf - -# Class: MusicTastebuilderShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicTastebuilderShelf() - -> **new MusicTastebuilderShelf**(`data`): [`MusicTastebuilderShelf`](MusicTastebuilderShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicTastebuilderShelf`](MusicTastebuilderShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicTastebuilderShelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTastebuilderShelf.ts#L18) - -## Properties - -### action\_button - -> **action\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/MusicTastebuilderShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTastebuilderShelf.ts#L15) - -*** - -### is\_visible - -> **is\_visible**: `boolean` - -#### Defined in - -[src/parser/classes/MusicTastebuilderShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTastebuilderShelf.ts#L16) - -*** - -### primary\_text - -> **primary\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicTastebuilderShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTastebuilderShelf.ts#L13) - -*** - -### secondary\_text - -> **secondary\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicTastebuilderShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTastebuilderShelf.ts#L14) - -*** - -### thumbnail - -> **thumbnail**: `null` \| [`MusicTastebuilderShelfThumbnail`](MusicTastebuilderShelfThumbnail.md) - -#### Defined in - -[src/parser/classes/MusicTastebuilderShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTastebuilderShelf.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicTasteBuilderShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicTastebuilderShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTastebuilderShelf.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicTastebuilderShelf & { [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 MusicTastebuilderShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md b/docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md deleted file mode 100644 index a1b499bd..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md +++ /dev/null @@ -1,363 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicTwoRowItem - -# Class: MusicTwoRowItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicTwoRowItem() - -> **new MusicTwoRowItem**(`data`): [`MusicTwoRowItem`](MusicTwoRowItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicTwoRowItem`](MusicTwoRowItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L42) - -## Properties - -### artists? - -> `optional` **artists**: `object`[] - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L26) - -*** - -### author? - -> `optional` **author**: `object` - -#### channel\_id - -> **channel\_id**: `undefined` \| `string` - -#### endpoint - -> **endpoint**: `undefined` \| [`NavigationEndpoint`](NavigationEndpoint.md) - -#### name - -> **name**: `string` - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L32) - -*** - -### badges - -> **badges**: `null` \| [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L19) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L16) - -*** - -### id - -> **id**: `undefined` \| `string` - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L17) - -*** - -### item\_count? - -> `optional` **item\_count**: `null` \| `string` - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L22) - -*** - -### item\_type - -> **item\_type**: `string` - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L20) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L40) - -*** - -### subscribers? - -> `optional` **subscribers**: `string` - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L21) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L18) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L38) - -*** - -### thumbnail\_overlay - -> **thumbnail\_overlay**: `null` \| [`MusicItemThumbnailOverlay`](MusicItemThumbnailOverlay.md) - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L39) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### views? - -> `optional` **views**: `string` - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L24) - -*** - -### year? - -> `optional` **year**: `string` - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L23) - -*** - -### type - -> `static` **type**: `string` = `'MusicTwoRowItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicTwoRowItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicTwoRowItem.ts#L13) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicTwoRowItem & { [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 MusicTwoRowItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md b/docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md deleted file mode 100644 index eaee26e6..00000000 --- a/docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MusicVisualHeader - -# Class: MusicVisualHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new MusicVisualHeader() - -> **new MusicVisualHeader**(`data`): [`MusicVisualHeader`](MusicVisualHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`MusicVisualHeader`](MusicVisualHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/MusicVisualHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicVisualHeader.ts#L15) - -## Properties - -### foreground\_thumbnail - -> **foreground\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MusicVisualHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicVisualHeader.ts#L13) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/MusicVisualHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicVisualHeader.ts#L12) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/MusicVisualHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicVisualHeader.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/MusicVisualHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicVisualHeader.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'MusicVisualHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/MusicVisualHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/MusicVisualHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is MusicVisualHeader & { [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 MusicVisualHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md b/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md deleted file mode 100644 index da459f4a..00000000 --- a/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md +++ /dev/null @@ -1,377 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / NavigationEndpoint - -# Class: NavigationEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new NavigationEndpoint() - -> **new NavigationEndpoint**(`data`): [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`NavigationEndpoint`](NavigationEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L32) - -## Properties - -### command? - -> `optional` **command**: [`YTNode`](../../Helpers/classes/YTNode.md) \| [`YTNode`](../../Helpers/classes/YTNode.md) & [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<`any`\> - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L29) - -*** - -### commands? - -> `optional` **commands**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L30) - -*** - -### dialog? - -> `optional` **dialog**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) \| [`CreatePlaylistDialog`](CreatePlaylistDialog.md) - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L24) - -*** - -### metadata - -> **metadata**: `Metadata` - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L28) - -*** - -### modal? - -> `optional` **modal**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) \| [`ModalWithTitleAndButton`](ModalWithTitleAndButton.md) - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L25) - -*** - -### name? - -> `optional` **name**: `string` - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L22) - -*** - -### next\_endpoint? - -> `optional` **next\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L27) - -*** - -### open\_popup? - -> `optional` **open\_popup**: `null` \| [`OpenPopupAction`](OpenPopupAction.md) - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L26) - -*** - -### payload - -> **payload**: `any` - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L23) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'NavigationEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L20) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### call() - -#### call(actions, args) - -> **call**\<`T`\>(`actions`, `args`): `Promise`\<`T`\> - -##### Type Parameters - -• **T** *extends* [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) - -##### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **args** - -• **args.parse**: `true` - -##### Returns - -`Promise`\<`T`\> - -##### Defined in - -[src/parser/classes/NavigationEndpoint.ts:121](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L121) - -#### call(actions, args) - -> **call**(`actions`, `args`?): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -##### Parameters - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **args?** - -• **args.parse?**: `false` - -##### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -##### Defined in - -[src/parser/classes/NavigationEndpoint.ts:122](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L122) - -*** - -### ~~getPath()~~ - -> **getPath**(`name`): `undefined` \| `"/browse"` \| `"/player"` \| `"/search"` \| `"/next"` \| `"/live_chat/get_item_context_menu"` - -Sometimes InnerTube does not return an API url, in that case the library should set it based on the name of the payload object. - -#### Parameters - -• **name**: `string` - -#### Returns - -`undefined` \| `"/browse"` \| `"/player"` \| `"/search"` \| `"/next"` \| `"/live_chat/get_item_context_menu"` - -#### Deprecated - -This should be removed in the future. - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:105](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L105) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is NavigationEndpoint & { [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 NavigationEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) - -*** - -### toURL() - -> **toURL**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/NavigationEndpoint.ts:143](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/NavigationEndpoint.ts#L143) diff --git a/docs/api/namespaces/YTNodes/classes/Notification.md b/docs/api/namespaces/YTNodes/classes/Notification.md deleted file mode 100644 index 2ac00dc3..00000000 --- a/docs/api/namespaces/YTNodes/classes/Notification.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Notification - -# Class: Notification - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Notification() - -> **new Notification**(`data`): [`Notification`](Notification.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Notification`](Notification.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Notification.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L20) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Notification.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L15) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Notification.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L17) - -*** - -### notification\_id - -> **notification\_id**: `string` - -#### Defined in - -[src/parser/classes/Notification.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L14) - -*** - -### read - -> **read**: `boolean` - -#### Defined in - -[src/parser/classes/Notification.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L18) - -*** - -### record\_click\_endpoint - -> **record\_click\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Notification.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L16) - -*** - -### sent\_time - -> **sent\_time**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Notification.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L13) - -*** - -### short\_message - -> **short\_message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Notification.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L12) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/Notification.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_thumbnails - -> **video\_thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/Notification.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L11) - -*** - -### type - -> `static` **type**: `string` = `'Notification'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Notification.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Notification.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Notification & { [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 Notification & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md b/docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md deleted file mode 100644 index c517a4c5..00000000 --- a/docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / OpenOnePickAddVideoModalCommand - -# Class: OpenOnePickAddVideoModalCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new OpenOnePickAddVideoModalCommand() - -> **new OpenOnePickAddVideoModalCommand**(`data`): [`OpenOnePickAddVideoModalCommand`](OpenOnePickAddVideoModalCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`OpenOnePickAddVideoModalCommand`](OpenOnePickAddVideoModalCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L11) - -## Properties - -### list\_id - -> **list\_id**: `string` - -#### Defined in - -[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L7) - -*** - -### modal\_title - -> **modal\_title**: `string` - -#### Defined in - -[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L8) - -*** - -### select\_button\_label - -> **select\_button\_label**: `string` - -#### Defined in - -[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'OpenOnePickAddVideoModalCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is OpenOnePickAddVideoModalCommand & { [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 OpenOnePickAddVideoModalCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/OpenPopupAction.md b/docs/api/namespaces/YTNodes/classes/OpenPopupAction.md deleted file mode 100644 index f1ec33ef..00000000 --- a/docs/api/namespaces/YTNodes/classes/OpenPopupAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / OpenPopupAction - -# Class: OpenPopupAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new OpenPopupAction() - -> **new OpenPopupAction**(`data`): [`OpenPopupAction`](OpenPopupAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`OpenPopupAction`](OpenPopupAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/actions/OpenPopupAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/OpenPopupAction.ts#L11) - -## Properties - -### popup - -> **popup**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/actions/OpenPopupAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/OpenPopupAction.ts#L8) - -*** - -### popup\_type - -> **popup\_type**: `string` - -#### Defined in - -[src/parser/classes/actions/OpenPopupAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/OpenPopupAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'OpenPopupAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/actions/OpenPopupAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/OpenPopupAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is OpenPopupAction & { [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 OpenPopupAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PageHeader.md b/docs/api/namespaces/YTNodes/classes/PageHeader.md deleted file mode 100644 index 5a096757..00000000 --- a/docs/api/namespaces/YTNodes/classes/PageHeader.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PageHeader - -# Class: PageHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PageHeader() - -> **new PageHeader**(`data`): [`PageHeader`](PageHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PageHeader`](PageHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PageHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeader.ts#L11) - -## Properties - -### content - -> **content**: `null` \| [`PageHeaderView`](PageHeaderView.md) - -#### Defined in - -[src/parser/classes/PageHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeader.ts#L9) - -*** - -### page\_title - -> **page\_title**: `string` - -#### Defined in - -[src/parser/classes/PageHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeader.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PageHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PageHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeader.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PageHeader & { [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 PageHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PageHeaderView.md b/docs/api/namespaces/YTNodes/classes/PageHeaderView.md deleted file mode 100644 index 862b56cb..00000000 --- a/docs/api/namespaces/YTNodes/classes/PageHeaderView.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PageHeaderView - -# Class: PageHeaderView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PageHeaderView() - -> **new PageHeaderView**(`data`): [`PageHeaderView`](PageHeaderView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PageHeaderView`](PageHeaderView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L25) - -## Properties - -### actions - -> **actions**: `null` \| [`FlexibleActionsView`](FlexibleActionsView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L20) - -*** - -### animated\_image - -> **animated\_image**: `null` \| [`ContentPreviewImageView`](ContentPreviewImageView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L17) - -*** - -### attributation - -> **attributation**: `null` \| [`AttributionView`](AttributionView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L22) - -*** - -### banner - -> **banner**: `null` \| [`ImageBannerView`](ImageBannerView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L23) - -*** - -### description - -> **description**: `null` \| [`DescriptionPreviewView`](DescriptionPreviewView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L21) - -*** - -### hero\_image - -> **hero\_image**: `null` \| [`ContentPreviewImageView`](ContentPreviewImageView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L18) - -*** - -### image - -> **image**: `null` \| [`DecoratedAvatarView`](DecoratedAvatarView.md) \| [`ContentPreviewImageView`](ContentPreviewImageView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L16) - -*** - -### metadata - -> **metadata**: `null` \| [`ContentMetadataView`](ContentMetadataView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L19) - -*** - -### title - -> **title**: `null` \| [`DynamicTextView`](DynamicTextView.md) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PageHeaderView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PageHeaderView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageHeaderView.ts#L13) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PageHeaderView & { [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 PageHeaderView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PageIntroduction.md b/docs/api/namespaces/YTNodes/classes/PageIntroduction.md deleted file mode 100644 index 2c300a85..00000000 --- a/docs/api/namespaces/YTNodes/classes/PageIntroduction.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PageIntroduction - -# Class: PageIntroduction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PageIntroduction() - -> **new PageIntroduction**(`data`): [`PageIntroduction`](PageIntroduction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PageIntroduction`](PageIntroduction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PageIntroduction.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageIntroduction.ts#L13) - -## Properties - -### body\_text - -> **body\_text**: `string` - -#### Defined in - -[src/parser/classes/PageIntroduction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageIntroduction.ts#L9) - -*** - -### header\_icon\_type - -> **header\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/PageIntroduction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageIntroduction.ts#L11) - -*** - -### header\_text - -> **header\_text**: `string` - -#### Defined in - -[src/parser/classes/PageIntroduction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageIntroduction.ts#L8) - -*** - -### page\_title - -> **page\_title**: `string` - -#### Defined in - -[src/parser/classes/PageIntroduction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageIntroduction.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PageIntroduction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PageIntroduction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PageIntroduction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PageIntroduction & { [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 PageIntroduction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PanelFooterView.md b/docs/api/namespaces/YTNodes/classes/PanelFooterView.md deleted file mode 100644 index 3170a116..00000000 --- a/docs/api/namespaces/YTNodes/classes/PanelFooterView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PanelFooterView - -# Class: PanelFooterView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PanelFooterView() - -> **new PanelFooterView**(`data`): [`PanelFooterView`](PanelFooterView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PanelFooterView`](PanelFooterView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PanelFooterView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PanelFooterView.ts#L12) - -## Properties - -### primary\_button - -> **primary\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/PanelFooterView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PanelFooterView.ts#L8) - -*** - -### secondary\_button - -> **secondary\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/PanelFooterView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PanelFooterView.ts#L9) - -*** - -### should\_hide\_divider - -> **should\_hide\_divider**: `boolean` - -#### Defined in - -[src/parser/classes/PanelFooterView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PanelFooterView.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PanelFooterView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PanelFooterView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PanelFooterView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PanelFooterView & { [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 PanelFooterView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PdgCommentChip.md b/docs/api/namespaces/YTNodes/classes/PdgCommentChip.md deleted file mode 100644 index 9a2f0fc4..00000000 --- a/docs/api/namespaces/YTNodes/classes/PdgCommentChip.md +++ /dev/null @@ -1,239 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PdgCommentChip - -# Class: PdgCommentChip - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PdgCommentChip() - -> **new PdgCommentChip**(`data`): [`PdgCommentChip`](PdgCommentChip.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PdgCommentChip`](PdgCommentChip.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/PdgCommentChip.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/PdgCommentChip.ts#L15) - -## Properties - -### color\_pallette - -> **color\_pallette**: `object` - -#### background\_color? - -> `optional` **background\_color**: `string` - -#### foreground\_title\_color? - -> `optional` **foreground\_title\_color**: `string` - -#### Defined in - -[src/parser/classes/comments/PdgCommentChip.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/PdgCommentChip.ts#L9) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/comments/PdgCommentChip.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/PdgCommentChip.ts#L13) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/PdgCommentChip.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/PdgCommentChip.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PdgCommentChip'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/PdgCommentChip.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/PdgCommentChip.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PdgCommentChip & { [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 PdgCommentChip & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PdgReplyButtonView.md b/docs/api/namespaces/YTNodes/classes/PdgReplyButtonView.md deleted file mode 100644 index 4bb4c18d..00000000 --- a/docs/api/namespaces/YTNodes/classes/PdgReplyButtonView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PdgReplyButtonView - -# Class: PdgReplyButtonView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PdgReplyButtonView() - -> **new PdgReplyButtonView**(`data`): [`PdgReplyButtonView`](PdgReplyButtonView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PdgReplyButtonView`](PdgReplyButtonView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/PdgReplyButtonView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PdgReplyButtonView.ts#L13) - -## Properties - -### reply\_button - -> **reply\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/livechat/items/PdgReplyButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PdgReplyButtonView.ts#L9) - -*** - -### reply\_count\_entity\_key - -> **reply\_count\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/PdgReplyButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PdgReplyButtonView.ts#L10) - -*** - -### reply\_count\_placeholder - -> **reply\_count\_placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/PdgReplyButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PdgReplyButtonView.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PdgReplyButtonView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/PdgReplyButtonView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PdgReplyButtonView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PdgReplyButtonView & { [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 PdgReplyButtonView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PerformCommentActionEndpoint.md b/docs/api/namespaces/YTNodes/classes/PerformCommentActionEndpoint.md deleted file mode 100644 index a77d870c..00000000 --- a/docs/api/namespaces/YTNodes/classes/PerformCommentActionEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PerformCommentActionEndpoint - -# Class: PerformCommentActionEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`PerformCommentActionRequest`](../../APIResponseTypes/type-aliases/PerformCommentActionRequest.md)\> - -## Constructors - -### new PerformCommentActionEndpoint() - -> **new PerformCommentActionEndpoint**(`data`): [`PerformCommentActionEndpoint`](PerformCommentActionEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PerformCommentActionEndpoint`](PerformCommentActionEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/PerformCommentActionEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PerformCommentActionEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PerformCommentActionEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/PerformCommentActionEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PerformCommentActionEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`PerformCommentActionRequest`](../../APIResponseTypes/type-aliases/PerformCommentActionRequest.md) - -#### Returns - -[`PerformCommentActionRequest`](../../APIResponseTypes/type-aliases/PerformCommentActionRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/PerformCommentActionEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PerformCommentActionEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/PerformCommentActionEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PerformCommentActionEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PerformCommentActionEndpoint & { [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 PerformCommentActionEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PivotBarItem.md b/docs/api/namespaces/YTNodes/classes/PivotBarItem.md deleted file mode 100644 index 1157acfe..00000000 --- a/docs/api/namespaces/YTNodes/classes/PivotBarItem.md +++ /dev/null @@ -1,275 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PivotBarItem - -# Class: PivotBarItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PivotBarItem() - -> **new PivotBarItem**(`data`): [`PivotBarItem`](PivotBarItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PivotBarItem`](PivotBarItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L16) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L14) - -*** - -### accessibility\_label? - -> `optional` **accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L10) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L13) - -*** - -### pivot\_identifier - -> **pivot\_identifier**: `string` - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L9) - -*** - -### title - -> **title**: `Text` - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PivotBarItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L7) - -## Accessors - -### label - -> `get` **label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/mweb/PivotBarItem.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/PivotBarItem.ts#L33) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PivotBarItem & { [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 PivotBarItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PivotButton.md b/docs/api/namespaces/YTNodes/classes/PivotButton.md deleted file mode 100644 index 63e3c510..00000000 --- a/docs/api/namespaces/YTNodes/classes/PivotButton.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PivotButton - -# Class: PivotButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PivotButton() - -> **new PivotButton**(`data`): [`PivotButton`](PivotButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PivotButton`](PivotButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PivotButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L18) - -## Properties - -### background\_animation\_style - -> **background\_animation\_style**: `string` - -#### Defined in - -[src/parser/classes/PivotButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L16) - -*** - -### content\_description - -> **content\_description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PivotButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/PivotButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L11) - -*** - -### sound\_attribution\_title - -> **sound\_attribution\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PivotButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L14) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/PivotButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L13) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/PivotButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### waveform\_animation\_style - -> **waveform\_animation\_style**: `string` - -#### Defined in - -[src/parser/classes/PivotButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'PivotButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PivotButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PivotButton.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PivotButton & { [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 PivotButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md b/docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md deleted file mode 100644 index 8885eff6..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerCaptionsTracklist - -# Class: PlayerCaptionsTracklist - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerCaptionsTracklist() - -> **new PlayerCaptionsTracklist**(`data`): [`PlayerCaptionsTracklist`](PlayerCaptionsTracklist.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerCaptionsTracklist`](PlayerCaptionsTracklist.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerCaptionsTracklist.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerCaptionsTracklist.ts#L35) - -## Properties - -### audio\_tracks? - -> `optional` **audio\_tracks**: `object`[] - -#### Defined in - -[src/parser/classes/PlayerCaptionsTracklist.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerCaptionsTracklist.ts#L19) - -*** - -### caption\_tracks? - -> `optional` **caption\_tracks**: `CaptionTrackData`[] - -#### Defined in - -[src/parser/classes/PlayerCaptionsTracklist.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerCaptionsTracklist.ts#L17) - -*** - -### default\_audio\_track\_index? - -> `optional` **default\_audio\_track\_index**: `number` - -#### Defined in - -[src/parser/classes/PlayerCaptionsTracklist.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerCaptionsTracklist.ts#L28) - -*** - -### translation\_languages? - -> `optional` **translation\_languages**: `object`[] - -#### Defined in - -[src/parser/classes/PlayerCaptionsTracklist.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerCaptionsTracklist.ts#L30) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlayerCaptionsTracklist'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerCaptionsTracklist.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerCaptionsTracklist.ts#L15) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerCaptionsTracklist & { [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 PlayerCaptionsTracklist & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md b/docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md deleted file mode 100644 index 7279bd79..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerControlsOverlay - -# Class: PlayerControlsOverlay - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerControlsOverlay() - -> **new PlayerControlsOverlay**(`data`): [`PlayerControlsOverlay`](PlayerControlsOverlay.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerControlsOverlay`](PlayerControlsOverlay.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerControlsOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerControlsOverlay.ts#L10) - -## Properties - -### overflow - -> **overflow**: `null` \| [`PlayerOverflow`](PlayerOverflow.md) - -#### Defined in - -[src/parser/classes/PlayerControlsOverlay.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerControlsOverlay.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlayerControlsOverlay'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerControlsOverlay.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerControlsOverlay.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerControlsOverlay & { [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 PlayerControlsOverlay & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md b/docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md deleted file mode 100644 index 5a2c285d..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerErrorMessage - -# Class: PlayerErrorMessage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerErrorMessage() - -> **new PlayerErrorMessage**(`data`): [`PlayerErrorMessage`](PlayerErrorMessage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerErrorMessage`](PlayerErrorMessage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerErrorMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerErrorMessage.ts#L16) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/PlayerErrorMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerErrorMessage.ts#L14) - -*** - -### proceed\_button - -> **proceed\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/PlayerErrorMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerErrorMessage.ts#L12) - -*** - -### reason - -> **reason**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerErrorMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerErrorMessage.ts#L11) - -*** - -### subreason - -> **subreason**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerErrorMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerErrorMessage.ts#L10) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/PlayerErrorMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerErrorMessage.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlayerErrorMessage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerErrorMessage.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerErrorMessage.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerErrorMessage & { [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 PlayerErrorMessage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md b/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md deleted file mode 100644 index a30d2430..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerLegacyDesktopYpcOffer - -# Class: PlayerLegacyDesktopYpcOffer - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerLegacyDesktopYpcOffer() - -> **new PlayerLegacyDesktopYpcOffer**(`data`): [`PlayerLegacyDesktopYpcOffer`](PlayerLegacyDesktopYpcOffer.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerLegacyDesktopYpcOffer`](PlayerLegacyDesktopYpcOffer.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L12) - -## Properties - -### offer\_description - -> **offer\_description**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L9) - -*** - -### offer\_id - -> **offer\_id**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L10) - -*** - -### thumbnail - -> **thumbnail**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L8) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlayerLegacyDesktopYpcOffer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerLegacyDesktopYpcOffer & { [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 PlayerLegacyDesktopYpcOffer & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md b/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md deleted file mode 100644 index bebb3e99..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerLegacyDesktopYpcTrailer - -# Class: PlayerLegacyDesktopYpcTrailer - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerLegacyDesktopYpcTrailer() - -> **new PlayerLegacyDesktopYpcTrailer**(`data`): [`PlayerLegacyDesktopYpcTrailer`](PlayerLegacyDesktopYpcTrailer.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerLegacyDesktopYpcTrailer`](PlayerLegacyDesktopYpcTrailer.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L18) - -## Properties - -### offer\_button\_text - -> **offer\_button\_text**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L14) - -*** - -### offer\_description - -> **offer\_description**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L12) - -*** - -### offer\_headline - -> **offer\_headline**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L11) - -*** - -### offer\_id - -> **offer\_id**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L13) - -*** - -### thumbnail - -> **thumbnail**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L10) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L9) - -*** - -### trailer - -> **trailer**: `null` \| [`YpcTrailer`](YpcTrailer.md) - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L8) - -*** - -### video\_message - -> **video\_message**: `string` - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'PlayerLegacyDesktopYpcTrailer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerLegacyDesktopYpcTrailer & { [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 PlayerLegacyDesktopYpcTrailer & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md b/docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md deleted file mode 100644 index bd5742bc..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md +++ /dev/null @@ -1,393 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerMicroformat - -# Class: PlayerMicroformat - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerMicroformat() - -> **new PlayerMicroformat**(`data`): [`PlayerMicroformat`](PlayerMicroformat.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerMicroformat`](PlayerMicroformat.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L41) - -## Properties - -### available\_countries - -> **available\_countries**: `string`[] - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L37) - -*** - -### category - -> **category**: `string` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L34) - -*** - -### channel - -> **channel**: `object` - -#### id - -> **id**: `string` - -#### name - -> **name**: `string` - -#### url - -> **url**: `string` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L24) - -*** - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L10) - -*** - -### embed? - -> `optional` **embed**: `object` - -#### flash\_secure\_url - -> **flash\_secure\_url**: `string` - -#### flash\_url - -> **flash\_url**: `string` - -#### height - -> **height**: `any` - -#### iframe\_url - -> **iframe\_url**: `string` - -#### width - -> **width**: `any` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L13) - -*** - -### end\_timestamp - -> **end\_timestamp**: `null` \| `Date` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L39) - -*** - -### has\_ypc\_metadata - -> **has\_ypc\_metadata**: `boolean` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L32) - -*** - -### is\_family\_safe - -> **is\_family\_safe**: `boolean` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L30) - -*** - -### is\_unlisted - -> **is\_unlisted**: `boolean` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L31) - -*** - -### length\_seconds - -> **length\_seconds**: `number` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L22) - -*** - -### publish\_date - -> **publish\_date**: `string` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L35) - -*** - -### start\_timestamp - -> **start\_timestamp**: `null` \| `Date` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L38) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### upload\_date - -> **upload\_date**: `string` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L36) - -*** - -### view\_count - -> **view\_count**: `number` - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L33) - -*** - -### type - -> `static` **type**: `string` = `'PlayerMicroformat'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerMicroformat.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerMicroformat.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerMicroformat & { [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 PlayerMicroformat & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerOverlay.md b/docs/api/namespaces/YTNodes/classes/PlayerOverlay.md deleted file mode 100644 index 1fb7b5f2..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerOverlay.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerOverlay - -# Class: PlayerOverlay - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerOverlay() - -> **new PlayerOverlay**(`data`): [`PlayerOverlay`](PlayerOverlay.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerOverlay`](PlayerOverlay.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L23) - -## Properties - -### actions - -> **actions**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L18) - -*** - -### add\_to\_menu - -> **add\_to\_menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L16) - -*** - -### autoplay - -> **autoplay**: `null` \| [`PlayerOverlayAutoplay`](PlayerOverlayAutoplay.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L14) - -*** - -### browser\_media\_session - -> **browser\_media\_session**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L19) - -*** - -### decorated\_player\_bar - -> **decorated\_player\_bar**: `null` \| [`DecoratedPlayerBar`](DecoratedPlayerBar.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L20) - -*** - -### end\_screen - -> **end\_screen**: `null` \| [`WatchNextEndScreen`](WatchNextEndScreen.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L13) - -*** - -### fullscreen\_engagement - -> **fullscreen\_engagement**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L17) - -*** - -### share\_button - -> **share\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_details - -> **video\_details**: `null` \| [`PlayerOverlayVideoDetails`](PlayerOverlayVideoDetails.md) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L21) - -*** - -### type - -> `static` **type**: `string` = `'PlayerOverlay'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerOverlay.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlay.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerOverlay & { [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 PlayerOverlay & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md b/docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md deleted file mode 100644 index f6ae5cba..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md +++ /dev/null @@ -1,331 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerOverlayAutoplay - -# Class: PlayerOverlayAutoplay - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerOverlayAutoplay() - -> **new PlayerOverlayAutoplay**(`data`): [`PlayerOverlayAutoplay`](PlayerOverlayAutoplay.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerOverlayAutoplay`](PlayerOverlayAutoplay.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L28) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L23) - -*** - -### background - -> **background**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L21) - -*** - -### cancel\_button - -> **cancel\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L24) - -*** - -### close\_button - -> **close\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L26) - -*** - -### count\_down\_secs\_for\_fullscreen - -> **count\_down\_secs\_for\_fullscreen**: `any` - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L18) - -*** - -### next\_button - -> **next\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L25) - -*** - -### prefer\_immediate\_redirect - -> **prefer\_immediate\_redirect**: `any` - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L17) - -*** - -### published - -> **published**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L20) - -*** - -### short\_view\_count - -> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L14) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L22) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L12) - -*** - -### video\_title - -> **video\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L13) - -*** - -### type - -> `static` **type**: `string` = `'PlayerOverlayAutoplay'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerOverlayAutoplay.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayAutoplay.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerOverlayAutoplay & { [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 PlayerOverlayAutoplay & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerOverlayVideoDetails.md b/docs/api/namespaces/YTNodes/classes/PlayerOverlayVideoDetails.md deleted file mode 100644 index da3ec237..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlayerOverlayVideoDetails.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerOverlayVideoDetails - -# Class: PlayerOverlayVideoDetails - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlayerOverlayVideoDetails() - -> **new PlayerOverlayVideoDetails**(`data`): [`PlayerOverlayVideoDetails`](PlayerOverlayVideoDetails.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlayerOverlayVideoDetails`](PlayerOverlayVideoDetails.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlayerOverlayVideoDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayVideoDetails.ts#L11) - -## Properties - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayVideoDetails.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayVideoDetails.ts#L9) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlayerOverlayVideoDetails.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayVideoDetails.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlayerOverlayVideoDetails'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlayerOverlayVideoDetails.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlayerOverlayVideoDetails.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerOverlayVideoDetails & { [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 PlayerOverlayVideoDetails & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Playlist.md b/docs/api/namespaces/YTNodes/classes/Playlist.md deleted file mode 100644 index ad8b8521..00000000 --- a/docs/api/namespaces/YTNodes/classes/Playlist.md +++ /dev/null @@ -1,347 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Playlist - -# Class: Playlist - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`CompactMix`](CompactMix.md) -- [`CompactPlaylist`](CompactPlaylist.md) -- [`Mix`](Mix.md) - -## Constructors - -### new Playlist() - -> **new Playlist**(`data`): [`Playlist`](Playlist.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Playlist`](Playlist.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Playlist.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L28) - -## Properties - -### author - -> **author**: [`Text`](../../Misc/classes/Text.md) \| [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L15) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L23) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L24) - -*** - -### first\_videos - -> **first\_videos**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L20) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L13) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L22) - -*** - -### share\_url - -> **share\_url**: `null` \| `string` - -#### Defined in - -[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L21) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L25) - -*** - -### thumbnail\_renderer? - -> `optional` **thumbnail\_renderer**: [`PlaylistCustomThumbnail`](PlaylistCustomThumbnail.md) \| [`PlaylistVideoThumbnail`](PlaylistVideoThumbnail.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L17) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L16) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L18) - -*** - -### video\_count\_short - -> **video\_count\_short**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L19) - -*** - -### view\_playlist? - -> `optional` **view\_playlist**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L26) - -*** - -### type - -> `static` **type**: `string` = `'Playlist'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Playlist.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Playlist.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Playlist & { [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 Playlist & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistAddToOption.md b/docs/api/namespaces/YTNodes/classes/PlaylistAddToOption.md deleted file mode 100644 index 6e8514ce..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistAddToOption.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistAddToOption - -# Class: PlaylistAddToOption - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistAddToOption() - -> **new PlaylistAddToOption**(`data`): [`PlaylistAddToOption`](PlaylistAddToOption.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistAddToOption`](PlaylistAddToOption.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L21) - -## Properties - -### add\_to\_playlist\_service\_endpoint - -> **add\_to\_playlist\_service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L13) - -*** - -### contains\_selected\_videos - -> **contains\_selected\_videos**: `"ALL"` \| `"NONE"` - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L14) - -*** - -### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L15) - -*** - -### privacy - -> **privacy**: `string` - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L16) - -*** - -### privacy\_icon - -> **privacy\_icon**: `PrivacyIcon` - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L17) - -*** - -### remove\_from\_playlist\_service\_endpoint - -> **remove\_from\_playlist\_service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L18) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L19) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistAddToOption'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistAddToOption.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistAddToOption.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistAddToOption & { [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 PlaylistAddToOption & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistEditEndpoint.md b/docs/api/namespaces/YTNodes/classes/PlaylistEditEndpoint.md deleted file mode 100644 index cea74086..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistEditEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistEditEndpoint - -# Class: PlaylistEditEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`PlaylistEditRequest`](../../APIResponseTypes/type-aliases/PlaylistEditRequest.md)\> - -## Constructors - -### new PlaylistEditEndpoint() - -> **new PlaylistEditEndpoint**(`data`): [`PlaylistEditEndpoint`](PlaylistEditEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistEditEndpoint`](PlaylistEditEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/PlaylistEditEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PlaylistEditEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistEditEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/PlaylistEditEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PlaylistEditEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`PlaylistEditRequest`](../../APIResponseTypes/type-aliases/PlaylistEditRequest.md) - -#### Returns - -[`PlaylistEditRequest`](../../APIResponseTypes/type-aliases/PlaylistEditRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/PlaylistEditEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PlaylistEditEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/PlaylistEditEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PlaylistEditEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistEditEndpoint & { [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 PlaylistEditEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistHeader.md b/docs/api/namespaces/YTNodes/classes/PlaylistHeader.md deleted file mode 100644 index 1de458fd..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistHeader.md +++ /dev/null @@ -1,371 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistHeader - -# Class: PlaylistHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistHeader() - -> **new PlaylistHeader**(`data`): [`PlaylistHeader`](PlaylistHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistHeader`](PlaylistHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L27) - -## Properties - -### author - -> **author**: `null` \| [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L14) - -*** - -### banner - -> **banner**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L25) - -*** - -### brief\_stats - -> **brief\_stats**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L13) - -*** - -### can\_delete - -> **can\_delete**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L19) - -*** - -### can\_share - -> **can\_share**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L18) - -*** - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L9) - -*** - -### is\_editable - -> **is\_editable**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L20) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L24) - -*** - -### num\_videos - -> **num\_videos**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L16) - -*** - -### privacy - -> **privacy**: `string` - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L21) - -*** - -### save\_button - -> **save\_button**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L22) - -*** - -### shuffle\_play\_button - -> **shuffle\_play\_button**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L23) - -*** - -### stats - -> **stats**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L12) - -*** - -### subtitle - -> **subtitle**: `null` \| [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_count - -> **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L17) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistHeader.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistHeader & { [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 PlaylistHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md b/docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md deleted file mode 100644 index a112c703..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistInfoCardContent - -# Class: PlaylistInfoCardContent - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistInfoCardContent() - -> **new PlaylistInfoCardContent**(`data`): [`PlaylistInfoCardContent`](PlaylistInfoCardContent.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistInfoCardContent`](PlaylistInfoCardContent.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistInfoCardContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistInfoCardContent.ts#L16) - -## Properties - -### channel\_name - -> **channel\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistInfoCardContent.ts#L13) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/PlaylistInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistInfoCardContent.ts#L14) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/PlaylistInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistInfoCardContent.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistInfoCardContent.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count - -> **video\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistInfoCardContent.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistInfoCardContent'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistInfoCardContent.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistInfoCardContent & { [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 PlaylistInfoCardContent & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md b/docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md deleted file mode 100644 index 0e86e385..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistMetadata - -# Class: PlaylistMetadata - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistMetadata() - -> **new PlaylistMetadata**(`data`): [`PlaylistMetadata`](PlaylistMetadata.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistMetadata`](PlaylistMetadata.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistMetadata.ts#L10) - -## Properties - -### description - -> **description**: `string` - -#### Defined in - -[src/parser/classes/PlaylistMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistMetadata.ts#L8) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/PlaylistMetadata.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistMetadata.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistMetadata'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistMetadata.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistMetadata.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistMetadata & { [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 PlaylistMetadata & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistPanel.md b/docs/api/namespaces/YTNodes/classes/PlaylistPanel.md deleted file mode 100644 index e80145cb..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistPanel.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistPanel - -# Class: PlaylistPanel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistPanel() - -> **new PlaylistPanel**(`data`): [`PlaylistPanel`](PlaylistPanel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistPanel`](PlaylistPanel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L21) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlaylistPanelVideo`](PlaylistPanelVideo.md) \| [`AutomixPreviewVideo`](AutomixPreviewVideo.md) \| [`PlaylistPanelVideoWrapper`](PlaylistPanelVideoWrapper.md)\> - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L13) - -*** - -### continuation - -> **continuation**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L16) - -*** - -### is\_editable - -> **is\_editable**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L17) - -*** - -### is\_infinite - -> **is\_infinite**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L15) - -*** - -### num\_items\_to\_show - -> **num\_items\_to\_show**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L19) - -*** - -### playlist\_id - -> **playlist\_id**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L14) - -*** - -### preview\_description - -> **preview\_description**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L18) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L11) - -*** - -### title\_text - -> **title\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistPanel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanel.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistPanel & { [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 PlaylistPanel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md b/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md deleted file mode 100644 index a2043f22..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md +++ /dev/null @@ -1,345 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistPanelVideo - -# Class: PlaylistPanelVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistPanelVideo() - -> **new PlaylistPanelVideo**(`data`): [`PlaylistPanelVideo`](PlaylistPanelVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistPanelVideo`](PlaylistPanelVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L42) - -## Properties - -### album? - -> `optional` **album**: `object` - -#### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### id? - -> `optional` **id**: `string` - -#### name - -> **name**: `string` - -#### year? - -> `optional` **year**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L25) - -*** - -### artists? - -> `optional` **artists**: `object`[] - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L32) - -*** - -### author - -> **author**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L23) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L38) - -*** - -### duration - -> **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L18) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L14) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L39) - -*** - -### selected - -> **selected**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L15) - -*** - -### set\_video\_id? - -> `optional` **set\_video\_id**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L40) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L16) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistPanelVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideo.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistPanelVideo & { [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 PlaylistPanelVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md b/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md deleted file mode 100644 index 20d510ff..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistPanelVideoWrapper - -# Class: PlaylistPanelVideoWrapper - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistPanelVideoWrapper() - -> **new PlaylistPanelVideoWrapper**(`data`): [`PlaylistPanelVideoWrapper`](PlaylistPanelVideoWrapper.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistPanelVideoWrapper`](PlaylistPanelVideoWrapper.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideoWrapper.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideoWrapper.ts#L11) - -## Properties - -### counterpart? - -> `optional` **counterpart**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlaylistPanelVideo`](PlaylistPanelVideo.md)\> - -#### Defined in - -[src/parser/classes/PlaylistPanelVideoWrapper.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideoWrapper.ts#L9) - -*** - -### primary - -> **primary**: `null` \| [`PlaylistPanelVideo`](PlaylistPanelVideo.md) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideoWrapper.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideoWrapper.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistPanelVideoWrapper'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistPanelVideoWrapper.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistPanelVideoWrapper.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistPanelVideoWrapper & { [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 PlaylistPanelVideoWrapper & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md b/docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md deleted file mode 100644 index d1b7eac8..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md +++ /dev/null @@ -1,225 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistSidebar - -# Class: PlaylistSidebar - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistSidebar() - -> **new PlaylistSidebar**(`data`): [`PlaylistSidebar`](PlaylistSidebar.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistSidebar`](PlaylistSidebar.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistSidebar.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebar.ts#L9) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/PlaylistSidebar.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebar.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistSidebar'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistSidebar.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebar.ts#L5) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/PlaylistSidebar.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebar.ts#L15) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistSidebar & { [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 PlaylistSidebar & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md b/docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md deleted file mode 100644 index 2b79edaa..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistSidebarPrimaryInfo - -# Class: PlaylistSidebarPrimaryInfo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistSidebarPrimaryInfo() - -> **new PlaylistSidebarPrimaryInfo**(`data`): [`PlaylistSidebarPrimaryInfo`](PlaylistSidebarPrimaryInfo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistSidebarPrimaryInfo`](PlaylistSidebarPrimaryInfo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L16) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L13) - -*** - -### menu - -> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L12) - -*** - -### stats - -> **stats**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L9) - -*** - -### thumbnail\_renderer - -> **thumbnail\_renderer**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistSidebarPrimaryInfo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistSidebarPrimaryInfo & { [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 PlaylistSidebarPrimaryInfo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md b/docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md deleted file mode 100644 index f7373eda..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistSidebarSecondaryInfo - -# Class: PlaylistSidebarSecondaryInfo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistSidebarSecondaryInfo() - -> **new PlaylistSidebarSecondaryInfo**(`data`): [`PlaylistSidebarSecondaryInfo`](PlaylistSidebarSecondaryInfo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistSidebarSecondaryInfo`](PlaylistSidebarSecondaryInfo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L10) - -## Properties - -### button - -> **button**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L8) - -*** - -### owner - -> **owner**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistSidebarSecondaryInfo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistSidebarSecondaryInfo & { [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 PlaylistSidebarSecondaryInfo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistThumbnailOverlay.md b/docs/api/namespaces/YTNodes/classes/PlaylistThumbnailOverlay.md deleted file mode 100644 index 7b7e5fa6..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistThumbnailOverlay.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistThumbnailOverlay - -# Class: PlaylistThumbnailOverlay - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistThumbnailOverlay() - -> **new PlaylistThumbnailOverlay**(`data`): [`PlaylistThumbnailOverlay`](PlaylistThumbnailOverlay.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistThumbnailOverlay`](PlaylistThumbnailOverlay.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistThumbnailOverlay.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistThumbnailOverlay.ts#L11) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/PlaylistThumbnailOverlay.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistThumbnailOverlay.ts#L8) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistThumbnailOverlay.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistThumbnailOverlay.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistThumbnailOverlay'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistThumbnailOverlay.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistThumbnailOverlay.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistThumbnailOverlay & { [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 PlaylistThumbnailOverlay & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistVideo.md b/docs/api/namespaces/YTNodes/classes/PlaylistVideo.md deleted file mode 100644 index f7184dcd..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistVideo.md +++ /dev/null @@ -1,387 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistVideo - -# Class: PlaylistVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistVideo() - -> **new PlaylistVideo**(`data`): [`PlaylistVideo`](PlaylistVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistVideo`](PlaylistVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L33) - -## Properties - -### accessibility\_label? - -> `optional` **accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L25) - -*** - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L16) - -*** - -### duration - -> **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L28) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L20) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L13) - -*** - -### index - -> **index**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L14) - -*** - -### is\_playable - -> **is\_playable**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L21) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L22) - -*** - -### set\_video\_id - -> **set\_video\_id**: `undefined` \| `string` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L19) - -*** - -### style? - -> `optional` **style**: `string` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L26) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L18) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L17) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### upcoming? - -> `optional` **upcoming**: `Date` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L23) - -*** - -### video\_info - -> **video\_info**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L24) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L11) - -## Accessors - -### is\_live - -> `get` **is\_live**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:63](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L63) - -*** - -### is\_upcoming - -> `get` **is\_upcoming**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/PlaylistVideo.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideo.ts#L67) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistVideo & { [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 PlaylistVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md b/docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md deleted file mode 100644 index 56232dc8..00000000 --- a/docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlaylistVideoList - -# Class: PlaylistVideoList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PlaylistVideoList() - -> **new PlaylistVideoList**(`data`): [`PlaylistVideoList`](PlaylistVideoList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PlaylistVideoList`](PlaylistVideoList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/PlaylistVideoList.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideoList.ts#L12) - -## Properties - -### can\_reorder - -> **can\_reorder**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistVideoList.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideoList.ts#L9) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/PlaylistVideoList.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideoList.ts#L7) - -*** - -### is\_editable - -> **is\_editable**: `boolean` - -#### Defined in - -[src/parser/classes/PlaylistVideoList.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideoList.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### videos - -> **videos**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/PlaylistVideoList.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideoList.ts#L10) - -*** - -### type - -> `static` **type**: `string` = `'PlaylistVideoList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/PlaylistVideoList.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/PlaylistVideoList.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistVideoList & { [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 PlaylistVideoList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Poll.md b/docs/api/namespaces/YTNodes/classes/Poll.md deleted file mode 100644 index 84ff7f03..00000000 --- a/docs/api/namespaces/YTNodes/classes/Poll.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Poll - -# Class: Poll - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Poll() - -> **new Poll**(`data`): [`Poll`](Poll.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Poll`](Poll.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Poll.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Poll.ts#L25) - -## Properties - -### choices - -> **choices**: `object`[] - -#### Defined in - -[src/parser/classes/Poll.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Poll.ts#L10) - -*** - -### live\_chat\_poll\_id? - -> `optional` **live\_chat\_poll\_id**: `string` - -#### Defined in - -[src/parser/classes/Poll.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Poll.ts#L23) - -*** - -### poll\_type? - -> `optional` **poll\_type**: `string` - -#### Defined in - -[src/parser/classes/Poll.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Poll.ts#L21) - -*** - -### total\_votes? - -> `optional` **total\_votes**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Poll.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Poll.ts#L22) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Poll'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Poll.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Poll.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Poll & { [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 Poll & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PollHeader.md b/docs/api/namespaces/YTNodes/classes/PollHeader.md deleted file mode 100644 index 930b00aa..00000000 --- a/docs/api/namespaces/YTNodes/classes/PollHeader.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PollHeader - -# Class: PollHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new PollHeader() - -> **new PollHeader**(`data`): [`PollHeader`](PollHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PollHeader`](PollHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/items/PollHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PollHeader.ts#L17) - -## Properties - -### context\_menu\_button - -> **context\_menu\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/livechat/items/PollHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PollHeader.ts#L15) - -*** - -### live\_chat\_poll\_type - -> **live\_chat\_poll\_type**: `string` - -#### Defined in - -[src/parser/classes/livechat/items/PollHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PollHeader.ts#L14) - -*** - -### metadata - -> **metadata**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/PollHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PollHeader.ts#L13) - -*** - -### poll\_question - -> **poll\_question**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/items/PollHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PollHeader.ts#L11) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/livechat/items/PollHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PollHeader.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PollHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/items/PollHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/items/PollHeader.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PollHeader & { [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 PollHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Post.md b/docs/api/namespaces/YTNodes/classes/Post.md deleted file mode 100644 index d72f9403..00000000 --- a/docs/api/namespaces/YTNodes/classes/Post.md +++ /dev/null @@ -1,383 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Post - -# Class: Post - -## Extends - -- [`BackstagePost`](BackstagePost.md) - -## Constructors - -### new Post() - -> **new Post**(`data`): [`Post`](Post.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Post`](Post.md) - -#### Overrides - -[`BackstagePost`](BackstagePost.md).[`constructor`](BackstagePost.md#constructors) - -#### Defined in - -[src/parser/classes/Post.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Post.ts#L7) - -## Properties - -### action\_buttons? - -> `optional` **action\_buttons**: `null` \| [`CommentActionButtons`](CommentActionButtons.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`action_buttons`](BackstagePost.md#action_buttons) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L21) - -*** - -### attachment - -> **attachment**: `undefined` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`attachment`](BackstagePost.md#attachment) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L25) - -*** - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`author`](BackstagePost.md#author) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L14) - -*** - -### content - -> **content**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`content`](BackstagePost.md#content) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L15) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`endpoint`](BackstagePost.md#endpoint) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L24) - -*** - -### id - -> **id**: `string` - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`id`](BackstagePost.md#id) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L13) - -*** - -### menu? - -> `optional` **menu**: `null` \| [`Menu`](Menu.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`menu`](BackstagePost.md#menu) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L20) - -*** - -### poll\_status? - -> `optional` **poll\_status**: `string` - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`poll_status`](BackstagePost.md#poll_status) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L17) - -*** - -### published - -> **published**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`published`](BackstagePost.md#published) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L16) - -*** - -### surface - -> **surface**: `string` - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`surface`](BackstagePost.md#surface) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L23) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`type`](BackstagePost.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### vote\_button? - -> `optional` **vote\_button**: `null` \| [`Button`](Button.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`vote_button`](BackstagePost.md#vote_button) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L22) - -*** - -### vote\_count? - -> `optional` **vote\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`vote_count`](BackstagePost.md#vote_count) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L19) - -*** - -### vote\_status? - -> `optional` **vote\_status**: `string` - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`vote_status`](BackstagePost.md#vote_status) - -#### Defined in - -[src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/BackstagePost.ts#L18) - -*** - -### type - -> `static` **type**: `string` = `'Post'` - -#### Overrides - -[`BackstagePost`](BackstagePost.md).[`type`](BackstagePost.md#type-1) - -#### Defined in - -[src/parser/classes/Post.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Post.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`as`](BackstagePost.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Post & { [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 Post & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`hasKey`](BackstagePost.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`is`](BackstagePost.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`BackstagePost`](BackstagePost.md).[`key`](BackstagePost.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/PrefetchWatchCommand.md b/docs/api/namespaces/YTNodes/classes/PrefetchWatchCommand.md deleted file mode 100644 index c27570a5..00000000 --- a/docs/api/namespaces/YTNodes/classes/PrefetchWatchCommand.md +++ /dev/null @@ -1,237 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PrefetchWatchCommand - -# Class: PrefetchWatchCommand - -## Extends - -- [`WatchEndpoint`](WatchEndpoint.md) - -## Constructors - -### new PrefetchWatchCommand() - -> **new PrefetchWatchCommand**(`data`): [`PrefetchWatchCommand`](PrefetchWatchCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`PrefetchWatchCommand`](PrefetchWatchCommand.md) - -#### Overrides - -[`WatchEndpoint`](WatchEndpoint.md).[`constructor`](WatchEndpoint.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/PrefetchWatchCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PrefetchWatchCommand.ts#L7) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`WatchEndpoint`](WatchEndpoint.md).[`type`](WatchEndpoint.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'PrefetchWatchCommand'` - -#### Overrides - -[`WatchEndpoint`](WatchEndpoint.md).[`type`](WatchEndpoint.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/PrefetchWatchCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/PrefetchWatchCommand.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`WatchEndpoint`](WatchEndpoint.md).[`as`](WatchEndpoint.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`WatchRequest`](../../APIResponseTypes/type-aliases/WatchRequest.md) - -#### Returns - -[`WatchRequest`](../../APIResponseTypes/type-aliases/WatchRequest.md) - -#### Inherited from - -[`WatchEndpoint`](WatchEndpoint.md).[`buildRequest`](WatchEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/WatchEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`WatchEndpoint`](WatchEndpoint.md).[`getApiPath`](WatchEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/WatchEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is PrefetchWatchCommand & { [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 PrefetchWatchCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`WatchEndpoint`](WatchEndpoint.md).[`hasKey`](WatchEndpoint.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`WatchEndpoint`](WatchEndpoint.md).[`is`](WatchEndpoint.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`WatchEndpoint`](WatchEndpoint.md).[`key`](WatchEndpoint.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ProductListItem.md b/docs/api/namespaces/YTNodes/classes/ProductListItem.md deleted file mode 100644 index 44b277be..00000000 --- a/docs/api/namespaces/YTNodes/classes/ProductListItem.md +++ /dev/null @@ -1,281 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ProductListItem - -# Class: ProductListItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ProductListItem() - -> **new ProductListItem**(`data`): [`ProductListItem`](ProductListItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ProductListItem`](ProductListItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ProductListItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L20) - -## Properties - -### accessibility\_title - -> **accessibility\_title**: `string` - -#### Defined in - -[src/parser/classes/ProductListItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ProductListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L15) - -*** - -### merchant\_name - -> **merchant\_name**: `string` - -#### Defined in - -[src/parser/classes/ProductListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L16) - -*** - -### price - -> **price**: `string` - -#### Defined in - -[src/parser/classes/ProductListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L14) - -*** - -### stay\_in\_app - -> **stay\_in\_app**: `boolean` - -#### Defined in - -[src/parser/classes/ProductListItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L17) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ProductListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ProductListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_button - -> **view\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ProductListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L18) - -*** - -### type - -> `static` **type**: `string` = `'ProductListItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ProductListItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProductListItem.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ProductListItem & { [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 ProductListItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md b/docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md deleted file mode 100644 index 55ada976..00000000 --- a/docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md +++ /dev/null @@ -1,225 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ProfileColumnStats - -# Class: ProfileColumnStats - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ProfileColumnStats() - -> **new ProfileColumnStats**(`data`): [`ProfileColumnStats`](ProfileColumnStats.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ProfileColumnStats`](ProfileColumnStats.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ProfileColumnStats.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStats.ts#L9) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ProfileColumnStats.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStats.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ProfileColumnStats'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ProfileColumnStats.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStats.ts#L5) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ProfileColumnStats.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStats.ts#L15) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ProfileColumnStats & { [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 ProfileColumnStats & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md b/docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md deleted file mode 100644 index 61ae23e0..00000000 --- a/docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ProfileColumnStatsEntry - -# Class: ProfileColumnStatsEntry - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ProfileColumnStatsEntry() - -> **new ProfileColumnStatsEntry**(`data`): [`ProfileColumnStatsEntry`](ProfileColumnStatsEntry.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ProfileColumnStatsEntry`](ProfileColumnStatsEntry.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ProfileColumnStatsEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStatsEntry.ts#L11) - -## Properties - -### label - -> **label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ProfileColumnStatsEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStatsEntry.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### value - -> **value**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ProfileColumnStatsEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStatsEntry.ts#L9) - -*** - -### type - -> `static` **type**: `string` = `'ProfileColumnStatsEntry'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ProfileColumnStatsEntry.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnStatsEntry.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ProfileColumnStatsEntry & { [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 ProfileColumnStatsEntry & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md b/docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md deleted file mode 100644 index 53ba590f..00000000 --- a/docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ProfileColumnUserInfo - -# Class: ProfileColumnUserInfo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ProfileColumnUserInfo() - -> **new ProfileColumnUserInfo**(`data`): [`ProfileColumnUserInfo`](ProfileColumnUserInfo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ProfileColumnUserInfo`](ProfileColumnUserInfo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ProfileColumnUserInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnUserInfo.ts#L12) - -## Properties - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ProfileColumnUserInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnUserInfo.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ProfileColumnUserInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnUserInfo.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ProfileColumnUserInfo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ProfileColumnUserInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ProfileColumnUserInfo.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ProfileColumnUserInfo & { [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 ProfileColumnUserInfo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Quiz.md b/docs/api/namespaces/YTNodes/classes/Quiz.md deleted file mode 100644 index 9c5d1ec4..00000000 --- a/docs/api/namespaces/YTNodes/classes/Quiz.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Quiz - -# Class: Quiz - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Quiz() - -> **new Quiz**(`data`): [`Quiz`](Quiz.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Quiz`](Quiz.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Quiz.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Quiz.ts#L15) - -## Properties - -### choices - -> **choices**: `object`[] - -#### Defined in - -[src/parser/classes/Quiz.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Quiz.ts#L8) - -*** - -### total\_votes - -> **total\_votes**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Quiz.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Quiz.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Quiz'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Quiz.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Quiz.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Quiz & { [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 Quiz & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RecognitionShelf.md b/docs/api/namespaces/YTNodes/classes/RecognitionShelf.md deleted file mode 100644 index 92553f99..00000000 --- a/docs/api/namespaces/YTNodes/classes/RecognitionShelf.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RecognitionShelf - -# Class: RecognitionShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RecognitionShelf() - -> **new RecognitionShelf**(`data`): [`RecognitionShelf`](RecognitionShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RecognitionShelf`](RecognitionShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/RecognitionShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RecognitionShelf.ts#L16) - -## Properties - -### avatars - -> **avatars**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/RecognitionShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RecognitionShelf.ts#L12) - -*** - -### button - -> **button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/RecognitionShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RecognitionShelf.ts#L13) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RecognitionShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RecognitionShelf.ts#L11) - -*** - -### surface - -> **surface**: `string` - -#### Defined in - -[src/parser/classes/RecognitionShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RecognitionShelf.ts#L14) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RecognitionShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RecognitionShelf.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RecognitionShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/RecognitionShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RecognitionShelf.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RecognitionShelf & { [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 RecognitionShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReelItem.md b/docs/api/namespaces/YTNodes/classes/ReelItem.md deleted file mode 100644 index f12fb796..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReelItem.md +++ /dev/null @@ -1,275 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReelItem - -# Class: ReelItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ReelItem() - -> **new ReelItem**(`data`): [`ReelItem`](ReelItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReelItem`](ReelItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ReelItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L18) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/ReelItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L16) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ReelItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L15) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/ReelItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L11) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ReelItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ReelItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### views - -> **views**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ReelItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L14) - -*** - -### type - -> `static` **type**: `string` = `'ReelItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ReelItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L9) - -## Accessors - -### label - -> `get` **label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/ReelItem.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelItem.ts#L34) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReelItem & { [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 ReelItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md b/docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md deleted file mode 100644 index c932e0dc..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReelPlayerHeader - -# Class: ReelPlayerHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ReelPlayerHeader() - -> **new ReelPlayerHeader**(`data`): [`ReelPlayerHeader`](ReelPlayerHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReelPlayerHeader`](ReelPlayerHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ReelPlayerHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerHeader.ts#L16) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/ReelPlayerHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerHeader.ts#L14) - -*** - -### channel\_thumbnail - -> **channel\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ReelPlayerHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerHeader.ts#L13) - -*** - -### channel\_title\_text - -> **channel\_title\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ReelPlayerHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerHeader.ts#L12) - -*** - -### reel\_title\_text - -> **reel\_title\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ReelPlayerHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerHeader.ts#L10) - -*** - -### timestamp\_text - -> **timestamp\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ReelPlayerHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerHeader.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ReelPlayerHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ReelPlayerHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReelPlayerHeader & { [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 ReelPlayerHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md b/docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md deleted file mode 100644 index d3821bcd..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md +++ /dev/null @@ -1,311 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReelPlayerOverlay - -# Class: ReelPlayerOverlay - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ReelPlayerOverlay() - -> **new ReelPlayerOverlay**(`data`): [`ReelPlayerOverlay`](ReelPlayerOverlay.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReelPlayerOverlay`](ReelPlayerOverlay.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L26) - -## Properties - -### info\_panel - -> **info\_panel**: `null` \| [`InfoPanelContainer`](InfoPanelContainer.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L24) - -*** - -### like\_button - -> **like\_button**: `null` \| [`LikeButton`](LikeButton.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L14) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L16) - -*** - -### next\_item\_button - -> **next\_item\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L17) - -*** - -### pivot\_button - -> **pivot\_button**: `null` \| [`PivotButton`](PivotButton.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L23) - -*** - -### prev\_item\_button - -> **prev\_item\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L18) - -*** - -### reel\_player\_header\_supported\_renderers - -> **reel\_player\_header\_supported\_renderers**: `null` \| [`ReelPlayerHeader`](ReelPlayerHeader.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L15) - -*** - -### share\_button - -> **share\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L22) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L20) - -*** - -### subscribe\_button\_renderer - -> **subscribe\_button\_renderer**: `null` \| [`Button`](Button.md) \| [`SubscribeButton`](SubscribeButton.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L19) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_comments\_button - -> **view\_comments\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L21) - -*** - -### type - -> `static` **type**: `string` = `'ReelPlayerOverlay'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ReelPlayerOverlay.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelPlayerOverlay.ts#L12) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReelPlayerOverlay & { [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 ReelPlayerOverlay & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReelShelf.md b/docs/api/namespaces/YTNodes/classes/ReelShelf.md deleted file mode 100644 index a73e1505..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReelShelf.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReelShelf - -# Class: ReelShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ReelShelf() - -> **new ReelShelf**(`data`): [`ReelShelf`](ReelShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReelShelf`](ReelShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ReelShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelShelf.ts#L13) - -## Properties - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ReelShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelShelf.ts#L11) - -*** - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ReelShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelShelf.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ReelShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelShelf.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ReelShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ReelShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelShelf.ts#L7) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/ReelShelf.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ReelShelf.ts#L24) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReelShelf & { [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 ReelShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReelWatchEndpoint.md b/docs/api/namespaces/YTNodes/classes/ReelWatchEndpoint.md deleted file mode 100644 index 2ed9f27d..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReelWatchEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReelWatchEndpoint - -# Class: ReelWatchEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`ReelWatchRequest`](../../APIResponseTypes/type-aliases/ReelWatchRequest.md)\> - -## Constructors - -### new ReelWatchEndpoint() - -> **new ReelWatchEndpoint**(`data`): [`ReelWatchEndpoint`](ReelWatchEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReelWatchEndpoint`](ReelWatchEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/ReelWatchEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ReelWatchEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ReelWatchEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/ReelWatchEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ReelWatchEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`ReelWatchRequest`](../../APIResponseTypes/type-aliases/ReelWatchRequest.md) - -#### Returns - -[`ReelWatchRequest`](../../APIResponseTypes/type-aliases/ReelWatchRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/ReelWatchEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ReelWatchEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/ReelWatchEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ReelWatchEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReelWatchEndpoint & { [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 ReelWatchEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md b/docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md deleted file mode 100644 index 8349dbef..00000000 --- a/docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RemoveBannerForLiveChatCommand - -# Class: RemoveBannerForLiveChatCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RemoveBannerForLiveChatCommand() - -> **new RemoveBannerForLiveChatCommand**(`data`): [`RemoveBannerForLiveChatCommand`](RemoveBannerForLiveChatCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RemoveBannerForLiveChatCommand`](RemoveBannerForLiveChatCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L9) - -## Properties - -### target\_action\_id - -> **target\_action\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RemoveBannerForLiveChatCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RemoveBannerForLiveChatCommand & { [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 RemoveBannerForLiveChatCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md b/docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md deleted file mode 100644 index 4d1b94b9..00000000 --- a/docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RemoveChatItemAction - -# Class: RemoveChatItemAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RemoveChatItemAction() - -> **new RemoveChatItemAction**(`data`): [`RemoveChatItemAction`](RemoveChatItemAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RemoveChatItemAction`](RemoveChatItemAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/RemoveChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveChatItemAction.ts#L9) - -## Properties - -### target\_item\_id - -> **target\_item\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/RemoveChatItemAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveChatItemAction.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RemoveChatItemAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/RemoveChatItemAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveChatItemAction.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RemoveChatItemAction & { [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 RemoveChatItemAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md b/docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md deleted file mode 100644 index 8d28a371..00000000 --- a/docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RemoveChatItemByAuthorAction - -# Class: RemoveChatItemByAuthorAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RemoveChatItemByAuthorAction() - -> **new RemoveChatItemByAuthorAction**(`data`): [`RemoveChatItemByAuthorAction`](RemoveChatItemByAuthorAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RemoveChatItemByAuthorAction`](RemoveChatItemByAuthorAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L9) - -## Properties - -### external\_channel\_id - -> **external\_channel\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RemoveChatItemByAuthorAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RemoveChatItemByAuthorAction & { [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 RemoveChatItemByAuthorAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md b/docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md deleted file mode 100644 index a0f1ebfc..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReplaceChatItemAction - -# Class: ReplaceChatItemAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ReplaceChatItemAction() - -> **new ReplaceChatItemAction**(`data`): [`ReplaceChatItemAction`](ReplaceChatItemAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReplaceChatItemAction`](ReplaceChatItemAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/ReplaceChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceChatItemAction.ts#L11) - -## Properties - -### replacement\_item - -> **replacement\_item**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/ReplaceChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceChatItemAction.ts#L9) - -*** - -### target\_item\_id - -> **target\_item\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/ReplaceChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceChatItemAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ReplaceChatItemAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/ReplaceChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceChatItemAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReplaceChatItemAction & { [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 ReplaceChatItemAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReplaceLiveChatAction.md b/docs/api/namespaces/YTNodes/classes/ReplaceLiveChatAction.md deleted file mode 100644 index 09191b47..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReplaceLiveChatAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReplaceLiveChatAction - -# Class: ReplaceLiveChatAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ReplaceLiveChatAction() - -> **new ReplaceLiveChatAction**(`data`): [`ReplaceLiveChatAction`](ReplaceLiveChatAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReplaceLiveChatAction`](ReplaceLiveChatAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/ReplaceLiveChatAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceLiveChatAction.ts#L10) - -## Properties - -### replacement - -> **replacement**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/ReplaceLiveChatAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceLiveChatAction.ts#L8) - -*** - -### to\_replace - -> **to\_replace**: `string` - -#### Defined in - -[src/parser/classes/livechat/ReplaceLiveChatAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceLiveChatAction.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ReplaceLiveChatAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/ReplaceLiveChatAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplaceLiveChatAction.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReplaceLiveChatAction & { [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 ReplaceLiveChatAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md b/docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md deleted file mode 100644 index 4c5237f5..00000000 --- a/docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ReplayChatItemAction - -# Class: ReplayChatItemAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ReplayChatItemAction() - -> **new ReplayChatItemAction**(`data`): [`ReplayChatItemAction`](ReplayChatItemAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ReplayChatItemAction`](ReplayChatItemAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/ReplayChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplayChatItemAction.ts#L11) - -## Properties - -### actions - -> **actions**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/livechat/ReplayChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplayChatItemAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_offset\_time\_msec - -> **video\_offset\_time\_msec**: `string` - -#### Defined in - -[src/parser/classes/livechat/ReplayChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplayChatItemAction.ts#L9) - -*** - -### type - -> `static` **type**: `string` = `'ReplayChatItemAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/ReplayChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ReplayChatItemAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ReplayChatItemAction & { [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 ReplayChatItemAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RichListHeader.md b/docs/api/namespaces/YTNodes/classes/RichListHeader.md deleted file mode 100644 index e2a1684a..00000000 --- a/docs/api/namespaces/YTNodes/classes/RichListHeader.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RichListHeader - -# Class: RichListHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RichListHeader() - -> **new RichListHeader**(`data`): [`RichListHeader`](RichListHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RichListHeader`](RichListHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/RichListHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichListHeader.ts#L13) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/RichListHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichListHeader.ts#L11) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RichListHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichListHeader.ts#L9) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RichListHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichListHeader.ts#L8) - -*** - -### title\_style? - -> `optional` **title\_style**: `string` - -#### Defined in - -[src/parser/classes/RichListHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichListHeader.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RichListHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/RichListHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichListHeader.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RichListHeader & { [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 RichListHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RichMetadata.md b/docs/api/namespaces/YTNodes/classes/RichMetadata.md deleted file mode 100644 index ab2b9f1a..00000000 --- a/docs/api/namespaces/YTNodes/classes/RichMetadata.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RichMetadata - -# Class: RichMetadata - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RichMetadata() - -> **new RichMetadata**(`data`): [`RichMetadata`](RichMetadata.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RichMetadata`](RichMetadata.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/RichMetadata.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L17) - -## Properties - -### call\_to\_action - -> **call\_to\_action**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RichMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L13) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/RichMetadata.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L15) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/RichMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L14) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RichMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L12) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/RichMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RichMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RichMetadata'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/RichMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichMetadata.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RichMetadata & { [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 RichMetadata & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RichSection.md b/docs/api/namespaces/YTNodes/classes/RichSection.md deleted file mode 100644 index f749be30..00000000 --- a/docs/api/namespaces/YTNodes/classes/RichSection.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RichSection - -# Class: RichSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RichSection() - -> **new RichSection**(`data`): [`RichSection`](RichSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RichSection`](RichSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/RichSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichSection.ts#L11) - -## Properties - -### content - -> **content**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/RichSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichSection.ts#L7) - -*** - -### full\_bleed - -> **full\_bleed**: `boolean` - -#### Defined in - -[src/parser/classes/RichSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichSection.ts#L8) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/RichSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichSection.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RichSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/RichSection.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichSection.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RichSection & { [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 RichSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RichShelf.md b/docs/api/namespaces/YTNodes/classes/RichShelf.md deleted file mode 100644 index 7cc4be74..00000000 --- a/docs/api/namespaces/YTNodes/classes/RichShelf.md +++ /dev/null @@ -1,321 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RichShelf - -# Class: RichShelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RichShelf() - -> **new RichShelf**(`data`): [`RichShelf`](RichShelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RichShelf`](RichShelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/RichShelf.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L26) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/RichShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L10) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/RichShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L11) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/RichShelf.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L21) - -*** - -### is\_bottom\_divider\_hidden - -> **is\_bottom\_divider\_hidden**: `boolean` - -#### Defined in - -[src/parser/classes/RichShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L14) - -*** - -### is\_expanded - -> **is\_expanded**: `boolean` - -#### Defined in - -[src/parser/classes/RichShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L13) - -*** - -### is\_top\_divider\_hidden - -> **is\_top\_divider\_hidden**: `boolean` - -#### Defined in - -[src/parser/classes/RichShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L15) - -*** - -### layout\_sizing? - -> `optional` **layout\_sizing**: `"RICH_GRID_LAYOUT_SIZING_UNSPECIFIED"` \| `"RICH_GRID_LAYOUT_SIZING_STANDARD"` \| `"RICH_GRID_LAYOUT_SIZING_COMPACT"` \| `"RICH_GRID_LAYOUT_SIZING_EXTRA_COMPACT"` \| `"RICH_GRID_LAYOUT_SIZING_TINY"` - -#### Defined in - -[src/parser/classes/RichShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L16) - -*** - -### menu - -> **menu**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/RichShelf.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L22) - -*** - -### next\_button - -> **next\_button**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/RichShelf.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L23) - -*** - -### previous\_button - -> **previous\_button**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/RichShelf.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L24) - -*** - -### subtitle? - -> `optional` **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RichShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/RichShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RichShelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/RichShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/RichShelf.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RichShelf & { [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 RichShelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/RunAttestationCommand.md b/docs/api/namespaces/YTNodes/classes/RunAttestationCommand.md deleted file mode 100644 index 71f424f1..00000000 --- a/docs/api/namespaces/YTNodes/classes/RunAttestationCommand.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / RunAttestationCommand - -# Class: RunAttestationCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new RunAttestationCommand() - -> **new RunAttestationCommand**(`data`): [`RunAttestationCommand`](RunAttestationCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`RunAttestationCommand`](RunAttestationCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/commands/RunAttestationCommand.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/RunAttestationCommand.ts#L21) - -## Properties - -### engagement\_type - -> **engagement\_type**: `string` - -#### Defined in - -[src/parser/classes/commands/RunAttestationCommand.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/RunAttestationCommand.ts#L18) - -*** - -### ids? - -> `optional` **ids**: `AttIds`[] - -#### Defined in - -[src/parser/classes/commands/RunAttestationCommand.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/RunAttestationCommand.ts#L19) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'RunAttestationCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/commands/RunAttestationCommand.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/RunAttestationCommand.ts#L16) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is RunAttestationCommand & { [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 RunAttestationCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchBox.md b/docs/api/namespaces/YTNodes/classes/SearchBox.md deleted file mode 100644 index 740313ad..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchBox.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchBox - -# Class: SearchBox - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SearchBox() - -> **new SearchBox**(`data`): [`SearchBox`](SearchBox.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchBox`](SearchBox.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SearchBox.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchBox.ts#L15) - -## Properties - -### clear\_button - -> **clear\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/SearchBox.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchBox.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SearchBox.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchBox.ts#L10) - -*** - -### placeholder\_text - -> **placeholder\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SearchBox.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchBox.ts#L13) - -*** - -### search\_button - -> **search\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/SearchBox.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchBox.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchBox'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SearchBox.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchBox.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchBox & { [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 SearchBox & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchEndpoint.md b/docs/api/namespaces/YTNodes/classes/SearchEndpoint.md deleted file mode 100644 index 3ab83c90..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchEndpoint - -# Class: SearchEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`SearchRequest`](../../APIResponseTypes/type-aliases/SearchRequest.md)\> - -## Constructors - -### new SearchEndpoint() - -> **new SearchEndpoint**(`data`): [`SearchEndpoint`](SearchEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchEndpoint`](SearchEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/SearchEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SearchEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/SearchEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SearchEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`SearchRequest`](../../APIResponseTypes/type-aliases/SearchRequest.md) - -#### Returns - -[`SearchRequest`](../../APIResponseTypes/type-aliases/SearchRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/SearchEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SearchEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/SearchEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SearchEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchEndpoint & { [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 SearchEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchFilter.md b/docs/api/namespaces/YTNodes/classes/SearchFilter.md deleted file mode 100644 index 5c6b65e4..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchFilter.md +++ /dev/null @@ -1,269 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchFilter - -# Class: SearchFilter - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SearchFilter() - -> **new SearchFilter**(`data`): [`SearchFilter`](SearchFilter.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchFilter`](SearchFilter.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SearchFilter.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L14) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SearchFilter.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L10) - -*** - -### label - -> **label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SearchFilter.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L9) - -*** - -### status? - -> `optional` **status**: `string` - -#### Defined in - -[src/parser/classes/SearchFilter.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L12) - -*** - -### tooltip - -> **tooltip**: `string` - -#### Defined in - -[src/parser/classes/SearchFilter.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchFilter'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SearchFilter.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L7) - -## Accessors - -### disabled - -> `get` **disabled**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/SearchFilter.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L25) - -*** - -### selected - -> `get` **selected**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/SearchFilter.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilter.ts#L29) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchFilter & { [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 SearchFilter & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md b/docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md deleted file mode 100644 index 3ec1f2fc..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchFilterOptionsDialog - -# Class: SearchFilterOptionsDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SearchFilterOptionsDialog() - -> **new SearchFilterOptionsDialog**(`data`): [`SearchFilterOptionsDialog`](SearchFilterOptionsDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchFilterOptionsDialog`](SearchFilterOptionsDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SearchFilterOptionsDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilterOptionsDialog.ts#L13) - -## Properties - -### groups - -> **groups**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchFilterGroup`](SearchFilterGroup.md)\> - -#### Defined in - -[src/parser/classes/SearchFilterOptionsDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilterOptionsDialog.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SearchFilterOptionsDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilterOptionsDialog.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchFilterOptionsDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SearchFilterOptionsDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchFilterOptionsDialog.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchFilterOptionsDialog & { [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 SearchFilterOptionsDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchHeader.md b/docs/api/namespaces/YTNodes/classes/SearchHeader.md deleted file mode 100644 index 602bf920..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchHeader.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchHeader - -# Class: SearchHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SearchHeader() - -> **new SearchHeader**(`data`): [`SearchHeader`](SearchHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchHeader`](SearchHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SearchHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchHeader.ts#L12) - -## Properties - -### chip\_bar - -> **chip\_bar**: `null` \| [`ChipCloud`](ChipCloud.md) - -#### Defined in - -[src/parser/classes/SearchHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchHeader.ts#L9) - -*** - -### search\_filter\_button - -> **search\_filter\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/SearchHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchHeader.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SearchHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchHeader.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchHeader & { [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 SearchHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md b/docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md deleted file mode 100644 index f7afcded..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchRefinementCard - -# Class: SearchRefinementCard - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SearchRefinementCard() - -> **new SearchRefinementCard**(`data`): [`SearchRefinementCard`](SearchRefinementCard.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchRefinementCard`](SearchRefinementCard.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SearchRefinementCard.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchRefinementCard.ts#L14) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SearchRefinementCard.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchRefinementCard.ts#L11) - -*** - -### query - -> **query**: `string` - -#### Defined in - -[src/parser/classes/SearchRefinementCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchRefinementCard.ts#L12) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/SearchRefinementCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchRefinementCard.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchRefinementCard'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SearchRefinementCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchRefinementCard.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchRefinementCard & { [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 SearchRefinementCard & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchSubMenu.md b/docs/api/namespaces/YTNodes/classes/SearchSubMenu.md deleted file mode 100644 index 9873d9ad..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchSubMenu.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchSubMenu - -# Class: SearchSubMenu - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SearchSubMenu() - -> **new SearchSubMenu**(`data`): [`SearchSubMenu`](SearchSubMenu.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchSubMenu`](SearchSubMenu.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SearchSubMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSubMenu.ts#L15) - -## Properties - -### button? - -> `optional` **button**: `null` \| [`ToggleButton`](ToggleButton.md) - -#### Defined in - -[src/parser/classes/SearchSubMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSubMenu.ts#L13) - -*** - -### groups? - -> `optional` **groups**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchFilterGroup`](SearchFilterGroup.md)\> - -#### Defined in - -[src/parser/classes/SearchSubMenu.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSubMenu.ts#L12) - -*** - -### title? - -> `optional` **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SearchSubMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSubMenu.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchSubMenu'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SearchSubMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSubMenu.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchSubMenu & { [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 SearchSubMenu & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SearchSuggestion.md b/docs/api/namespaces/YTNodes/classes/SearchSuggestion.md deleted file mode 100644 index c5f5edd8..00000000 --- a/docs/api/namespaces/YTNodes/classes/SearchSuggestion.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SearchSuggestion - -# Class: SearchSuggestion - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`HistorySuggestion`](HistorySuggestion.md) - -## Constructors - -### new SearchSuggestion() - -> **new SearchSuggestion**(`data`): [`SearchSuggestion`](SearchSuggestion.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SearchSuggestion`](SearchSuggestion.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SearchSuggestion.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSuggestion.ts#L14) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SearchSuggestion.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSuggestion.ts#L10) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/SearchSuggestion.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSuggestion.ts#L11) - -*** - -### service\_endpoint? - -> `optional` **service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SearchSuggestion.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSuggestion.ts#L12) - -*** - -### suggestion - -> **suggestion**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SearchSuggestion.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSuggestion.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SearchSuggestion'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SearchSuggestion.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SearchSuggestion.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SearchSuggestion & { [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 SearchSuggestion & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md b/docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md deleted file mode 100644 index a69b6c2e..00000000 --- a/docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SecondarySearchContainer - -# Class: SecondarySearchContainer - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SecondarySearchContainer() - -> **new SecondarySearchContainer**(`data`): [`SecondarySearchContainer`](SecondarySearchContainer.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SecondarySearchContainer`](SecondarySearchContainer.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SecondarySearchContainer.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SecondarySearchContainer.ts#L11) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`UniversalWatchCard`](UniversalWatchCard.md)\> - -#### Defined in - -[src/parser/classes/SecondarySearchContainer.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SecondarySearchContainer.ts#L9) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/SecondarySearchContainer.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SecondarySearchContainer.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SecondarySearchContainer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SecondarySearchContainer.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SecondarySearchContainer.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SecondarySearchContainer & { [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 SecondarySearchContainer & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SectionList.md b/docs/api/namespaces/YTNodes/classes/SectionList.md deleted file mode 100644 index d012cbb9..00000000 --- a/docs/api/namespaces/YTNodes/classes/SectionList.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SectionList - -# Class: SectionList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SectionList() - -> **new SectionList**(`data`): [`SectionList`](SectionList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SectionList`](SectionList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SectionList.ts#L13) - -## Properties - -### contents - -> **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/SectionList.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SectionList.ts#L7) - -*** - -### continuation? - -> `optional` **continuation**: `string` - -#### Defined in - -[src/parser/classes/SectionList.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SectionList.ts#L9) - -*** - -### header? - -> `optional` **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/SectionList.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SectionList.ts#L10) - -*** - -### sub\_menu? - -> `optional` **sub\_menu**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/SectionList.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SectionList.ts#L11) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/SectionList.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SectionList.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SectionList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SectionList.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SectionList.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SectionList & { [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 SectionList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md b/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md deleted file mode 100644 index 78917aaa..00000000 --- a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SegmentedLikeDislikeButton - -# Class: SegmentedLikeDislikeButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SegmentedLikeDislikeButton() - -> **new SegmentedLikeDislikeButton**(`data`): [`SegmentedLikeDislikeButton`](SegmentedLikeDislikeButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SegmentedLikeDislikeButton`](SegmentedLikeDislikeButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButton.ts#L13) - -## Properties - -### dislike\_button - -> **dislike\_button**: `null` \| [`Button`](Button.md) \| [`ToggleButton`](ToggleButton.md) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButton.ts#L11) - -*** - -### like\_button - -> **like\_button**: `null` \| [`Button`](Button.md) \| [`ToggleButton`](ToggleButton.md) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButton.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SegmentedLikeDislikeButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButton.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SegmentedLikeDislikeButton & { [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 SegmentedLikeDislikeButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md b/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md deleted file mode 100644 index 7f816596..00000000 --- a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SegmentedLikeDislikeButtonView - -# Class: SegmentedLikeDislikeButtonView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SegmentedLikeDislikeButtonView() - -> **new SegmentedLikeDislikeButtonView**(`data`): [`SegmentedLikeDislikeButtonView`](SegmentedLikeDislikeButtonView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SegmentedLikeDislikeButtonView`](SegmentedLikeDislikeButtonView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L25) - -## Properties - -### dislike\_button - -> **dislike\_button**: `null` \| [`DislikeButtonView`](DislikeButtonView.md) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L10) - -*** - -### dynamic\_like\_count\_update\_data - -> **dynamic\_like\_count\_update\_data**: `object` - -#### placeholder\_like\_count\_values\_key - -> **placeholder\_like\_count\_values\_key**: `string` - -#### update\_delay\_loop\_id - -> **update\_delay\_loop\_id**: `string` - -#### update\_delay\_sec - -> **update\_delay\_sec**: `number` - -#### update\_status\_key - -> **update\_status\_key**: `string` - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L15) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L11) - -*** - -### like\_button - -> **like\_button**: `null` \| [`LikeButtonView`](LikeButtonView.md) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L9) - -*** - -### like\_count? - -> `optional` **like\_count**: `number` - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L22) - -*** - -### like\_count\_entity - -> **like\_count\_entity**: `object` - -#### key - -> **key**: `string` - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L12) - -*** - -### short\_like\_count? - -> `optional` **short\_like\_count**: `string` - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L23) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SegmentedLikeDislikeButtonView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SegmentedLikeDislikeButtonView & { [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 SegmentedLikeDislikeButtonView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SettingBoolean.md b/docs/api/namespaces/YTNodes/classes/SettingBoolean.md deleted file mode 100644 index fed0b960..00000000 --- a/docs/api/namespaces/YTNodes/classes/SettingBoolean.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SettingBoolean - -# Class: SettingBoolean - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SettingBoolean() - -> **new SettingBoolean**(`data`): [`SettingBoolean`](SettingBoolean.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SettingBoolean`](SettingBoolean.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SettingBoolean.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingBoolean.ts#L15) - -## Properties - -### disable\_endpoint? - -> `optional` **disable\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SettingBoolean.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingBoolean.ts#L12) - -*** - -### enable\_endpoint? - -> `optional` **enable\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SettingBoolean.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingBoolean.ts#L11) - -*** - -### item\_id - -> **item\_id**: `string` - -#### Defined in - -[src/parser/classes/SettingBoolean.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingBoolean.ts#L13) - -*** - -### summary? - -> `optional` **summary**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SettingBoolean.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingBoolean.ts#L10) - -*** - -### title? - -> `optional` **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SettingBoolean.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingBoolean.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SettingBoolean'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SettingBoolean.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingBoolean.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SettingBoolean & { [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 SettingBoolean & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md b/docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md deleted file mode 100644 index b46dd76b..00000000 --- a/docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SettingsCheckbox - -# Class: SettingsCheckbox - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SettingsCheckbox() - -> **new SettingsCheckbox**(`data`): [`SettingsCheckbox`](SettingsCheckbox.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SettingsCheckbox`](SettingsCheckbox.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SettingsCheckbox.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsCheckbox.ts#L14) - -## Properties - -### disabled - -> **disabled**: `boolean` - -#### Defined in - -[src/parser/classes/SettingsCheckbox.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsCheckbox.ts#L11) - -*** - -### enabled - -> **enabled**: `boolean` - -#### Defined in - -[src/parser/classes/SettingsCheckbox.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsCheckbox.ts#L10) - -*** - -### help\_text - -> **help\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SettingsCheckbox.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsCheckbox.ts#L9) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/SettingsCheckbox.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsCheckbox.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SettingsCheckbox.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsCheckbox.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SettingsCheckbox'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SettingsCheckbox.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsCheckbox.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SettingsCheckbox & { [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 SettingsCheckbox & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SettingsSidebar.md b/docs/api/namespaces/YTNodes/classes/SettingsSidebar.md deleted file mode 100644 index 4cf4e80f..00000000 --- a/docs/api/namespaces/YTNodes/classes/SettingsSidebar.md +++ /dev/null @@ -1,235 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SettingsSidebar - -# Class: SettingsSidebar - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SettingsSidebar() - -> **new SettingsSidebar**(`data`): [`SettingsSidebar`](SettingsSidebar.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SettingsSidebar`](SettingsSidebar.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SettingsSidebar.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSidebar.ts#L12) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactLink`](CompactLink.md)\> - -#### Defined in - -[src/parser/classes/SettingsSidebar.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSidebar.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SettingsSidebar.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSidebar.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SettingsSidebar'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SettingsSidebar.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSidebar.ts#L7) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactLink`](CompactLink.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactLink`](CompactLink.md)\> - -#### Defined in - -[src/parser/classes/SettingsSidebar.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSidebar.ts#L19) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SettingsSidebar & { [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 SettingsSidebar & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SettingsSwitch.md b/docs/api/namespaces/YTNodes/classes/SettingsSwitch.md deleted file mode 100644 index 072d247e..00000000 --- a/docs/api/namespaces/YTNodes/classes/SettingsSwitch.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SettingsSwitch - -# Class: SettingsSwitch - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SettingsSwitch() - -> **new SettingsSwitch**(`data`): [`SettingsSwitch`](SettingsSwitch.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SettingsSwitch`](SettingsSwitch.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SettingsSwitch.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSwitch.ts#L15) - -## Properties - -### disable\_endpoint - -> **disable\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SettingsSwitch.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSwitch.ts#L13) - -*** - -### enable\_endpoint - -> **enable\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SettingsSwitch.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSwitch.ts#L12) - -*** - -### enabled - -> **enabled**: `boolean` - -#### Defined in - -[src/parser/classes/SettingsSwitch.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSwitch.ts#L11) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SettingsSwitch.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSwitch.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SettingsSwitch.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSwitch.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SettingsSwitch'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SettingsSwitch.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SettingsSwitch.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SettingsSwitch & { [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 SettingsSwitch & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShareEntityServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/ShareEntityServiceEndpoint.md deleted file mode 100644 index 9c321d3f..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShareEntityServiceEndpoint.md +++ /dev/null @@ -1,246 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShareEntityServiceEndpoint - -# Class: ShareEntityServiceEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`ShareEndpoint`](ShareEndpoint.md) -- [`ShareEntityEndpoint`](ShareEntityEndpoint.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md)\> - -## Constructors - -### new ShareEntityServiceEndpoint() - -> **new ShareEntityServiceEndpoint**(`data`): [`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShareEntityServiceEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md) - -#### Returns - -[`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShareEntityServiceEndpoint & { [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 ShareEntityServiceEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShareTarget.md b/docs/api/namespaces/YTNodes/classes/ShareTarget.md deleted file mode 100644 index 1ca256ab..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShareTarget.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShareTarget - -# Class: ShareTarget - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShareTarget() - -> **new ShareTarget**(`data`): [`ShareTarget`](ShareTarget.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShareTarget`](ShareTarget.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ShareTarget.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShareTarget.ts#L14) - -## Properties - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ShareTarget.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShareTarget.ts#L9) - -*** - -### service\_name - -> **service\_name**: `string` - -#### Defined in - -[src/parser/classes/ShareTarget.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShareTarget.ts#L10) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/ShareTarget.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShareTarget.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ShareTarget.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShareTarget.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShareTarget'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ShareTarget.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShareTarget.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShareTarget & { [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 ShareTarget & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SharedPost.md b/docs/api/namespaces/YTNodes/classes/SharedPost.md deleted file mode 100644 index 099d9a62..00000000 --- a/docs/api/namespaces/YTNodes/classes/SharedPost.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SharedPost - -# Class: SharedPost - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SharedPost() - -> **new SharedPost**(`data`): [`SharedPost`](SharedPost.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SharedPost`](SharedPost.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SharedPost.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L26) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/SharedPost.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L24) - -*** - -### content - -> **content**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SharedPost.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L17) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SharedPost.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L22) - -*** - -### expand\_button - -> **expand\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/SharedPost.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L23) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[src/parser/classes/SharedPost.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L21) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/SharedPost.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L19) - -*** - -### original\_post - -> **original\_post**: `null` \| [`BackstagePost`](BackstagePost.md) \| [`Post`](Post.md) - -#### Defined in - -[src/parser/classes/SharedPost.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L20) - -*** - -### published - -> **published**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SharedPost.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L18) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/SharedPost.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SharedPost'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SharedPost.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SharedPost.ts#L14) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SharedPost & { [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 SharedPost & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Shelf.md b/docs/api/namespaces/YTNodes/classes/Shelf.md deleted file mode 100644 index 4e788b74..00000000 --- a/docs/api/namespaces/YTNodes/classes/Shelf.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Shelf - -# Class: Shelf - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Shelf() - -> **new Shelf**(`data`): [`Shelf`](Shelf.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Shelf`](Shelf.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Shelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L18) - -## Properties - -### content - -> **content**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Shelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L12) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Shelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L11) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/Shelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L13) - -*** - -### menu? - -> `optional` **menu**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Shelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L14) - -*** - -### play\_all\_button? - -> `optional` **play\_all\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/Shelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L15) - -*** - -### subtitle? - -> `optional` **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Shelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L16) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Shelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Shelf'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Shelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Shelf.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Shelf & { [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 Shelf & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShortsLockupView.md b/docs/api/namespaces/YTNodes/classes/ShortsLockupView.md deleted file mode 100644 index 5a6ad528..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShortsLockupView.md +++ /dev/null @@ -1,309 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShortsLockupView - -# Class: ShortsLockupView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShortsLockupView() - -> **new ShortsLockupView**(`data`): [`ShortsLockupView`](ShortsLockupView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShortsLockupView`](ShortsLockupView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L26) - -## Properties - -### accessibility\_text - -> **accessibility\_text**: `string` - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L13) - -*** - -### badge? - -> `optional` **badge**: `null` \| [`BadgeView`](BadgeView.md) - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L24) - -*** - -### entity\_id - -> **entity\_id**: `string` - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L12) - -*** - -### index\_in\_collection - -> **index\_in\_collection**: `number` - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L17) - -*** - -### inline\_player\_data? - -> `optional` **inline\_player\_data**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L23) - -*** - -### menu\_on\_tap - -> **menu\_on\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L16) - -*** - -### menu\_on\_tap\_a11y\_label - -> **menu\_on\_tap\_a11y\_label**: `string` - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L18) - -*** - -### on\_tap\_endpoint - -> **on\_tap\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L15) - -*** - -### overlay\_metadata - -> **overlay\_metadata**: `object` - -#### primary\_text? - -> `optional` **primary\_text**: [`Text`](../../Misc/classes/Text.md) - -#### secondary\_text? - -> `optional` **secondary\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L19) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShortsLockupView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ShortsLockupView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShortsLockupView.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShortsLockupView & { [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 ShortsLockupView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShowDialogCommand.md b/docs/api/namespaces/YTNodes/classes/ShowDialogCommand.md deleted file mode 100644 index 4092ae74..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShowDialogCommand.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShowDialogCommand - -# Class: ShowDialogCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShowDialogCommand() - -> **new ShowDialogCommand**(`data`): [`ShowDialogCommand`](ShowDialogCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShowDialogCommand`](ShowDialogCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/commands/ShowDialogCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ShowDialogCommand.ts#L10) - -## Properties - -### inline\_content - -> **inline\_content**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/commands/ShowDialogCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ShowDialogCommand.ts#L7) - -*** - -### remove\_default\_padding - -> **remove\_default\_padding**: `boolean` - -#### Defined in - -[src/parser/classes/commands/ShowDialogCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ShowDialogCommand.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShowDialogCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/commands/ShowDialogCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/ShowDialogCommand.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShowDialogCommand & { [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 ShowDialogCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShowEngagementPanelEndpoint.md b/docs/api/namespaces/YTNodes/classes/ShowEngagementPanelEndpoint.md deleted file mode 100644 index 3c0e718a..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShowEngagementPanelEndpoint.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShowEngagementPanelEndpoint - -# Class: ShowEngagementPanelEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShowEngagementPanelEndpoint() - -> **new ShowEngagementPanelEndpoint**(`data`): [`ShowEngagementPanelEndpoint`](ShowEngagementPanelEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShowEngagementPanelEndpoint`](ShowEngagementPanelEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts#L10) - -## Properties - -### panel\_identifier - -> **panel\_identifier**: `string` - -#### Defined in - -[src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts#L7) - -*** - -### source\_panel\_identifier? - -> `optional` **source\_panel\_identifier**: `string` - -#### Defined in - -[src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShowEngagementPanelEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/ShowEngagementPanelEndpoint.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShowEngagementPanelEndpoint & { [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 ShowEngagementPanelEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md b/docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md deleted file mode 100644 index 60b1c6aa..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShowLiveChatActionPanelAction - -# Class: ShowLiveChatActionPanelAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShowLiveChatActionPanelAction() - -> **new ShowLiveChatActionPanelAction**(`data`): [`ShowLiveChatActionPanelAction`](ShowLiveChatActionPanelAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShowLiveChatActionPanelAction`](ShowLiveChatActionPanelAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L11) - -## Properties - -### panel\_to\_show - -> **panel\_to\_show**: `null` \| [`LiveChatActionPanel`](LiveChatActionPanel.md) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShowLiveChatActionPanelAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShowLiveChatActionPanelAction & { [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 ShowLiveChatActionPanelAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md b/docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md deleted file mode 100644 index 1fc74972..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShowLiveChatDialogAction - -# Class: ShowLiveChatDialogAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShowLiveChatDialogAction() - -> **new ShowLiveChatDialogAction**(`data`): [`ShowLiveChatDialogAction`](ShowLiveChatDialogAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShowLiveChatDialogAction`](ShowLiveChatDialogAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L10) - -## Properties - -### dialog - -> **dialog**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShowLiveChatDialogAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShowLiveChatDialogAction & { [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 ShowLiveChatDialogAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md b/docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md deleted file mode 100644 index 07557fe3..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShowLiveChatTooltipCommand - -# Class: ShowLiveChatTooltipCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShowLiveChatTooltipCommand() - -> **new ShowLiveChatTooltipCommand**(`data`): [`ShowLiveChatTooltipCommand`](ShowLiveChatTooltipCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShowLiveChatTooltipCommand`](ShowLiveChatTooltipCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L10) - -## Properties - -### tooltip - -> **tooltip**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShowLiveChatTooltipCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShowLiveChatTooltipCommand & { [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 ShowLiveChatTooltipCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md b/docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md deleted file mode 100644 index c54ef3e0..00000000 --- a/docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShowingResultsFor - -# Class: ShowingResultsFor - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ShowingResultsFor() - -> **new ShowingResultsFor**(`data`): [`ShowingResultsFor`](ShowingResultsFor.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ShowingResultsFor`](ShowingResultsFor.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L16) - -## Properties - -### corrected\_query - -> **corrected\_query**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L9) - -*** - -### corrected\_query\_endpoint - -> **corrected\_query\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L11) - -*** - -### original\_query - -> **original\_query**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L10) - -*** - -### original\_query\_endpoint - -> **original\_query\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L12) - -*** - -### search\_instead\_for - -> **search\_instead\_for**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L13) - -*** - -### showing\_results\_for - -> **showing\_results\_for**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ShowingResultsFor'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ShowingResultsFor.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ShowingResultsFor.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ShowingResultsFor & { [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 ShowingResultsFor & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SignalServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/SignalServiceEndpoint.md deleted file mode 100644 index dbc7c45a..00000000 --- a/docs/api/namespaces/YTNodes/classes/SignalServiceEndpoint.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SignalServiceEndpoint - -# Class: SignalServiceEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SignalServiceEndpoint() - -> **new SignalServiceEndpoint**(`data`): [`SignalServiceEndpoint`](SignalServiceEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SignalServiceEndpoint`](SignalServiceEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/SignalServiceEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SignalServiceEndpoint.ts#L10) - -## Properties - -### actions? - -> `optional` **actions**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/endpoints/SignalServiceEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SignalServiceEndpoint.ts#L7) - -*** - -### signal? - -> `optional` **signal**: `string` - -#### Defined in - -[src/parser/classes/endpoints/SignalServiceEndpoint.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SignalServiceEndpoint.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SignalServiceEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/SignalServiceEndpoint.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SignalServiceEndpoint.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SignalServiceEndpoint & { [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 SignalServiceEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleCardContent.md b/docs/api/namespaces/YTNodes/classes/SimpleCardContent.md deleted file mode 100644 index 39942692..00000000 --- a/docs/api/namespaces/YTNodes/classes/SimpleCardContent.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SimpleCardContent - -# Class: SimpleCardContent - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SimpleCardContent() - -> **new SimpleCardContent**(`data`): [`SimpleCardContent`](SimpleCardContent.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SimpleCardContent`](SimpleCardContent.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L17) - -## Properties - -### call\_to\_action - -> **call\_to\_action**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L14) - -*** - -### display\_domain - -> **display\_domain**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L15) - -*** - -### image - -> **image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L10) - -*** - -### show\_link\_icon - -> **show\_link\_icon**: `boolean` - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SimpleCardContent'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SimpleCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardContent.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SimpleCardContent & { [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 SimpleCardContent & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md b/docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md deleted file mode 100644 index bc4bd4b6..00000000 --- a/docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SimpleCardTeaser - -# Class: SimpleCardTeaser - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SimpleCardTeaser() - -> **new SimpleCardTeaser**(`data`): [`SimpleCardTeaser`](SimpleCardTeaser.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SimpleCardTeaser`](SimpleCardTeaser.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SimpleCardTeaser.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardTeaser.ts#L11) - -## Properties - -### message - -> **message**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SimpleCardTeaser.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardTeaser.ts#L8) - -*** - -### prominent - -> **prominent**: `boolean` - -#### Defined in - -[src/parser/classes/SimpleCardTeaser.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardTeaser.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SimpleCardTeaser'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SimpleCardTeaser.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleCardTeaser.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SimpleCardTeaser & { [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 SimpleCardTeaser & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md b/docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md deleted file mode 100644 index 55a5fd9b..00000000 --- a/docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SimpleMenuHeader - -# Class: SimpleMenuHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SimpleMenuHeader() - -> **new SimpleMenuHeader**(`data`): [`SimpleMenuHeader`](SimpleMenuHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SimpleMenuHeader`](SimpleMenuHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/menus/SimpleMenuHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/SimpleMenuHeader.ts#L14) - -## Properties - -### buttons - -> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md)\> - -#### Defined in - -[src/parser/classes/menus/SimpleMenuHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/SimpleMenuHeader.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/menus/SimpleMenuHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/SimpleMenuHeader.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SimpleMenuHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/menus/SimpleMenuHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/menus/SimpleMenuHeader.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SimpleMenuHeader & { [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 SimpleMenuHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleTextSection.md b/docs/api/namespaces/YTNodes/classes/SimpleTextSection.md deleted file mode 100644 index 1c28d6b1..00000000 --- a/docs/api/namespaces/YTNodes/classes/SimpleTextSection.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SimpleTextSection - -# Class: SimpleTextSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SimpleTextSection() - -> **new SimpleTextSection**(`data`): [`SimpleTextSection`](SimpleTextSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SimpleTextSection`](SimpleTextSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SimpleTextSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleTextSection.ts#L11) - -## Properties - -### lines - -> **lines**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/SimpleTextSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleTextSection.ts#L8) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/SimpleTextSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleTextSection.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SimpleTextSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SimpleTextSection.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SimpleTextSection.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SimpleTextSection & { [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 SimpleTextSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md b/docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md deleted file mode 100644 index 11b501a9..00000000 --- a/docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SingleActionEmergencySupport - -# Class: SingleActionEmergencySupport - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SingleActionEmergencySupport() - -> **new SingleActionEmergencySupport**(`data`): [`SingleActionEmergencySupport`](SingleActionEmergencySupport.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SingleActionEmergencySupport`](SingleActionEmergencySupport.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SingleActionEmergencySupport.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleActionEmergencySupport.ts#L15) - -## Properties - -### action\_text - -> **action\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SingleActionEmergencySupport.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleActionEmergencySupport.ts#L9) - -*** - -### details - -> **details**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SingleActionEmergencySupport.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleActionEmergencySupport.ts#L11) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SingleActionEmergencySupport.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleActionEmergencySupport.ts#L13) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/SingleActionEmergencySupport.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleActionEmergencySupport.ts#L12) - -*** - -### nav\_text - -> **nav\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SingleActionEmergencySupport.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleActionEmergencySupport.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SingleActionEmergencySupport'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SingleActionEmergencySupport.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleActionEmergencySupport.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SingleActionEmergencySupport & { [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 SingleActionEmergencySupport & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SingleHeroImage.md b/docs/api/namespaces/YTNodes/classes/SingleHeroImage.md deleted file mode 100644 index 6aebb499..00000000 --- a/docs/api/namespaces/YTNodes/classes/SingleHeroImage.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SingleHeroImage - -# Class: SingleHeroImage - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SingleHeroImage() - -> **new SingleHeroImage**(`data`): [`SingleHeroImage`](SingleHeroImage.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SingleHeroImage`](SingleHeroImage.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SingleHeroImage.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleHeroImage.ts#L11) - -## Properties - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/SingleHeroImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleHeroImage.ts#L9) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/SingleHeroImage.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleHeroImage.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SingleHeroImage'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SingleHeroImage.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SingleHeroImage.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SingleHeroImage & { [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 SingleHeroImage & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SlimOwner.md b/docs/api/namespaces/YTNodes/classes/SlimOwner.md deleted file mode 100644 index b8299f6d..00000000 --- a/docs/api/namespaces/YTNodes/classes/SlimOwner.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SlimOwner - -# Class: SlimOwner - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SlimOwner() - -> **new SlimOwner**(`data`): [`SlimOwner`](SlimOwner.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SlimOwner`](SlimOwner.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SlimOwner.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimOwner.ts#L16) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SlimOwner.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimOwner.ts#L13) - -*** - -### subscribe\_button - -> **subscribe\_button**: `null` \| [`SubscribeButton`](SubscribeButton.md) - -#### Defined in - -[src/parser/classes/SlimOwner.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimOwner.ts#L14) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/SlimOwner.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimOwner.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SlimOwner.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimOwner.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SlimOwner'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SlimOwner.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimOwner.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SlimOwner & { [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 SlimOwner & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md b/docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md deleted file mode 100644 index 230ec0b2..00000000 --- a/docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SlimVideoMetadata - -# Class: SlimVideoMetadata - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SlimVideoMetadata() - -> **new SlimVideoMetadata**(`data`): [`SlimVideoMetadata`](SlimVideoMetadata.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SlimVideoMetadata`](SlimVideoMetadata.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L16) - -## Properties - -### collapsed\_subtitle - -> **collapsed\_subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L9) - -*** - -### date - -> **date**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L14) - -*** - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L12) - -*** - -### expanded\_subtitle - -> **expanded\_subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L10) - -*** - -### owner - -> **owner**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L11) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L13) - -*** - -### type - -> `static` **type**: `string` = `'SlimVideoMetadata'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SlimVideoMetadata.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SlimVideoMetadata.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SlimVideoMetadata & { [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 SlimVideoMetadata & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SortFilterHeader.md b/docs/api/namespaces/YTNodes/classes/SortFilterHeader.md deleted file mode 100644 index 81f58264..00000000 --- a/docs/api/namespaces/YTNodes/classes/SortFilterHeader.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SortFilterHeader - -# Class: SortFilterHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SortFilterHeader() - -> **new SortFilterHeader**(`data`): [`SortFilterHeader`](SortFilterHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SortFilterHeader`](SortFilterHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SortFilterHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterHeader.ts#L9) - -## Properties - -### filter\_menu - -> **filter\_menu**: `null` \| [`SortFilterSubMenu`](SortFilterSubMenu.md) - -#### Defined in - -[src/parser/classes/SortFilterHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterHeader.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SortFilterHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SortFilterHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterHeader.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SortFilterHeader & { [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 SortFilterHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md b/docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md deleted file mode 100644 index 9b10233f..00000000 --- a/docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md +++ /dev/null @@ -1,265 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SortFilterSubMenu - -# Class: SortFilterSubMenu - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SortFilterSubMenu() - -> **new SortFilterSubMenu**(`data`): [`SortFilterSubMenu`](SortFilterSubMenu.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SortFilterSubMenu`](SortFilterSubMenu.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L23) - -## Properties - -### accessibility? - -> `optional` **accessibility**: `AccessibilitySupportedDatas` - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L21) - -*** - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L18) - -*** - -### sub\_menu\_items? - -> `optional` **sub\_menu\_items**: `SubMenuItem`[] - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L20) - -*** - -### title? - -> `optional` **title**: `string` - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L17) - -*** - -### tooltip? - -> `optional` **tooltip**: `string` - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L19) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SortFilterSubMenu'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L15) - -## Accessors - -### label - -> `get` **label**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[src/parser/classes/SortFilterSubMenu.ts:55](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SortFilterSubMenu.ts#L55) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SortFilterSubMenu & { [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 SortFilterSubMenu & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md b/docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md deleted file mode 100644 index 489dea78..00000000 --- a/docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SponsorCommentBadge - -# Class: SponsorCommentBadge - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SponsorCommentBadge() - -> **new SponsorCommentBadge**(`data`): [`SponsorCommentBadge`](SponsorCommentBadge.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SponsorCommentBadge`](SponsorCommentBadge.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/SponsorCommentBadge.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/SponsorCommentBadge.ts#L11) - -## Properties - -### custom\_badge - -> **custom\_badge**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/comments/SponsorCommentBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/SponsorCommentBadge.ts#L8) - -*** - -### tooltip - -> **tooltip**: `string` - -#### Defined in - -[src/parser/classes/comments/SponsorCommentBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/SponsorCommentBadge.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SponsorCommentBadge'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/SponsorCommentBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/SponsorCommentBadge.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SponsorCommentBadge & { [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 SponsorCommentBadge & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md b/docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md deleted file mode 100644 index 99e26121..00000000 --- a/docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md +++ /dev/null @@ -1,301 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / StructuredDescriptionPlaylistLockup - -# Class: StructuredDescriptionPlaylistLockup - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new StructuredDescriptionPlaylistLockup() - -> **new StructuredDescriptionPlaylistLockup**(`data`): [`StructuredDescriptionPlaylistLockup`](StructuredDescriptionPlaylistLockup.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`StructuredDescriptionPlaylistLockup`](StructuredDescriptionPlaylistLockup.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L21) - -## Properties - -### aspect\_ratio - -> **aspect\_ratio**: `number` - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L16) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L14) - -*** - -### max\_lines\_short\_byline\_text - -> **max\_lines\_short\_byline\_text**: `number` - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L18) - -*** - -### max\_lines\_title - -> **max\_lines\_title**: `number` - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L17) - -*** - -### overlay\_position - -> **overlay\_position**: `string` - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L19) - -*** - -### short\_byline\_text - -> **short\_byline\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L12) - -*** - -### thumbnail - -> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L10) - -*** - -### thumbnail\_width - -> **thumbnail\_width**: `number` - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L15) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_count\_short\_text - -> **video\_count\_short\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L13) - -*** - -### type - -> `static` **type**: `string` = `'StructuredDescriptionPlaylistLockup'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is StructuredDescriptionPlaylistLockup & { [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 StructuredDescriptionPlaylistLockup & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SubFeedOption.md b/docs/api/namespaces/YTNodes/classes/SubFeedOption.md deleted file mode 100644 index 24ef1fb0..00000000 --- a/docs/api/namespaces/YTNodes/classes/SubFeedOption.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SubFeedOption - -# Class: SubFeedOption - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SubFeedOption() - -> **new SubFeedOption**(`data`): [`SubFeedOption`](SubFeedOption.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SubFeedOption`](SubFeedOption.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SubFeedOption.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubFeedOption.ts#L13) - -## Properties - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SubFeedOption.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubFeedOption.ts#L11) - -*** - -### is\_selected - -> **is\_selected**: `boolean` - -#### Defined in - -[src/parser/classes/SubFeedOption.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubFeedOption.ts#L10) - -*** - -### name - -> **name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SubFeedOption.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubFeedOption.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SubFeedOption'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SubFeedOption.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubFeedOption.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SubFeedOption & { [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 SubFeedOption & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SubscribeButton.md b/docs/api/namespaces/YTNodes/classes/SubscribeButton.md deleted file mode 100644 index c4e6fd45..00000000 --- a/docs/api/namespaces/YTNodes/classes/SubscribeButton.md +++ /dev/null @@ -1,371 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SubscribeButton - -# Class: SubscribeButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SubscribeButton() - -> **new SubscribeButton**(`data`): [`SubscribeButton`](SubscribeButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SubscribeButton`](SubscribeButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L28) - -## Properties - -### button\_text - -> **button\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L10) - -*** - -### channel\_id - -> **channel\_id**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L14) - -*** - -### enabled - -> **enabled**: `boolean` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L12) - -*** - -### item\_type - -> **item\_type**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L13) - -*** - -### notification\_preference\_button - -> **notification\_preference\_button**: `null` \| [`SubscriptionNotificationToggleButton`](SubscriptionNotificationToggleButton.md) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L19) - -*** - -### on\_subscribe\_endpoints? - -> `optional` **on\_subscribe\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L21) - -*** - -### on\_unsubscribe\_endpoints? - -> `optional` **on\_unsubscribe\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L22) - -*** - -### service\_endpoints? - -> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L20) - -*** - -### show\_preferences - -> **show\_preferences**: `boolean` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L15) - -*** - -### subscribe\_accessibility\_label? - -> `optional` **subscribe\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L25) - -*** - -### subscribed - -> **subscribed**: `boolean` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L11) - -*** - -### subscribed\_entity\_key? - -> `optional` **subscribed\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L23) - -*** - -### subscribed\_text? - -> `optional` **subscribed\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L16) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L24) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### unsubscribe\_accessibility\_label? - -> `optional` **unsubscribe\_accessibility\_label**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L26) - -*** - -### unsubscribe\_text? - -> `optional` **unsubscribe\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L18) - -*** - -### unsubscribed\_text? - -> `optional` **unsubscribed\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L17) - -*** - -### type - -> `static` **type**: `string` = `'SubscribeButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButton.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SubscribeButton & { [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 SubscribeButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SubscribeButtonView.md b/docs/api/namespaces/YTNodes/classes/SubscribeButtonView.md deleted file mode 100644 index e9764e0e..00000000 --- a/docs/api/namespaces/YTNodes/classes/SubscribeButtonView.md +++ /dev/null @@ -1,335 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SubscribeButtonView - -# Class: SubscribeButtonView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SubscribeButtonView() - -> **new SubscribeButtonView**(`data`): [`SubscribeButtonView`](SubscribeButtonView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SubscribeButtonView`](SubscribeButtonView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L36) - -## Properties - -### background\_style - -> **background\_style**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L24) - -*** - -### bell\_accessiblity\_data - -> **bell\_accessiblity\_data**: `object` - -#### all\_label - -> **all\_label**: `string` - -#### disabled\_label - -> **disabled\_label**: `string` - -#### occasional\_label - -> **occasional\_label**: `string` - -#### off\_label - -> **off\_label**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L29) - -*** - -### button\_style - -> **button\_style**: `object` - -#### subscribed\_state\_style - -> **subscribed\_state\_style**: `string` - -#### unsubscribed\_state\_style - -> **unsubscribed\_state\_style**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L19) - -*** - -### channel\_id - -> **channel\_id**: `string` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L27) - -*** - -### disable\_notification\_bell - -> **disable\_notification\_bell**: `boolean` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L18) - -*** - -### disable\_subscribe\_button - -> **disable\_subscribe\_button**: `boolean` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L25) - -*** - -### enable\_subscribe\_button\_post\_click\_animation - -> **enable\_subscribe\_button\_post\_click\_animation**: `boolean` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L28) - -*** - -### is\_signed\_out - -> **is\_signed\_out**: `boolean` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L23) - -*** - -### on\_show\_subscription\_options - -> **on\_show\_subscription\_options**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L26) - -*** - -### subscribe\_button\_content - -> **subscribe\_button\_content**: `ButtonContent` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### unsubscribe\_button\_content - -> **unsubscribe\_button\_content**: `ButtonContent` - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L17) - -*** - -### type - -> `static` **type**: `string` = `'SubscribeButtonView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SubscribeButtonView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscribeButtonView.ts#L14) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SubscribeButtonView & { [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 SubscribeButtonView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SubscribeEndpoint.md b/docs/api/namespaces/YTNodes/classes/SubscribeEndpoint.md deleted file mode 100644 index 3ab0efc8..00000000 --- a/docs/api/namespaces/YTNodes/classes/SubscribeEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SubscribeEndpoint - -# Class: SubscribeEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`SubscribeRequest`](../../APIResponseTypes/type-aliases/SubscribeRequest.md)\> - -## Constructors - -### new SubscribeEndpoint() - -> **new SubscribeEndpoint**(`data`): [`SubscribeEndpoint`](SubscribeEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`SubscribeEndpoint`](SubscribeEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/SubscribeEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SubscribeEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SubscribeEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/SubscribeEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SubscribeEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`SubscribeRequest`](../../APIResponseTypes/type-aliases/SubscribeRequest.md) - -#### Returns - -[`SubscribeRequest`](../../APIResponseTypes/type-aliases/SubscribeRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/SubscribeEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SubscribeEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/SubscribeEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/SubscribeEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SubscribeEndpoint & { [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 SubscribeEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md b/docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md deleted file mode 100644 index f3755763..00000000 --- a/docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md +++ /dev/null @@ -1,243 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SubscriptionNotificationToggleButton - -# Class: SubscriptionNotificationToggleButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new SubscriptionNotificationToggleButton() - -> **new SubscriptionNotificationToggleButton**(`data`): [`SubscriptionNotificationToggleButton`](SubscriptionNotificationToggleButton.md) - -#### Parameters - -• **data**: `any` - -#### Returns - -[`SubscriptionNotificationToggleButton`](SubscriptionNotificationToggleButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/SubscriptionNotificationToggleButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscriptionNotificationToggleButton.ts#L16) - -## Properties - -### current\_state\_id - -> **current\_state\_id**: `string` - -#### Defined in - -[src/parser/classes/SubscriptionNotificationToggleButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscriptionNotificationToggleButton.ts#L13) - -*** - -### states - -> **states**: `object` - -#### id - -> **id**: `string` - -#### next\_id - -> **next\_id**: `string` - -#### state - -> **state**: [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/SubscriptionNotificationToggleButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscriptionNotificationToggleButton.ts#L7) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/SubscriptionNotificationToggleButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscriptionNotificationToggleButton.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'SubscriptionNotificationToggleButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/SubscriptionNotificationToggleButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/SubscriptionNotificationToggleButton.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is SubscriptionNotificationToggleButton & { [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 SubscriptionNotificationToggleButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Tab.md b/docs/api/namespaces/YTNodes/classes/Tab.md deleted file mode 100644 index b3965d04..00000000 --- a/docs/api/namespaces/YTNodes/classes/Tab.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Tab - -# Class: Tab - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Tab() - -> **new Tab**(`data`): [`Tab`](Tab.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Tab`](Tab.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Tab.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tab.ts#L16) - -## Properties - -### content - -> **content**: `null` \| [`SectionList`](SectionList.md) \| [`MusicQueue`](MusicQueue.md) \| [`RichGrid`](RichGrid.md) - -#### Defined in - -[src/parser/classes/Tab.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tab.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Tab.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tab.ts#L13) - -*** - -### selected - -> **selected**: `boolean` - -#### Defined in - -[src/parser/classes/Tab.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tab.ts#L12) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/Tab.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tab.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Tab'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Tab.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tab.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Tab & { [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 Tab & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TextCarouselItemView.md b/docs/api/namespaces/YTNodes/classes/TextCarouselItemView.md deleted file mode 100644 index 80f70c00..00000000 --- a/docs/api/namespaces/YTNodes/classes/TextCarouselItemView.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TextCarouselItemView - -# Class: TextCarouselItemView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TextCarouselItemView() - -> **new TextCarouselItemView**(`data`): [`TextCarouselItemView`](TextCarouselItemView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TextCarouselItemView`](TextCarouselItemView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TextCarouselItemView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextCarouselItemView.ts#L15) - -## Properties - -### button - -> **button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/TextCarouselItemView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextCarouselItemView.ts#L13) - -*** - -### icon\_name - -> **icon\_name**: `string` - -#### Defined in - -[src/parser/classes/TextCarouselItemView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextCarouselItemView.ts#L10) - -*** - -### on\_tap\_endpoint - -> **on\_tap\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/TextCarouselItemView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextCarouselItemView.ts#L12) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TextCarouselItemView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextCarouselItemView.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TextCarouselItemView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TextCarouselItemView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextCarouselItemView.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TextCarouselItemView & { [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 TextCarouselItemView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TextFieldView.md b/docs/api/namespaces/YTNodes/classes/TextFieldView.md deleted file mode 100644 index a8650276..00000000 --- a/docs/api/namespaces/YTNodes/classes/TextFieldView.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TextFieldView - -# Class: TextFieldView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TextFieldView() - -> **new TextFieldView**(`data`): [`TextFieldView`](TextFieldView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TextFieldView`](TextFieldView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TextFieldView.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextFieldView.ts#L32) - -## Properties - -### content\_properties? - -> `optional` **content\_properties**: `ContentProperties` - -#### Defined in - -[src/parser/classes/TextFieldView.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextFieldView.ts#L28) - -*** - -### display\_properties? - -> `optional` **display\_properties**: `DisplayProperties` - -#### Defined in - -[src/parser/classes/TextFieldView.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextFieldView.ts#L27) - -*** - -### form\_field\_metadata? - -> `optional` **form\_field\_metadata**: `FormFieldMetadata` - -#### Defined in - -[src/parser/classes/TextFieldView.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextFieldView.ts#L30) - -*** - -### initial\_state? - -> `optional` **initial\_state**: `InitialState` - -#### Defined in - -[src/parser/classes/TextFieldView.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextFieldView.ts#L29) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TextFieldView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TextFieldView.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TextFieldView.ts#L25) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TextFieldView & { [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 TextFieldView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md deleted file mode 100644 index 0d15d62e..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md +++ /dev/null @@ -1,249 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailBadgeView - -# Class: ThumbnailBadgeView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailBadgeView() - -> **new ThumbnailBadgeView**(`data`): [`ThumbnailBadgeView`](ThumbnailBadgeView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailBadgeView`](ThumbnailBadgeView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailBadgeView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBadgeView.ts#L15) - -## Properties - -### background\_color? - -> `optional` **background\_color**: `object` - -#### dark\_theme - -> **dark\_theme**: `number` - -#### light\_theme - -> **light\_theme**: `number` - -#### Defined in - -[src/parser/classes/ThumbnailBadgeView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBadgeView.ts#L10) - -*** - -### badge\_style - -> **badge\_style**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailBadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBadgeView.ts#L9) - -*** - -### icon\_name? - -> `optional` **icon\_name**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailBadgeView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBadgeView.ts#L7) - -*** - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailBadgeView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBadgeView.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailBadgeView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailBadgeView.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBadgeView.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailBadgeView & { [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 ThumbnailBadgeView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md deleted file mode 100644 index e4619c59..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailBottomOverlayView - -# Class: ThumbnailBottomOverlayView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailBottomOverlayView() - -> **new ThumbnailBottomOverlayView**(`data`): [`ThumbnailBottomOverlayView`](ThumbnailBottomOverlayView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailBottomOverlayView`](ThumbnailBottomOverlayView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailBottomOverlayView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBottomOverlayView.ts#L13) - -## Properties - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ThumbnailBadgeView`](ThumbnailBadgeView.md)\> - -#### Defined in - -[src/parser/classes/ThumbnailBottomOverlayView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBottomOverlayView.ts#L11) - -*** - -### progress\_bar - -> **progress\_bar**: `null` \| [`ThumbnailOverlayProgressBarView`](ThumbnailOverlayProgressBarView.md) - -#### Defined in - -[src/parser/classes/ThumbnailBottomOverlayView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBottomOverlayView.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailBottomOverlayView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailBottomOverlayView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailBottomOverlayView.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailBottomOverlayView & { [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 ThumbnailBottomOverlayView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md deleted file mode 100644 index 2008c98d..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailHoverOverlayView - -# Class: ThumbnailHoverOverlayView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailHoverOverlayView() - -> **new ThumbnailHoverOverlayView**(`data`): [`ThumbnailHoverOverlayView`](ThumbnailHoverOverlayView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailHoverOverlayView`](ThumbnailHoverOverlayView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailHoverOverlayView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailHoverOverlayView.ts#L12) - -## Properties - -### icon\_name - -> **icon\_name**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailHoverOverlayView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailHoverOverlayView.ts#L8) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailHoverOverlayView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailHoverOverlayView.ts#L10) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ThumbnailHoverOverlayView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailHoverOverlayView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailHoverOverlayView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailHoverOverlayView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailHoverOverlayView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailHoverOverlayView & { [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 ThumbnailHoverOverlayView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md b/docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md deleted file mode 100644 index 4c581672..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailLandscapePortrait - -# Class: ThumbnailLandscapePortrait - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailLandscapePortrait() - -> **new ThumbnailLandscapePortrait**(`data`): [`ThumbnailLandscapePortrait`](ThumbnailLandscapePortrait.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailLandscapePortrait`](ThumbnailLandscapePortrait.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailLandscapePortrait.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailLandscapePortrait.ts#L11) - -## Properties - -### landscape - -> **landscape**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ThumbnailLandscapePortrait.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailLandscapePortrait.ts#L8) - -*** - -### portrait - -> **portrait**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/ThumbnailLandscapePortrait.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailLandscapePortrait.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailLandscapePortrait'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailLandscapePortrait.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailLandscapePortrait.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailLandscapePortrait & { [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 ThumbnailLandscapePortrait & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md deleted file mode 100644 index 9e6065b4..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayBadgeView - -# Class: ThumbnailOverlayBadgeView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayBadgeView() - -> **new ThumbnailOverlayBadgeView**(`data`): [`ThumbnailOverlayBadgeView`](ThumbnailOverlayBadgeView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayBadgeView`](ThumbnailOverlayBadgeView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBadgeView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBadgeView.ts#L12) - -## Properties - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ThumbnailBadgeView`](ThumbnailBadgeView.md)\> - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBadgeView.ts#L9) - -*** - -### position - -> **position**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBadgeView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBadgeView.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayBadgeView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBadgeView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBadgeView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayBadgeView & { [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 ThumbnailOverlayBadgeView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md deleted file mode 100644 index a29a44ac..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayBottomPanel - -# Class: ThumbnailOverlayBottomPanel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayBottomPanel() - -> **new ThumbnailOverlayBottomPanel**(`data`): [`ThumbnailOverlayBottomPanel`](ThumbnailOverlayBottomPanel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayBottomPanel`](ThumbnailOverlayBottomPanel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L11) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L9) - -*** - -### text? - -> `optional` **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayBottomPanel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayBottomPanel & { [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 ThumbnailOverlayBottomPanel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md deleted file mode 100644 index 484f89c2..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayEndorsement - -# Class: ThumbnailOverlayEndorsement - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayEndorsement() - -> **new ThumbnailOverlayEndorsement**(`data`): [`ThumbnailOverlayEndorsement`](ThumbnailOverlayEndorsement.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayEndorsement`](ThumbnailOverlayEndorsement.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayEndorsement.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayEndorsement.ts#L10) - -## Properties - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayEndorsement.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayEndorsement.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayEndorsement'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayEndorsement.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayEndorsement.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayEndorsement & { [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 ThumbnailOverlayEndorsement & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md deleted file mode 100644 index f7e78cdc..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayHoverText - -# Class: ThumbnailOverlayHoverText - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayHoverText() - -> **new ThumbnailOverlayHoverText**(`data`): [`ThumbnailOverlayHoverText`](ThumbnailOverlayHoverText.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayHoverText`](ThumbnailOverlayHoverText.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayHoverText.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayHoverText.ts#L11) - -## Properties - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayHoverText.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayHoverText.ts#L9) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayHoverText.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayHoverText.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayHoverText'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayHoverText.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayHoverText.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayHoverText & { [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 ThumbnailOverlayHoverText & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md deleted file mode 100644 index c2530e13..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayInlineUnplayable - -# Class: ThumbnailOverlayInlineUnplayable - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayInlineUnplayable() - -> **new ThumbnailOverlayInlineUnplayable**(`data`): [`ThumbnailOverlayInlineUnplayable`](ThumbnailOverlayInlineUnplayable.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayInlineUnplayable`](ThumbnailOverlayInlineUnplayable.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L11) - -## Properties - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L9) - -*** - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayInlineUnplayable'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayInlineUnplayable & { [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 ThumbnailOverlayInlineUnplayable & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md deleted file mode 100644 index 62e4f1e9..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayLoadingPreview - -# Class: ThumbnailOverlayLoadingPreview - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayLoadingPreview() - -> **new ThumbnailOverlayLoadingPreview**(`data`): [`ThumbnailOverlayLoadingPreview`](ThumbnailOverlayLoadingPreview.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayLoadingPreview`](ThumbnailOverlayLoadingPreview.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L10) - -## Properties - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayLoadingPreview'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayLoadingPreview & { [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 ThumbnailOverlayLoadingPreview & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md deleted file mode 100644 index 10caa005..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayNowPlaying - -# Class: ThumbnailOverlayNowPlaying - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayNowPlaying() - -> **new ThumbnailOverlayNowPlaying**(`data`): [`ThumbnailOverlayNowPlaying`](ThumbnailOverlayNowPlaying.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayNowPlaying`](ThumbnailOverlayNowPlaying.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayNowPlaying.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L10) - -## Properties - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayNowPlaying.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayNowPlaying'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayNowPlaying.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayNowPlaying & { [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 ThumbnailOverlayNowPlaying & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md deleted file mode 100644 index 0e60d249..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayPlaybackStatus - -# Class: ThumbnailOverlayPlaybackStatus - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayPlaybackStatus() - -> **new ThumbnailOverlayPlaybackStatus**(`data`): [`ThumbnailOverlayPlaybackStatus`](ThumbnailOverlayPlaybackStatus.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayPlaybackStatus`](ThumbnailOverlayPlaybackStatus.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L10) - -## Properties - -### texts - -> **texts**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayPlaybackStatus'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayPlaybackStatus & { [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 ThumbnailOverlayPlaybackStatus & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md deleted file mode 100644 index 241bc886..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayProgressBarView - -# Class: ThumbnailOverlayProgressBarView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayProgressBarView() - -> **new ThumbnailOverlayProgressBarView**(`data`): [`ThumbnailOverlayProgressBarView`](ThumbnailOverlayProgressBarView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayProgressBarView`](ThumbnailOverlayProgressBarView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayProgressBarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayProgressBarView.ts#L9) - -## Properties - -### start\_percent - -> **start\_percent**: `number` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayProgressBarView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayProgressBarView.ts#L7) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayProgressBarView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayProgressBarView.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayProgressBarView.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayProgressBarView & { [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 ThumbnailOverlayProgressBarView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md deleted file mode 100644 index bcc9d269..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlaySidePanel - -# Class: ThumbnailOverlaySidePanel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlaySidePanel() - -> **new ThumbnailOverlaySidePanel**(`data`): [`ThumbnailOverlaySidePanel`](ThumbnailOverlaySidePanel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlaySidePanel`](ThumbnailOverlaySidePanel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlaySidePanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlaySidePanel.ts#L11) - -## Properties - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlaySidePanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlaySidePanel.ts#L9) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ThumbnailOverlaySidePanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlaySidePanel.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlaySidePanel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlaySidePanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlaySidePanel.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlaySidePanel & { [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 ThumbnailOverlaySidePanel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md deleted file mode 100644 index 605bb7ef..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayTimeStatus - -# Class: ThumbnailOverlayTimeStatus - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayTimeStatus() - -> **new ThumbnailOverlayTimeStatus**(`data`): [`ThumbnailOverlayTimeStatus`](ThumbnailOverlayTimeStatus.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayTimeStatus`](ThumbnailOverlayTimeStatus.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L11) - -## Properties - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L9) - -*** - -### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayTimeStatus'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayTimeStatus & { [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 ThumbnailOverlayTimeStatus & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md deleted file mode 100644 index 99bc7b2f..00000000 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md +++ /dev/null @@ -1,267 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayToggleButton - -# Class: ThumbnailOverlayToggleButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ThumbnailOverlayToggleButton() - -> **new ThumbnailOverlayToggleButton**(`data`): [`ThumbnailOverlayToggleButton`](ThumbnailOverlayToggleButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ThumbnailOverlayToggleButton`](ThumbnailOverlayToggleButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayToggleButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayToggleButton.ts#L23) - -## Properties - -### icon\_type - -> **icon\_type**: `object` - -#### toggled - -> **toggled**: `string` - -#### untoggled - -> **untoggled**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayToggleButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayToggleButton.ts#L10) - -*** - -### is\_toggled? - -> `optional` **is\_toggled**: `boolean` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayToggleButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayToggleButton.ts#L8) - -*** - -### toggled\_endpoint? - -> `optional` **toggled\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayToggleButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayToggleButton.ts#L20) - -*** - -### tooltip - -> **tooltip**: `object` - -#### toggled - -> **toggled**: `string` - -#### untoggled - -> **untoggled**: `string` - -#### Defined in - -[src/parser/classes/ThumbnailOverlayToggleButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayToggleButton.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### untoggled\_endpoint? - -> `optional` **untoggled\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayToggleButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayToggleButton.ts#L21) - -*** - -### type - -> `static` **type**: `string` = `'ThumbnailOverlayToggleButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ThumbnailOverlayToggleButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ThumbnailOverlayToggleButton.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayToggleButton & { [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 ThumbnailOverlayToggleButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md b/docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md deleted file mode 100644 index ff78c0c3..00000000 --- a/docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TimedMarkerDecoration - -# Class: TimedMarkerDecoration - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TimedMarkerDecoration() - -> **new TimedMarkerDecoration**(`data`): [`TimedMarkerDecoration`](TimedMarkerDecoration.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TimedMarkerDecoration`](TimedMarkerDecoration.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TimedMarkerDecoration.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TimedMarkerDecoration.ts#L14) - -## Properties - -### decoration\_time\_millis - -> **decoration\_time\_millis**: `number` - -#### Defined in - -[src/parser/classes/TimedMarkerDecoration.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TimedMarkerDecoration.ts#L10) - -*** - -### icon - -> **icon**: `string` - -#### Defined in - -[src/parser/classes/TimedMarkerDecoration.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TimedMarkerDecoration.ts#L12) - -*** - -### label - -> **label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TimedMarkerDecoration.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TimedMarkerDecoration.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### visible\_time\_range\_end\_millis - -> **visible\_time\_range\_end\_millis**: `number` - -#### Defined in - -[src/parser/classes/TimedMarkerDecoration.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TimedMarkerDecoration.ts#L9) - -*** - -### visible\_time\_range\_start\_millis - -> **visible\_time\_range\_start\_millis**: `number` - -#### Defined in - -[src/parser/classes/TimedMarkerDecoration.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TimedMarkerDecoration.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TimedMarkerDecoration'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TimedMarkerDecoration.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TimedMarkerDecoration.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TimedMarkerDecoration & { [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 TimedMarkerDecoration & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ToggleButton.md b/docs/api/namespaces/YTNodes/classes/ToggleButton.md deleted file mode 100644 index a808f34f..00000000 --- a/docs/api/namespaces/YTNodes/classes/ToggleButton.md +++ /dev/null @@ -1,331 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ToggleButton - -# Class: ToggleButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ToggleButton() - -> **new ToggleButton**(`data`): [`ToggleButton`](ToggleButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ToggleButton`](ToggleButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ToggleButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L23) - -## Properties - -### button\_id? - -> `optional` **button\_id**: `string` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L20) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ToggleButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L18) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L15) - -*** - -### is\_disabled - -> **is\_disabled**: `boolean` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L14) - -*** - -### is\_toggled - -> **is\_toggled**: `boolean` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L13) - -*** - -### like\_count? - -> `optional` **like\_count**: `number` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L16) - -*** - -### short\_like\_count? - -> `optional` **short\_like\_count**: `string` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L17) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L21) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ToggleButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L9) - -*** - -### toggled\_endpoint - -> **toggled\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ToggleButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L19) - -*** - -### toggled\_text - -> **toggled\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ToggleButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L10) - -*** - -### toggled\_tooltip - -> **toggled\_tooltip**: `string` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L12) - -*** - -### tooltip - -> **tooltip**: `string` - -#### Defined in - -[src/parser/classes/ToggleButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ToggleButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ToggleButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButton.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ToggleButton & { [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 ToggleButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ToggleButtonView.md b/docs/api/namespaces/YTNodes/classes/ToggleButtonView.md deleted file mode 100644 index ea080ded..00000000 --- a/docs/api/namespaces/YTNodes/classes/ToggleButtonView.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ToggleButtonView - -# Class: ToggleButtonView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ToggleButtonView() - -> **new ToggleButtonView**(`data`): [`ToggleButtonView`](ToggleButtonView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ToggleButtonView`](ToggleButtonView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ToggleButtonView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButtonView.ts#L14) - -## Properties - -### default\_button - -> **default\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/ToggleButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButtonView.ts#L8) - -*** - -### identifier? - -> `optional` **identifier**: `string` - -#### Defined in - -[src/parser/classes/ToggleButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButtonView.ts#L11) - -*** - -### is\_toggled? - -> `optional` **is\_toggled**: `boolean` - -#### Defined in - -[src/parser/classes/ToggleButtonView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButtonView.ts#L12) - -*** - -### is\_toggling\_disabled - -> **is\_toggling\_disabled**: `boolean` - -#### Defined in - -[src/parser/classes/ToggleButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButtonView.ts#L10) - -*** - -### toggled\_button - -> **toggled\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/ToggleButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButtonView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ToggleButtonView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ToggleButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleButtonView.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ToggleButtonView & { [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 ToggleButtonView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ToggleFormField.md b/docs/api/namespaces/YTNodes/classes/ToggleFormField.md deleted file mode 100644 index d2ec34da..00000000 --- a/docs/api/namespaces/YTNodes/classes/ToggleFormField.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ToggleFormField - -# Class: ToggleFormField - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ToggleFormField() - -> **new ToggleFormField**(`data`): [`ToggleFormField`](ToggleFormField.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ToggleFormField`](ToggleFormField.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ToggleFormField.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleFormField.ts#L13) - -## Properties - -### label - -> **label**: `Text` - -#### Defined in - -[src/parser/classes/ToggleFormField.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleFormField.ts#L8) - -*** - -### toggle\_off\_action? - -> `optional` **toggle\_off\_action**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ToggleFormField.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleFormField.ts#L11) - -*** - -### toggle\_on\_action? - -> `optional` **toggle\_on\_action**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ToggleFormField.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleFormField.ts#L10) - -*** - -### toggled - -> **toggled**: `boolean` - -#### Defined in - -[src/parser/classes/ToggleFormField.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleFormField.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ToggleFormField'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ToggleFormField.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleFormField.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ToggleFormField & { [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 ToggleFormField & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md b/docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md deleted file mode 100644 index 1902b064..00000000 --- a/docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ToggleMenuServiceItem - -# Class: ToggleMenuServiceItem - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ToggleMenuServiceItem() - -> **new ToggleMenuServiceItem**(`data`): [`ToggleMenuServiceItem`](ToggleMenuServiceItem.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ToggleMenuServiceItem`](ToggleMenuServiceItem.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L16) - -## Properties - -### default\_endpoint - -> **default\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L13) - -*** - -### icon\_type - -> **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L11) - -*** - -### text - -> **text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L9) - -*** - -### toggled\_endpoint - -> **toggled\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L14) - -*** - -### toggled\_icon\_type - -> **toggled\_icon\_type**: `string` - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L12) - -*** - -### toggled\_text - -> **toggled\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'ToggleMenuServiceItem'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ToggleMenuServiceItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ToggleMenuServiceItem.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ToggleMenuServiceItem & { [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 ToggleMenuServiceItem & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Tooltip.md b/docs/api/namespaces/YTNodes/classes/Tooltip.md deleted file mode 100644 index 1a065597..00000000 --- a/docs/api/namespaces/YTNodes/classes/Tooltip.md +++ /dev/null @@ -1,277 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Tooltip - -# Class: Tooltip - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new Tooltip() - -> **new Tooltip**(`data`): [`Tooltip`](Tooltip.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Tooltip`](Tooltip.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Tooltip.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L22) - -## Properties - -### details - -> **details**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Tooltip.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L17) - -*** - -### dismiss\_stratedy - -> **dismiss\_stratedy**: `string` - -#### Defined in - -[src/parser/classes/Tooltip.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L19) - -*** - -### dwell\_time\_ms - -> **dwell\_time\_ms**: `number` - -#### Defined in - -[src/parser/classes/Tooltip.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L20) - -*** - -### promo\_config - -> **promo\_config**: `object` - -#### accept - -> **accept**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### dismiss - -> **dismiss**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### impression\_endpoints - -> **impression\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### promo\_id - -> **promo\_id**: `string` - -#### Defined in - -[src/parser/classes/Tooltip.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L9) - -*** - -### suggested\_position - -> **suggested\_position**: `string` - -#### Defined in - -[src/parser/classes/Tooltip.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L18) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/Tooltip.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L16) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'Tooltip'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Tooltip.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Tooltip.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Tooltip & { [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 Tooltip & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TopbarMenuButton.md b/docs/api/namespaces/YTNodes/classes/TopbarMenuButton.md deleted file mode 100644 index 572a3d0a..00000000 --- a/docs/api/namespaces/YTNodes/classes/TopbarMenuButton.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TopbarMenuButton - -# Class: TopbarMenuButton - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TopbarMenuButton() - -> **new TopbarMenuButton**(`data`): [`TopbarMenuButton`](TopbarMenuButton.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TopbarMenuButton`](TopbarMenuButton.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/mweb/TopbarMenuButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/TopbarMenuButton.ts#L11) - -## Properties - -### icon\_type? - -> `optional` **icon\_type**: `string` - -#### Defined in - -[src/parser/classes/mweb/TopbarMenuButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/TopbarMenuButton.ts#L7) - -*** - -### menu\_renderer - -> **menu\_renderer**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/mweb/TopbarMenuButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/TopbarMenuButton.ts#L8) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/mweb/TopbarMenuButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/TopbarMenuButton.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TopbarMenuButton'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/mweb/TopbarMenuButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/mweb/TopbarMenuButton.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TopbarMenuButton & { [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 TopbarMenuButton & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md b/docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md deleted file mode 100644 index bc458c22..00000000 --- a/docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TopicChannelDetails - -# Class: TopicChannelDetails - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TopicChannelDetails() - -> **new TopicChannelDetails**(`data`): [`TopicChannelDetails`](TopicChannelDetails.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TopicChannelDetails`](TopicChannelDetails.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TopicChannelDetails.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TopicChannelDetails.ts#L17) - -## Properties - -### avatar - -> **avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/TopicChannelDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TopicChannelDetails.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/TopicChannelDetails.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TopicChannelDetails.ts#L15) - -*** - -### subscribe\_button - -> **subscribe\_button**: `null` \| [`SubscribeButton`](SubscribeButton.md) - -#### Defined in - -[src/parser/classes/TopicChannelDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TopicChannelDetails.ts#L14) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TopicChannelDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TopicChannelDetails.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TopicChannelDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TopicChannelDetails.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TopicChannelDetails'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TopicChannelDetails.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TopicChannelDetails.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TopicChannelDetails & { [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 TopicChannelDetails & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptFooter.md b/docs/api/namespaces/YTNodes/classes/TranscriptFooter.md deleted file mode 100644 index 04461340..00000000 --- a/docs/api/namespaces/YTNodes/classes/TranscriptFooter.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TranscriptFooter - -# Class: TranscriptFooter - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TranscriptFooter() - -> **new TranscriptFooter**(`data`): [`TranscriptFooter`](TranscriptFooter.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TranscriptFooter`](TranscriptFooter.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TranscriptFooter.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptFooter.ts#L11) - -## Properties - -### language\_menu - -> **language\_menu**: `null` \| [`SortFilterSubMenu`](SortFilterSubMenu.md) - -#### Defined in - -[src/parser/classes/TranscriptFooter.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptFooter.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TranscriptFooter'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TranscriptFooter.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptFooter.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TranscriptFooter & { [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 TranscriptFooter & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md b/docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md deleted file mode 100644 index dbebf1a1..00000000 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TranscriptSearchBox - -# Class: TranscriptSearchBox - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TranscriptSearchBox() - -> **new TranscriptSearchBox**(`data`): [`TranscriptSearchBox`](TranscriptSearchBox.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TranscriptSearchBox`](TranscriptSearchBox.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TranscriptSearchBox.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchBox.ts#L16) - -## Properties - -### clear\_button - -> **clear\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/TranscriptSearchBox.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchBox.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/TranscriptSearchBox.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchBox.ts#L13) - -*** - -### formatted\_placeholder - -> **formatted\_placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TranscriptSearchBox.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchBox.ts#L11) - -*** - -### search\_button - -> **search\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/TranscriptSearchBox.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchBox.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TranscriptSearchBox'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TranscriptSearchBox.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchBox.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TranscriptSearchBox & { [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 TranscriptSearchBox & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md b/docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md deleted file mode 100644 index 89247b43..00000000 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TranscriptSearchPanel - -# Class: TranscriptSearchPanel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TranscriptSearchPanel() - -> **new TranscriptSearchPanel**(`data`): [`TranscriptSearchPanel`](TranscriptSearchPanel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TranscriptSearchPanel`](TranscriptSearchPanel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TranscriptSearchPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchPanel.ts#L16) - -## Properties - -### body - -> **body**: `null` \| [`TranscriptSegmentList`](TranscriptSegmentList.md) - -#### Defined in - -[src/parser/classes/TranscriptSearchPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchPanel.ts#L12) - -*** - -### footer - -> **footer**: `null` \| [`TranscriptFooter`](TranscriptFooter.md) - -#### Defined in - -[src/parser/classes/TranscriptSearchPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchPanel.ts#L13) - -*** - -### header - -> **header**: `null` \| [`TranscriptSearchBox`](TranscriptSearchBox.md) - -#### Defined in - -[src/parser/classes/TranscriptSearchPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchPanel.ts#L11) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/TranscriptSearchPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchPanel.ts#L14) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TranscriptSearchPanel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TranscriptSearchPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSearchPanel.ts#L9) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TranscriptSearchPanel & { [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 TranscriptSearchPanel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md b/docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md deleted file mode 100644 index 6b0204df..00000000 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TranscriptSectionHeader - -# Class: TranscriptSectionHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TranscriptSectionHeader() - -> **new TranscriptSectionHeader**(`data`): [`TranscriptSectionHeader`](TranscriptSectionHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TranscriptSectionHeader`](TranscriptSectionHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TranscriptSectionHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSectionHeader.ts#L12) - -## Properties - -### end\_ms - -> **end\_ms**: `string` - -#### Defined in - -[src/parser/classes/TranscriptSectionHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSectionHeader.ts#L9) - -*** - -### snippet - -> **snippet**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TranscriptSectionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSectionHeader.ts#L10) - -*** - -### start\_ms - -> **start\_ms**: `string` - -#### Defined in - -[src/parser/classes/TranscriptSectionHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSectionHeader.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TranscriptSectionHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TranscriptSectionHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSectionHeader.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TranscriptSectionHeader & { [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 TranscriptSectionHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSegment.md b/docs/api/namespaces/YTNodes/classes/TranscriptSegment.md deleted file mode 100644 index ee7e70b2..00000000 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSegment.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TranscriptSegment - -# Class: TranscriptSegment - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TranscriptSegment() - -> **new TranscriptSegment**(`data`): [`TranscriptSegment`](TranscriptSegment.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TranscriptSegment`](TranscriptSegment.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TranscriptSegment.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegment.ts#L14) - -## Properties - -### end\_ms - -> **end\_ms**: `string` - -#### Defined in - -[src/parser/classes/TranscriptSegment.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegment.ts#L9) - -*** - -### snippet - -> **snippet**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TranscriptSegment.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegment.ts#L10) - -*** - -### start\_ms - -> **start\_ms**: `string` - -#### Defined in - -[src/parser/classes/TranscriptSegment.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegment.ts#L8) - -*** - -### start\_time\_text - -> **start\_time\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TranscriptSegment.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegment.ts#L11) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/TranscriptSegment.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegment.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TranscriptSegment'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TranscriptSegment.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegment.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TranscriptSegment & { [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 TranscriptSegment & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md b/docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md deleted file mode 100644 index 68449a56..00000000 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TranscriptSegmentList - -# Class: TranscriptSegmentList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TranscriptSegmentList() - -> **new TranscriptSegmentList**(`data`): [`TranscriptSegmentList`](TranscriptSegmentList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TranscriptSegmentList`](TranscriptSegmentList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TranscriptSegmentList.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegmentList.ts#L17) - -## Properties - -### initial\_segments - -> **initial\_segments**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`TranscriptSectionHeader`](TranscriptSectionHeader.md) \| [`TranscriptSegment`](TranscriptSegment.md)\> - -#### Defined in - -[src/parser/classes/TranscriptSegmentList.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegmentList.ts#L12) - -*** - -### no\_result\_label - -> **no\_result\_label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TranscriptSegmentList.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegmentList.ts#L13) - -*** - -### retry\_label - -> **retry\_label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/TranscriptSegmentList.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegmentList.ts#L14) - -*** - -### touch\_captions\_enabled - -> **touch\_captions\_enabled**: `boolean` - -#### Defined in - -[src/parser/classes/TranscriptSegmentList.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegmentList.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TranscriptSegmentList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TranscriptSegmentList.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TranscriptSegmentList.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TranscriptSegmentList & { [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 TranscriptSegmentList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md b/docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md deleted file mode 100644 index 18afe23a..00000000 --- a/docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md +++ /dev/null @@ -1,225 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TwoColumnBrowseResults - -# Class: TwoColumnBrowseResults - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`WatchNextTabbedResults`](WatchNextTabbedResults.md) - -## Constructors - -### new TwoColumnBrowseResults() - -> **new TwoColumnBrowseResults**(`data`): [`TwoColumnBrowseResults`](TwoColumnBrowseResults.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TwoColumnBrowseResults`](TwoColumnBrowseResults.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TwoColumnBrowseResults.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnBrowseResults.ts#L16) - -## Properties - -### secondary\_contents - -> **secondary\_contents**: `null` \| [`SectionList`](SectionList.md) \| [`BrowseFeedActions`](BrowseFeedActions.md) \| [`ProfileColumn`](ProfileColumn.md) - -#### Defined in - -[src/parser/classes/TwoColumnBrowseResults.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnBrowseResults.ts#L14) - -*** - -### tabs - -> **tabs**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Tab`](Tab.md) \| [`ExpandableTab`](ExpandableTab.md)\> - -#### Defined in - -[src/parser/classes/TwoColumnBrowseResults.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnBrowseResults.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TwoColumnBrowseResults'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TwoColumnBrowseResults.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnBrowseResults.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TwoColumnBrowseResults & { [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 TwoColumnBrowseResults & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md b/docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md deleted file mode 100644 index ea3a4197..00000000 --- a/docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / TwoColumnSearchResults - -# Class: TwoColumnSearchResults - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new TwoColumnSearchResults() - -> **new TwoColumnSearchResults**(`data`): [`TwoColumnSearchResults`](TwoColumnSearchResults.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`TwoColumnSearchResults`](TwoColumnSearchResults.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/TwoColumnSearchResults.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnSearchResults.ts#L15) - -## Properties - -### header - -> **header**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/TwoColumnSearchResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnSearchResults.ts#L10) - -*** - -### primary\_contents - -> **primary\_contents**: `null` \| [`SectionList`](SectionList.md) \| [`RichGrid`](RichGrid.md) - -#### Defined in - -[src/parser/classes/TwoColumnSearchResults.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnSearchResults.ts#L11) - -*** - -### secondary\_contents - -> **secondary\_contents**: `null` \| [`SecondarySearchContainer`](SecondarySearchContainer.md) - -#### Defined in - -[src/parser/classes/TwoColumnSearchResults.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnSearchResults.ts#L12) - -*** - -### target\_id? - -> `optional` **target\_id**: `string` - -#### Defined in - -[src/parser/classes/TwoColumnSearchResults.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnSearchResults.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'TwoColumnSearchResults'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/TwoColumnSearchResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/TwoColumnSearchResults.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is TwoColumnSearchResults & { [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 TwoColumnSearchResults & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UnifiedSharePanel.md b/docs/api/namespaces/YTNodes/classes/UnifiedSharePanel.md deleted file mode 100644 index 7b54ab38..00000000 --- a/docs/api/namespaces/YTNodes/classes/UnifiedSharePanel.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UnifiedSharePanel - -# Class: UnifiedSharePanel - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UnifiedSharePanel() - -> **new UnifiedSharePanel**(`data`): [`UnifiedSharePanel`](UnifiedSharePanel.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UnifiedSharePanel`](UnifiedSharePanel.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/UnifiedSharePanel.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UnifiedSharePanel.ts#L23) - -## Properties - -### header - -> **header**: `null` \| [`SharePanelHeader`](SharePanelHeader.md) - -#### Defined in - -[src/parser/classes/UnifiedSharePanel.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UnifiedSharePanel.ts#L19) - -*** - -### share\_panel\_version - -> **share\_panel\_version**: `number` - -#### Defined in - -[src/parser/classes/UnifiedSharePanel.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UnifiedSharePanel.ts#L20) - -*** - -### show\_loading\_spinner? - -> `optional` **show\_loading\_spinner**: `boolean` - -#### Defined in - -[src/parser/classes/UnifiedSharePanel.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UnifiedSharePanel.ts#L21) - -*** - -### third\_party\_network\_section? - -> `optional` **third\_party\_network\_section**: `ThirdPartyNetworkSection` - -#### Defined in - -[src/parser/classes/UnifiedSharePanel.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UnifiedSharePanel.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UnifiedSharePanel'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/UnifiedSharePanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UnifiedSharePanel.ts#L16) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UnifiedSharePanel & { [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 UnifiedSharePanel & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md b/docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md deleted file mode 100644 index bb3973e1..00000000 --- a/docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UniversalWatchCard - -# Class: UniversalWatchCard - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UniversalWatchCard() - -> **new UniversalWatchCard**(`data`): [`UniversalWatchCard`](UniversalWatchCard.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UniversalWatchCard`](UniversalWatchCard.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/UniversalWatchCard.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UniversalWatchCard.ts#L13) - -## Properties - -### call\_to\_action - -> **call\_to\_action**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/UniversalWatchCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UniversalWatchCard.ts#L9) - -*** - -### collapsed\_label? - -> `optional` **collapsed\_label**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/UniversalWatchCard.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UniversalWatchCard.ts#L11) - -*** - -### header - -> **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/UniversalWatchCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UniversalWatchCard.ts#L8) - -*** - -### sections - -> **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/UniversalWatchCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UniversalWatchCard.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UniversalWatchCard'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/UniversalWatchCard.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UniversalWatchCard.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UniversalWatchCard & { [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 UniversalWatchCard & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UnsubscribeEndpoint.md b/docs/api/namespaces/YTNodes/classes/UnsubscribeEndpoint.md deleted file mode 100644 index 75890f10..00000000 --- a/docs/api/namespaces/YTNodes/classes/UnsubscribeEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UnsubscribeEndpoint - -# Class: UnsubscribeEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`UnsubscribeRequest`](../../APIResponseTypes/type-aliases/UnsubscribeRequest.md)\> - -## Constructors - -### new UnsubscribeEndpoint() - -> **new UnsubscribeEndpoint**(`data`): [`UnsubscribeEndpoint`](UnsubscribeEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UnsubscribeEndpoint`](UnsubscribeEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/UnsubscribeEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/UnsubscribeEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UnsubscribeEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/UnsubscribeEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/UnsubscribeEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`UnsubscribeRequest`](../../APIResponseTypes/type-aliases/UnsubscribeRequest.md) - -#### Returns - -[`UnsubscribeRequest`](../../APIResponseTypes/type-aliases/UnsubscribeRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/UnsubscribeEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/UnsubscribeEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/UnsubscribeEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/UnsubscribeEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UnsubscribeEndpoint & { [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 UnsubscribeEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateChannelSwitcherPageAction.md b/docs/api/namespaces/YTNodes/classes/UpdateChannelSwitcherPageAction.md deleted file mode 100644 index 390ed46b..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateChannelSwitcherPageAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateChannelSwitcherPageAction - -# Class: UpdateChannelSwitcherPageAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateChannelSwitcherPageAction() - -> **new UpdateChannelSwitcherPageAction**(`data`): [`UpdateChannelSwitcherPageAction`](UpdateChannelSwitcherPageAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateChannelSwitcherPageAction`](UpdateChannelSwitcherPageAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts#L12) - -## Properties - -### contents? - -> `optional` **contents**: `null` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts#L10) - -*** - -### header? - -> `optional` **header**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateChannelSwitcherPageAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateChannelSwitcherPageAction.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateChannelSwitcherPageAction & { [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 UpdateChannelSwitcherPageAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md b/docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md deleted file mode 100644 index f62890fc..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateDateTextAction - -# Class: UpdateDateTextAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateDateTextAction() - -> **new UpdateDateTextAction**(`data`): [`UpdateDateTextAction`](UpdateDateTextAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateDateTextAction`](UpdateDateTextAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/UpdateDateTextAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateDateTextAction.ts#L10) - -## Properties - -### date\_text - -> **date\_text**: `string` - -#### Defined in - -[src/parser/classes/livechat/UpdateDateTextAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateDateTextAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateDateTextAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/UpdateDateTextAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateDateTextAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateDateTextAction & { [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 UpdateDateTextAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md b/docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md deleted file mode 100644 index fb9061d0..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateDescriptionAction - -# Class: UpdateDescriptionAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateDescriptionAction() - -> **new UpdateDescriptionAction**(`data`): [`UpdateDescriptionAction`](UpdateDescriptionAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateDescriptionAction`](UpdateDescriptionAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/UpdateDescriptionAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateDescriptionAction.ts#L10) - -## Properties - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/UpdateDescriptionAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateDescriptionAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateDescriptionAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/UpdateDescriptionAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateDescriptionAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateDescriptionAction & { [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 UpdateDescriptionAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md b/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md deleted file mode 100644 index 6bd9aeba..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateEngagementPanelAction - -# Class: UpdateEngagementPanelAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateEngagementPanelAction() - -> **new UpdateEngagementPanelAction**(`data`): [`UpdateEngagementPanelAction`](UpdateEngagementPanelAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateEngagementPanelAction`](UpdateEngagementPanelAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L12) - -## Properties - -### content - -> **content**: `null` \| [`Transcript`](Transcript.md) - -#### Defined in - -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L10) - -*** - -### target\_id - -> **target\_id**: `string` - -#### Defined in - -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateEngagementPanelAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateEngagementPanelAction & { [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 UpdateEngagementPanelAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md b/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md deleted file mode 100644 index 8493a080..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateEngagementPanelContentCommand - -# Class: UpdateEngagementPanelContentCommand - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateEngagementPanelContentCommand() - -> **new UpdateEngagementPanelContentCommand**(`data`): [`UpdateEngagementPanelContentCommand`](UpdateEngagementPanelContentCommand.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateEngagementPanelContentCommand`](UpdateEngagementPanelContentCommand.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L15) - -## Properties - -### content\_source\_panel\_identifier? - -> `optional` **content\_source\_panel\_identifier**: `Identifier` - -#### Defined in - -[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L12) - -*** - -### target\_panel\_identifier? - -> `optional` **target\_panel\_identifier**: `Identifier` - -#### Defined in - -[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateEngagementPanelContentCommand'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateEngagementPanelContentCommand & { [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 UpdateEngagementPanelContentCommand & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md b/docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md deleted file mode 100644 index 21a10e56..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md +++ /dev/null @@ -1,211 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateLiveChatPollAction - -# Class: UpdateLiveChatPollAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateLiveChatPollAction() - -> **new UpdateLiveChatPollAction**(`data`): [`UpdateLiveChatPollAction`](UpdateLiveChatPollAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateLiveChatPollAction`](UpdateLiveChatPollAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L10) - -## Properties - -### poll\_to\_update - -> **poll\_to\_update**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateLiveChatPollAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateLiveChatPollAction & { [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 UpdateLiveChatPollAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateSubscribeButtonAction.md b/docs/api/namespaces/YTNodes/classes/UpdateSubscribeButtonAction.md deleted file mode 100644 index 50eaa4eb..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateSubscribeButtonAction.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateSubscribeButtonAction - -# Class: UpdateSubscribeButtonAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateSubscribeButtonAction() - -> **new UpdateSubscribeButtonAction**(`data`): [`UpdateSubscribeButtonAction`](UpdateSubscribeButtonAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateSubscribeButtonAction`](UpdateSubscribeButtonAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/actions/UpdateSubscribeButtonAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateSubscribeButtonAction.ts#L10) - -## Properties - -### channel\_id - -> **channel\_id**: `string` - -#### Defined in - -[src/parser/classes/actions/UpdateSubscribeButtonAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateSubscribeButtonAction.ts#L7) - -*** - -### subscribed - -> **subscribed**: `boolean` - -#### Defined in - -[src/parser/classes/actions/UpdateSubscribeButtonAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateSubscribeButtonAction.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateSubscribeButtonAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/actions/UpdateSubscribeButtonAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/actions/UpdateSubscribeButtonAction.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateSubscribeButtonAction & { [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 UpdateSubscribeButtonAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md b/docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md deleted file mode 100644 index 3b298e72..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateToggleButtonTextAction - -# Class: UpdateToggleButtonTextAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateToggleButtonTextAction() - -> **new UpdateToggleButtonTextAction**(`data`): [`UpdateToggleButtonTextAction`](UpdateToggleButtonTextAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateToggleButtonTextAction`](UpdateToggleButtonTextAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L12) - -## Properties - -### button\_id - -> **button\_id**: `string` - -#### Defined in - -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L10) - -*** - -### default\_text - -> **default\_text**: `string` - -#### Defined in - -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L8) - -*** - -### toggled\_text - -> **toggled\_text**: `string` - -#### Defined in - -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateToggleButtonTextAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateToggleButtonTextAction & { [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 UpdateToggleButtonTextAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md b/docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md deleted file mode 100644 index ff3204a6..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateViewershipAction - -# Class: UpdateViewershipAction - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpdateViewershipAction() - -> **new UpdateViewershipAction**(`data`): [`UpdateViewershipAction`](UpdateViewershipAction.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpdateViewershipAction`](UpdateViewershipAction.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/livechat/UpdateViewershipAction.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateViewershipAction.ts#L14) - -## Properties - -### extra\_short\_view\_count - -> **extra\_short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/UpdateViewershipAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateViewershipAction.ts#L9) - -*** - -### is\_live - -> **is\_live**: `boolean` - -#### Defined in - -[src/parser/classes/livechat/UpdateViewershipAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateViewershipAction.ts#L12) - -*** - -### original\_view\_count - -> **original\_view\_count**: `number` - -#### Defined in - -[src/parser/classes/livechat/UpdateViewershipAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateViewershipAction.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### unlabeled\_view\_count\_value - -> **unlabeled\_view\_count\_value**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/UpdateViewershipAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateViewershipAction.ts#L11) - -*** - -### view\_count - -> **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/livechat/UpdateViewershipAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateViewershipAction.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpdateViewershipAction'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/livechat/UpdateViewershipAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/livechat/UpdateViewershipAction.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateViewershipAction & { [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 UpdateViewershipAction & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpsellDialog.md b/docs/api/namespaces/YTNodes/classes/UpsellDialog.md deleted file mode 100644 index 34294f75..00000000 --- a/docs/api/namespaces/YTNodes/classes/UpsellDialog.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpsellDialog - -# Class: UpsellDialog - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new UpsellDialog() - -> **new UpsellDialog**(`data`): [`UpsellDialog`](UpsellDialog.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`UpsellDialog`](UpsellDialog.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/UpsellDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UpsellDialog.ts#L15) - -## Properties - -### action\_button - -> **action\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/UpsellDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UpsellDialog.ts#L11) - -*** - -### dismiss\_button - -> **dismiss\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/UpsellDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UpsellDialog.ts#L12) - -*** - -### is\_visible - -> **is\_visible**: `boolean` - -#### Defined in - -[src/parser/classes/UpsellDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UpsellDialog.ts#L13) - -*** - -### message\_text - -> **message\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/UpsellDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UpsellDialog.ts#L10) - -*** - -### message\_title - -> **message\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/UpsellDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UpsellDialog.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'UpsellDialog'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/UpsellDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/UpsellDialog.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is UpsellDialog & { [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 UpsellDialog & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VerticalList.md b/docs/api/namespaces/YTNodes/classes/VerticalList.md deleted file mode 100644 index a1d50357..00000000 --- a/docs/api/namespaces/YTNodes/classes/VerticalList.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VerticalList - -# Class: VerticalList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VerticalList() - -> **new VerticalList**(`data`): [`VerticalList`](VerticalList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VerticalList`](VerticalList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VerticalList.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalList.ts#L12) - -## Properties - -### collapsed\_item\_count - -> **collapsed\_item\_count**: `string` - -#### Defined in - -[src/parser/classes/VerticalList.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalList.ts#L9) - -*** - -### collapsed\_state\_button\_text - -> **collapsed\_state\_button\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VerticalList.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalList.ts#L10) - -*** - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/VerticalList.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalList.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'VerticalList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VerticalList.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalList.ts#L6) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/VerticalList.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalList.ts#L20) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VerticalList & { [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 VerticalList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md b/docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md deleted file mode 100644 index c806656c..00000000 --- a/docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VerticalWatchCardList - -# Class: VerticalWatchCardList - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VerticalWatchCardList() - -> **new VerticalWatchCardList**(`data`): [`VerticalWatchCardList`](VerticalWatchCardList.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VerticalWatchCardList`](VerticalWatchCardList.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VerticalWatchCardList.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalWatchCardList.ts#L13) - -## Properties - -### items - -> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/VerticalWatchCardList.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalWatchCardList.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_all\_endpoint - -> **view\_all\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/VerticalWatchCardList.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalWatchCardList.ts#L11) - -*** - -### view\_all\_text - -> **view\_all\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VerticalWatchCardList.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalWatchCardList.ts#L10) - -*** - -### type - -> `static` **type**: `string` = `'VerticalWatchCardList'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VerticalWatchCardList.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalWatchCardList.ts#L7) - -## Accessors - -### contents - -> `get` **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Returns - -[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/VerticalWatchCardList.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VerticalWatchCardList.ts#L21) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VerticalWatchCardList & { [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 VerticalWatchCardList & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/Video.md b/docs/api/namespaces/YTNodes/classes/Video.md deleted file mode 100644 index 99411116..00000000 --- a/docs/api/namespaces/YTNodes/classes/Video.md +++ /dev/null @@ -1,603 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / Video - -# Class: Video - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`VideoCard`](VideoCard.md) - -## Constructors - -### new Video() - -> **new Video**(`data`): [`Video`](Video.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`Video`](Video.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/Video.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L43) - -## Properties - -### additional\_metadatas? - -> `optional` **additional\_metadatas**: [`Text`](../../Misc/classes/Text.md)[] - -#### Defined in - -[src/parser/classes/Video.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L22) - -*** - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L26) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MetadataBadge`](MetadataBadge.md)\> - -#### Defined in - -[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L27) - -*** - -### byline\_text? - -> `optional` **byline\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L37) - -*** - -### description\_snippet? - -> `optional` **description\_snippet**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L19) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L28) - -*** - -### expandable\_metadata - -> **expandable\_metadata**: `null` \| [`ExpandableMetadata`](ExpandableMetadata.md) - -#### Defined in - -[src/parser/classes/Video.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L21) - -*** - -### is\_watched - -> **is\_watched**: `boolean` - -#### Defined in - -[src/parser/classes/Video.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L35) - -*** - -### length\_text? - -> `optional` **length\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L33) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/Video.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L36) - -*** - -### published? - -> `optional` **published**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L29) - -*** - -### rich\_thumbnail? - -> `optional` **rich\_thumbnail**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L25) - -*** - -### search\_video\_result\_entity\_key? - -> `optional` **search\_video\_result\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L38) - -*** - -### service\_endpoint? - -> `optional` **service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L40) - -*** - -### service\_endpoints? - -> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L39) - -*** - -### short\_view\_count? - -> `optional` **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L31) - -*** - -### show\_action\_menu - -> **show\_action\_menu**: `boolean` - -#### Defined in - -[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L34) - -*** - -### snippets? - -> `optional` **snippets**: `object`[] - -#### Defined in - -[src/parser/classes/Video.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L20) - -*** - -### style? - -> `optional` **style**: `"VIDEO_STYLE_TYPE_UNKNOWN"` \| `"VIDEO_STYLE_TYPE_NORMAL"` \| `"VIDEO_STYLE_TYPE_POST"` \| `"VIDEO_STYLE_TYPE_SUB"` \| `"VIDEO_STYLE_TYPE_LIVE_POST"` \| `"VIDEO_STYLE_TYPE_FULL_BLEED_ISOLATED"` \| `"VIDEO_STYLE_TYPE_WITH_EXPANDED_METADATA"` - -#### Defined in - -[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L41) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Defined in - -[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L24) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L23) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### untranslated\_title? - -> `optional` **untranslated\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L18) - -*** - -### upcoming? - -> `optional` **upcoming**: `Date` - -#### Defined in - -[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L32) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Defined in - -[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L16) - -*** - -### view\_count? - -> `optional` **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L30) - -*** - -### type - -> `static` **type**: `string` = `'Video'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/Video.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L14) - -## Accessors - -### best\_thumbnail - -> `get` **best\_thumbnail**(): `undefined` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md) - -#### Returns - -`undefined` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md) - -#### Defined in - -[src/parser/classes/Video.ts:148](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L148) - -*** - -### description - -> `get` **description**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L119) - -*** - -### duration - -> `get` **duration**(): `object` - -#### Returns - -`object` - -##### seconds - -> **seconds**: `number` - -##### text - -> **text**: `undefined` \| `string` = `length_text` - -#### Defined in - -[src/parser/classes/Video.ts:152](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L152) - -*** - -### has\_captions - -> `get` **has\_captions**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/Video.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L144) - -*** - -### id - -> `get` **id**(): `string` - -#### Deprecated - -Use [`video_id`](Video.md#video_id) instead. - -#### Returns - -`string` - -#### Defined in - -[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L115) - -*** - -### is\_4k - -> `get` **is\_4k**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/Video.ts:140](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L140) - -*** - -### is\_live - -> `get` **is\_live**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/Video.ts:125](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L125) - -*** - -### is\_premiere - -> `get` **is\_premiere**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/classes/Video.ts:136](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L136) - -*** - -### is\_upcoming - -> `get` **is\_upcoming**(): `undefined` \| `boolean` - -#### Returns - -`undefined` \| `boolean` - -#### Defined in - -[src/parser/classes/Video.ts:132](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L132) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is Video & { [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 Video & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoAttributeView.md b/docs/api/namespaces/YTNodes/classes/VideoAttributeView.md deleted file mode 100644 index 1a5b8f2f..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoAttributeView.md +++ /dev/null @@ -1,295 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoAttributeView - -# Class: VideoAttributeView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoAttributeView() - -> **new VideoAttributeView**(`data`): [`VideoAttributeView`](VideoAttributeView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoAttributeView`](VideoAttributeView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L25) - -## Properties - -### image - -> **image**: `null` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] \| [`ContentPreviewImageView`](ContentPreviewImageView.md) - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L13) - -*** - -### image\_style - -> **image\_style**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L14) - -*** - -### orientation - -> **orientation**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L20) - -*** - -### overflow\_menu\_a11y\_label - -> **overflow\_menu\_a11y\_label**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L23) - -*** - -### overflow\_menu\_on\_tap - -> **overflow\_menu\_on\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L22) - -*** - -### secondary\_subtitle? - -> `optional` **secondary\_subtitle**: `object` - -#### content - -> **content**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L17) - -*** - -### sizing\_rule - -> **sizing\_rule**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L21) - -*** - -### subtitle - -> **subtitle**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L16) - -*** - -### title - -> **title**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'VideoAttributeView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoAttributeView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributeView.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoAttributeView & { [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 VideoAttributeView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md b/docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md deleted file mode 100644 index 9a8a41b0..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoAttributesSectionView - -# Class: VideoAttributesSectionView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoAttributesSectionView() - -> **new VideoAttributesSectionView**(`data`): [`VideoAttributesSectionView`](VideoAttributesSectionView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoAttributesSectionView`](VideoAttributesSectionView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoAttributesSectionView.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributesSectionView.ts#L16) - -## Properties - -### header\_subtitle - -> **header\_subtitle**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributesSectionView.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributesSectionView.ts#L11) - -*** - -### header\_title - -> **header\_title**: `string` - -#### Defined in - -[src/parser/classes/VideoAttributesSectionView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributesSectionView.ts#L10) - -*** - -### next\_button - -> **next\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/VideoAttributesSectionView.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributesSectionView.ts#L14) - -*** - -### previous\_button - -> **previous\_button**: `null` \| [`ButtonView`](ButtonView.md) - -#### Defined in - -[src/parser/classes/VideoAttributesSectionView.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributesSectionView.ts#L13) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_attributes - -> **video\_attributes**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`VideoAttributeView`](VideoAttributeView.md)\> - -#### Defined in - -[src/parser/classes/VideoAttributesSectionView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributesSectionView.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'VideoAttributesSectionView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoAttributesSectionView.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoAttributesSectionView.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoAttributesSectionView & { [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 VideoAttributesSectionView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoCard.md b/docs/api/namespaces/YTNodes/classes/VideoCard.md deleted file mode 100644 index ccbce7d8..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoCard.md +++ /dev/null @@ -1,749 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoCard - -# Class: VideoCard - -## Extends - -- [`Video`](Video.md) - -## Constructors - -### new VideoCard() - -> **new VideoCard**(`data`): [`VideoCard`](VideoCard.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoCard`](VideoCard.md) - -#### Overrides - -[`Video`](Video.md).[`constructor`](Video.md#constructors) - -#### Defined in - -[src/parser/classes/VideoCard.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoCard.ts#L11) - -## Properties - -### additional\_metadatas? - -> `optional` **additional\_metadatas**: [`Text`](../../Misc/classes/Text.md)[] - -#### Inherited from - -[`Video`](Video.md).[`additional_metadatas`](Video.md#additional_metadatas) - -#### Defined in - -[src/parser/classes/Video.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L22) - -*** - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Inherited from - -[`Video`](Video.md).[`author`](Video.md#author) - -#### Defined in - -[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L26) - -*** - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MetadataBadge`](MetadataBadge.md)\> - -#### Inherited from - -[`Video`](Video.md).[`badges`](Video.md#badges) - -#### Defined in - -[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L27) - -*** - -### byline\_text? - -> `optional` **byline\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`byline_text`](Video.md#byline_text) - -#### Defined in - -[src/parser/classes/Video.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L37) - -*** - -### description\_snippet? - -> `optional` **description\_snippet**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`description_snippet`](Video.md#description_snippet) - -#### Defined in - -[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L19) - -*** - -### endpoint? - -> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Inherited from - -[`Video`](Video.md).[`endpoint`](Video.md#endpoint) - -#### Defined in - -[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L28) - -*** - -### expandable\_metadata - -> **expandable\_metadata**: `null` \| [`ExpandableMetadata`](ExpandableMetadata.md) - -#### Inherited from - -[`Video`](Video.md).[`expandable_metadata`](Video.md#expandable_metadata) - -#### Defined in - -[src/parser/classes/Video.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L21) - -*** - -### is\_watched - -> **is\_watched**: `boolean` - -#### Inherited from - -[`Video`](Video.md).[`is_watched`](Video.md#is_watched) - -#### Defined in - -[src/parser/classes/Video.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L35) - -*** - -### length\_text? - -> `optional` **length\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`length_text`](Video.md#length_text) - -#### Defined in - -[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L33) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Inherited from - -[`Video`](Video.md).[`menu`](Video.md#menu) - -#### Defined in - -[src/parser/classes/Video.ts:36](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L36) - -*** - -### metadata\_text? - -> `optional` **metadata\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoCard.ts#L9) - -*** - -### published? - -> `optional` **published**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`published`](Video.md#published) - -#### Defined in - -[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L29) - -*** - -### rich\_thumbnail? - -> `optional` **rich\_thumbnail**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Inherited from - -[`Video`](Video.md).[`rich_thumbnail`](Video.md#rich_thumbnail) - -#### Defined in - -[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L25) - -*** - -### search\_video\_result\_entity\_key? - -> `optional` **search\_video\_result\_entity\_key**: `string` - -#### Inherited from - -[`Video`](Video.md).[`search_video_result_entity_key`](Video.md#search_video_result_entity_key) - -#### Defined in - -[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L38) - -*** - -### service\_endpoint? - -> `optional` **service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Inherited from - -[`Video`](Video.md).[`service_endpoint`](Video.md#service_endpoint) - -#### Defined in - -[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L40) - -*** - -### service\_endpoints? - -> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] - -#### Inherited from - -[`Video`](Video.md).[`service_endpoints`](Video.md#service_endpoints) - -#### Defined in - -[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L39) - -*** - -### short\_view\_count? - -> `optional` **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`short_view_count`](Video.md#short_view_count) - -#### Defined in - -[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L31) - -*** - -### show\_action\_menu - -> **show\_action\_menu**: `boolean` - -#### Inherited from - -[`Video`](Video.md).[`show_action_menu`](Video.md#show_action_menu) - -#### Defined in - -[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L34) - -*** - -### snippets? - -> `optional` **snippets**: `object`[] - -#### Inherited from - -[`Video`](Video.md).[`snippets`](Video.md#snippets) - -#### Defined in - -[src/parser/classes/Video.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L20) - -*** - -### style? - -> `optional` **style**: `"VIDEO_STYLE_TYPE_UNKNOWN"` \| `"VIDEO_STYLE_TYPE_NORMAL"` \| `"VIDEO_STYLE_TYPE_POST"` \| `"VIDEO_STYLE_TYPE_SUB"` \| `"VIDEO_STYLE_TYPE_LIVE_POST"` \| `"VIDEO_STYLE_TYPE_FULL_BLEED_ISOLATED"` \| `"VIDEO_STYLE_TYPE_WITH_EXPANDED_METADATA"` - -#### Inherited from - -[`Video`](Video.md).[`style`](Video.md#style) - -#### Defined in - -[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L41) - -*** - -### thumbnail\_overlays - -> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> - -#### Inherited from - -[`Video`](Video.md).[`thumbnail_overlays`](Video.md#thumbnail_overlays) - -#### Defined in - -[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L24) - -*** - -### thumbnails - -> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Inherited from - -[`Video`](Video.md).[`thumbnails`](Video.md#thumbnails) - -#### Defined in - -[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L23) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`title`](Video.md#title) - -#### Defined in - -[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L17) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`Video`](Video.md).[`type`](Video.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### untranslated\_title? - -> `optional` **untranslated\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`untranslated_title`](Video.md#untranslated_title) - -#### Defined in - -[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L18) - -*** - -### upcoming? - -> `optional` **upcoming**: `Date` - -#### Inherited from - -[`Video`](Video.md).[`upcoming`](Video.md#upcoming) - -#### Defined in - -[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L32) - -*** - -### video\_id - -> **video\_id**: `string` - -#### Inherited from - -[`Video`](Video.md).[`video_id`](Video.md#video_id) - -#### Defined in - -[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L16) - -*** - -### view\_count? - -> `optional` **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Inherited from - -[`Video`](Video.md).[`view_count`](Video.md#view_count) - -#### Defined in - -[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L30) - -*** - -### type - -> `static` **type**: `string` = `'VideoCard'` - -#### Overrides - -[`Video`](Video.md).[`type`](Video.md#type-1) - -#### Defined in - -[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoCard.ts#L7) - -## Accessors - -### best\_thumbnail - -> `get` **best\_thumbnail**(): `undefined` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md) - -#### Returns - -`undefined` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md) - -#### Inherited from - -[`Video`](Video.md).[`best_thumbnail`](Video.md#best_thumbnail) - -#### Defined in - -[src/parser/classes/Video.ts:148](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L148) - -*** - -### description - -> `get` **description**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`Video`](Video.md).[`description`](Video.md#description) - -#### Defined in - -[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L119) - -*** - -### duration - -> `get` **duration**(): `object` - -#### Returns - -`object` - -##### seconds - -> **seconds**: `number` - -##### text - -> **text**: `undefined` \| `string` = `length_text` - -#### Inherited from - -[`Video`](Video.md).[`duration`](Video.md#duration) - -#### Defined in - -[src/parser/classes/Video.ts:152](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L152) - -*** - -### has\_captions - -> `get` **has\_captions**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -[`Video`](Video.md).[`has_captions`](Video.md#has_captions) - -#### Defined in - -[src/parser/classes/Video.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L144) - -*** - -### id - -> `get` **id**(): `string` - -#### Deprecated - -Use [`video_id`](Video.md#video_id) instead. - -#### Returns - -`string` - -#### Inherited from - -[`Video`](Video.md).[`id`](Video.md#id) - -#### Defined in - -[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L115) - -*** - -### is\_4k - -> `get` **is\_4k**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -[`Video`](Video.md).[`is_4k`](Video.md#is_4k) - -#### Defined in - -[src/parser/classes/Video.ts:140](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L140) - -*** - -### is\_live - -> `get` **is\_live**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -[`Video`](Video.md).[`is_live`](Video.md#is_live) - -#### Defined in - -[src/parser/classes/Video.ts:125](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L125) - -*** - -### is\_premiere - -> `get` **is\_premiere**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -[`Video`](Video.md).[`is_premiere`](Video.md#is_premiere) - -#### Defined in - -[src/parser/classes/Video.ts:136](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L136) - -*** - -### is\_upcoming - -> `get` **is\_upcoming**(): `undefined` \| `boolean` - -#### Returns - -`undefined` \| `boolean` - -#### Inherited from - -[`Video`](Video.md).[`is_upcoming`](Video.md#is_upcoming) - -#### Defined in - -[src/parser/classes/Video.ts:132](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/Video.ts#L132) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`Video`](Video.md).[`as`](Video.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoCard & { [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 VideoCard & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`Video`](Video.md).[`hasKey`](Video.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`Video`](Video.md).[`is`](Video.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`Video`](Video.md).[`key`](Video.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md deleted file mode 100644 index a1073de9..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md +++ /dev/null @@ -1,271 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoDescriptionHeader - -# Class: VideoDescriptionHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoDescriptionHeader() - -> **new VideoDescriptionHeader**(`data`): [`VideoDescriptionHeader`](VideoDescriptionHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoDescriptionHeader`](VideoDescriptionHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L21) - -## Properties - -### channel - -> **channel**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L13) - -*** - -### channel\_navigation\_endpoint? - -> `optional` **channel\_navigation\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L14) - -*** - -### channel\_thumbnail - -> **channel\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L15) - -*** - -### factoids - -> **factoids**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Factoid`](Factoid.md) \| [`UploadTimeFactoid`](UploadTimeFactoid.md) \| [`ViewCountFactoid`](ViewCountFactoid.md) \| [`HypePointsFactoid`](HypePointsFactoid.md)\> - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L16) - -*** - -### publish\_date - -> **publish\_date**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L17) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L18) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### views - -> **views**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L19) - -*** - -### type - -> `static` **type**: `string` = `'VideoDescriptionHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoDescriptionHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionHeader.ts#L11) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoDescriptionHeader & { [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 VideoDescriptionHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md deleted file mode 100644 index 8b9ae2bd..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoDescriptionInfocardsSection - -# Class: VideoDescriptionInfocardsSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoDescriptionInfocardsSection() - -> **new VideoDescriptionInfocardsSection**(`data`): [`VideoDescriptionInfocardsSection`](VideoDescriptionInfocardsSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoDescriptionInfocardsSection`](VideoDescriptionInfocardsSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L19) - -## Properties - -### channel\_avatar - -> **channel\_avatar**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L16) - -*** - -### channel\_endpoint - -> **channel\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L17) - -*** - -### creator\_about\_button - -> **creator\_about\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L14) - -*** - -### creator\_videos\_button - -> **creator\_videos\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L13) - -*** - -### section\_subtitle - -> **section\_subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L15) - -*** - -### section\_title - -> **section\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'VideoDescriptionInfocardsSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoDescriptionInfocardsSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionInfocardsSection.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoDescriptionInfocardsSection & { [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 VideoDescriptionInfocardsSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md deleted file mode 100644 index 4c51aece..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoDescriptionMusicSection - -# Class: VideoDescriptionMusicSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoDescriptionMusicSection() - -> **new VideoDescriptionMusicSection**(`data`): [`VideoDescriptionMusicSection`](VideoDescriptionMusicSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoDescriptionMusicSection`](VideoDescriptionMusicSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoDescriptionMusicSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionMusicSection.ts#L12) - -## Properties - -### carousel\_lockups - -> **carousel\_lockups**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CarouselLockup`](CarouselLockup.md)\> - -#### Defined in - -[src/parser/classes/VideoDescriptionMusicSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionMusicSection.ts#L9) - -*** - -### section\_title - -> **section\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionMusicSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionMusicSection.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'VideoDescriptionMusicSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoDescriptionMusicSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionMusicSection.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoDescriptionMusicSection & { [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 VideoDescriptionMusicSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md deleted file mode 100644 index 4718cb4b..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoDescriptionTranscriptSection - -# Class: VideoDescriptionTranscriptSection - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoDescriptionTranscriptSection() - -> **new VideoDescriptionTranscriptSection**(`data`): [`VideoDescriptionTranscriptSection`](VideoDescriptionTranscriptSection.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoDescriptionTranscriptSection`](VideoDescriptionTranscriptSection.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoDescriptionTranscriptSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionTranscriptSection.ts#L14) - -## Properties - -### primary\_button - -> **primary\_button**: `null` \| [`Button`](Button.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionTranscriptSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionTranscriptSection.ts#L12) - -*** - -### section\_title - -> **section\_title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionTranscriptSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionTranscriptSection.ts#L10) - -*** - -### sub\_header\_text - -> **sub\_header\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoDescriptionTranscriptSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionTranscriptSection.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'VideoDescriptionTranscriptSection'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoDescriptionTranscriptSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoDescriptionTranscriptSection.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoDescriptionTranscriptSection & { [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 VideoDescriptionTranscriptSection & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md b/docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md deleted file mode 100644 index 0280a6c7..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md +++ /dev/null @@ -1,261 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoInfoCardContent - -# Class: VideoInfoCardContent - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoInfoCardContent() - -> **new VideoInfoCardContent**(`data`): [`VideoInfoCardContent`](VideoInfoCardContent.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoInfoCardContent`](VideoInfoCardContent.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L17) - -## Properties - -### channel\_name - -> **channel\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L11) - -*** - -### duration - -> **duration**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L14) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L15) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_thumbnails - -> **video\_thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L13) - -*** - -### view\_count - -> **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L12) - -*** - -### type - -> `static` **type**: `string` = `'VideoInfoCardContent'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoInfoCardContent.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoInfoCardContent & { [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 VideoInfoCardContent & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoMetadataCarouselView.md b/docs/api/namespaces/YTNodes/classes/VideoMetadataCarouselView.md deleted file mode 100644 index b27e2b34..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoMetadataCarouselView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoMetadataCarouselView - -# Class: VideoMetadataCarouselView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoMetadataCarouselView() - -> **new VideoMetadataCarouselView**(`data`): [`VideoMetadataCarouselView`](VideoMetadataCarouselView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoMetadataCarouselView`](VideoMetadataCarouselView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoMetadataCarouselView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoMetadataCarouselView.ts#L12) - -## Properties - -### carousel\_items - -> **carousel\_items**: `null` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CarouselItemView`](CarouselItemView.md)\> - -#### Defined in - -[src/parser/classes/VideoMetadataCarouselView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoMetadataCarouselView.ts#L10) - -*** - -### carousel\_titles - -> **carousel\_titles**: `null` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CarouselTitleView`](CarouselTitleView.md)\> - -#### Defined in - -[src/parser/classes/VideoMetadataCarouselView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoMetadataCarouselView.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'VideoMetadataCarouselView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoMetadataCarouselView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoMetadataCarouselView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoMetadataCarouselView & { [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 VideoMetadataCarouselView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md b/docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md deleted file mode 100644 index 3c566abe..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md +++ /dev/null @@ -1,281 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoPrimaryInfo - -# Class: VideoPrimaryInfo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoPrimaryInfo() - -> **new VideoPrimaryInfo**(`data`): [`VideoPrimaryInfo`](VideoPrimaryInfo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoPrimaryInfo`](VideoPrimaryInfo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:21](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L21) - -## Properties - -### badges - -> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MetadataBadge`](MetadataBadge.md)\> - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L16) - -*** - -### menu - -> **menu**: `null` \| [`Menu`](Menu.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L19) - -*** - -### published - -> **published**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L17) - -*** - -### relative\_date - -> **relative\_date**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L18) - -*** - -### station\_name? - -> `optional` **station\_name**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L14) - -*** - -### super\_title\_link? - -> `optional` **super\_title\_link**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L13) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L12) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_count - -> **view\_count**: `null` \| [`VideoViewCount`](VideoViewCount.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L15) - -*** - -### type - -> `static` **type**: `string` = `'VideoPrimaryInfo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoPrimaryInfo.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoPrimaryInfo & { [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 VideoPrimaryInfo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md b/docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md deleted file mode 100644 index 38b56bef..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md +++ /dev/null @@ -1,291 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoSecondaryInfo - -# Class: VideoSecondaryInfo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoSecondaryInfo() - -> **new VideoSecondaryInfo**(`data`): [`VideoSecondaryInfo`](VideoSecondaryInfo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoSecondaryInfo`](VideoSecondaryInfo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L22) - -## Properties - -### default\_expanded - -> **default\_expanded**: `string` - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L19) - -*** - -### description - -> **description**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L13) - -*** - -### description\_collapsed\_lines - -> **description\_collapsed\_lines**: `string` - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L20) - -*** - -### description\_placeholder? - -> `optional` **description\_placeholder**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L14) - -*** - -### metadata - -> **metadata**: `null` \| [`MetadataRowContainer`](MetadataRowContainer.md) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L16) - -*** - -### owner - -> **owner**: `null` \| [`VideoOwner`](VideoOwner.md) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L12) - -*** - -### show\_less\_text - -> **show\_less\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:18](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L18) - -*** - -### show\_more\_text - -> **show\_more\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L17) - -*** - -### subscribe\_button - -> **subscribe\_button**: `null` \| [`Button`](Button.md) \| [`SubscribeButton`](SubscribeButton.md) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L15) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'VideoSecondaryInfo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoSecondaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoSecondaryInfo.ts#L10) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoSecondaryInfo & { [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 VideoSecondaryInfo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VideoViewCount.md b/docs/api/namespaces/YTNodes/classes/VideoViewCount.md deleted file mode 100644 index da17b54f..00000000 --- a/docs/api/namespaces/YTNodes/classes/VideoViewCount.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoViewCount - -# Class: VideoViewCount - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VideoViewCount() - -> **new VideoViewCount**(`data`): [`VideoViewCount`](VideoViewCount.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VideoViewCount`](VideoViewCount.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/VideoViewCount.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoViewCount.ts#L13) - -## Properties - -### extra\_short\_view\_count - -> **extra\_short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoViewCount.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoViewCount.ts#L10) - -*** - -### original\_view\_count - -> **original\_view\_count**: `string` - -#### Defined in - -[src/parser/classes/VideoViewCount.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoViewCount.ts#L8) - -*** - -### short\_view\_count - -> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoViewCount.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoViewCount.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_count - -> **view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoViewCount.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoViewCount.ts#L11) - -*** - -### type - -> `static` **type**: `string` = `'VideoViewCount'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/VideoViewCount.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/VideoViewCount.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VideoViewCount & { [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 VideoViewCount & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md b/docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md deleted file mode 100644 index d6a12763..00000000 --- a/docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md +++ /dev/null @@ -1,231 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ViewCountFactoid - -# Class: ViewCountFactoid - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new ViewCountFactoid() - -> **new ViewCountFactoid**(`data`): [`ViewCountFactoid`](ViewCountFactoid.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`ViewCountFactoid`](ViewCountFactoid.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/ViewCountFactoid.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ViewCountFactoid.ts#L13) - -## Properties - -### factoid - -> **factoid**: `null` \| [`Factoid`](Factoid.md) - -#### Defined in - -[src/parser/classes/ViewCountFactoid.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ViewCountFactoid.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### view\_count\_entity\_key - -> **view\_count\_entity\_key**: `string` - -#### Defined in - -[src/parser/classes/ViewCountFactoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ViewCountFactoid.ts#L9) - -*** - -### view\_count\_type - -> **view\_count\_type**: `string` - -#### Defined in - -[src/parser/classes/ViewCountFactoid.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ViewCountFactoid.ts#L11) - -*** - -### type - -> `static` **type**: `string` = `'ViewCountFactoid'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/ViewCountFactoid.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/ViewCountFactoid.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is ViewCountFactoid & { [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 ViewCountFactoid & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/VoiceReplyContainerView.md b/docs/api/namespaces/YTNodes/classes/VoiceReplyContainerView.md deleted file mode 100644 index d865c9a0..00000000 --- a/docs/api/namespaces/YTNodes/classes/VoiceReplyContainerView.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VoiceReplyContainerView - -# Class: VoiceReplyContainerView - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new VoiceReplyContainerView() - -> **new VoiceReplyContainerView**(`data`): [`VoiceReplyContainerView`](VoiceReplyContainerView.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`VoiceReplyContainerView`](VoiceReplyContainerView.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/comments/VoiceReplyContainerView.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/VoiceReplyContainerView.ts#L12) - -## Properties - -### transcript\_text - -> **transcript\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/VoiceReplyContainerView.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/VoiceReplyContainerView.ts#L10) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### voice\_reply\_unavailable\_text - -> **voice\_reply\_unavailable\_text**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/comments/VoiceReplyContainerView.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/VoiceReplyContainerView.ts#L9) - -*** - -### type - -> `static` **type**: `string` = `'VoiceReplyContainerView'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/comments/VoiceReplyContainerView.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/comments/VoiceReplyContainerView.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is VoiceReplyContainerView & { [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 VoiceReplyContainerView & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md b/docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md deleted file mode 100644 index efaa1951..00000000 --- a/docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md +++ /dev/null @@ -1,249 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / WatchCardCompactVideo - -# Class: WatchCardCompactVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new WatchCardCompactVideo() - -> **new WatchCardCompactVideo**(`data`): [`WatchCardCompactVideo`](WatchCardCompactVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`WatchCardCompactVideo`](WatchCardCompactVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/WatchCardCompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardCompactVideo.ts#L17) - -## Properties - -### duration - -> **duration**: `object` - -#### seconds - -> **seconds**: `number` - -#### text - -> **text**: `string` - -#### Defined in - -[src/parser/classes/WatchCardCompactVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardCompactVideo.ts#L11) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/WatchCardCompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardCompactVideo.ts#L15) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/WatchCardCompactVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardCompactVideo.ts#L10) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/WatchCardCompactVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardCompactVideo.ts#L9) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'WatchCardCompactVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/WatchCardCompactVideo.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardCompactVideo.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is WatchCardCompactVideo & { [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 WatchCardCompactVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md b/docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md deleted file mode 100644 index ce42d09f..00000000 --- a/docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / WatchCardHeroVideo - -# Class: WatchCardHeroVideo - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new WatchCardHeroVideo() - -> **new WatchCardHeroVideo**(`data`): [`WatchCardHeroVideo`](WatchCardHeroVideo.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`WatchCardHeroVideo`](WatchCardHeroVideo.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/WatchCardHeroVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardHeroVideo.ts#L13) - -## Properties - -### call\_to\_action\_button - -> **call\_to\_action\_button**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/WatchCardHeroVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardHeroVideo.ts#L9) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/WatchCardHeroVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardHeroVideo.ts#L8) - -*** - -### hero\_image - -> **hero\_image**: [`YTNode`](../../Helpers/classes/YTNode.md) - -#### Defined in - -[src/parser/classes/WatchCardHeroVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardHeroVideo.ts#L10) - -*** - -### label - -> **label**: `string` - -#### Defined in - -[src/parser/classes/WatchCardHeroVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardHeroVideo.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'WatchCardHeroVideo'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/WatchCardHeroVideo.ts:6](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardHeroVideo.ts#L6) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is WatchCardHeroVideo & { [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 WatchCardHeroVideo & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md b/docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md deleted file mode 100644 index 9eca648b..00000000 --- a/docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md +++ /dev/null @@ -1,251 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / WatchCardRichHeader - -# Class: WatchCardRichHeader - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new WatchCardRichHeader() - -> **new WatchCardRichHeader**(`data`): [`WatchCardRichHeader`](WatchCardRichHeader.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`WatchCardRichHeader`](WatchCardRichHeader.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/WatchCardRichHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardRichHeader.ts#L16) - -## Properties - -### author - -> **author**: [`Author`](../../Misc/classes/Author.md) - -#### Defined in - -[src/parser/classes/WatchCardRichHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardRichHeader.ts#L13) - -*** - -### style - -> **style**: `string` - -#### Defined in - -[src/parser/classes/WatchCardRichHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardRichHeader.ts#L14) - -*** - -### subtitle - -> **subtitle**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/WatchCardRichHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardRichHeader.ts#L12) - -*** - -### title - -> **title**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/WatchCardRichHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardRichHeader.ts#L10) - -*** - -### title\_endpoint - -> **title\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/WatchCardRichHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardRichHeader.ts#L11) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'WatchCardRichHeader'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/WatchCardRichHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/WatchCardRichHeader.ts#L8) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is WatchCardRichHeader & { [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 WatchCardRichHeader & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/WatchEndpoint.md b/docs/api/namespaces/YTNodes/classes/WatchEndpoint.md deleted file mode 100644 index 21213583..00000000 --- a/docs/api/namespaces/YTNodes/classes/WatchEndpoint.md +++ /dev/null @@ -1,245 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / WatchEndpoint - -# Class: WatchEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Extended by - -- [`PrefetchWatchCommand`](PrefetchWatchCommand.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`WatchRequest`](../../APIResponseTypes/type-aliases/WatchRequest.md)\> - -## Constructors - -### new WatchEndpoint() - -> **new WatchEndpoint**(`data`): [`WatchEndpoint`](WatchEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`WatchEndpoint`](WatchEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/WatchEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'WatchEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/WatchEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`WatchRequest`](../../APIResponseTypes/type-aliases/WatchRequest.md) - -#### Returns - -[`WatchRequest`](../../APIResponseTypes/type-aliases/WatchRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/WatchEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/WatchEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is WatchEndpoint & { [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 WatchEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/WatchNextEndpoint.md b/docs/api/namespaces/YTNodes/classes/WatchNextEndpoint.md deleted file mode 100644 index 03f2ee04..00000000 --- a/docs/api/namespaces/YTNodes/classes/WatchNextEndpoint.md +++ /dev/null @@ -1,241 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / WatchNextEndpoint - -# Class: WatchNextEndpoint - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Implements - -- [`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md)\<[`WatchNextRequest`](../../APIResponseTypes/type-aliases/WatchNextRequest.md)\> - -## Constructors - -### new WatchNextEndpoint() - -> **new WatchNextEndpoint**(`data`): [`WatchNextEndpoint`](WatchNextEndpoint.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`WatchNextEndpoint`](WatchNextEndpoint.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/endpoints/WatchNextEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchNextEndpoint.ts#L11) - -## Properties - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### type - -> `static` **type**: `string` = `'WatchNextEndpoint'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/endpoints/WatchNextEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchNextEndpoint.ts#L7) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### buildRequest() - -> **buildRequest**(): [`WatchNextRequest`](../../APIResponseTypes/type-aliases/WatchNextRequest.md) - -#### Returns - -[`WatchNextRequest`](../../APIResponseTypes/type-aliases/WatchNextRequest.md) - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`buildRequest`](../../APIResponseTypes/interfaces/IEndpoint.md#buildrequest) - -#### Defined in - -[src/parser/classes/endpoints/WatchNextEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchNextEndpoint.ts#L20) - -*** - -### getApiPath() - -> **getApiPath**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[`IEndpoint`](../../APIResponseTypes/interfaces/IEndpoint.md).[`getApiPath`](../../APIResponseTypes/interfaces/IEndpoint.md#getapipath) - -#### Defined in - -[src/parser/classes/endpoints/WatchNextEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/endpoints/WatchNextEndpoint.ts#L16) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is WatchNextEndpoint & { [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 WatchNextEndpoint & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/YpcTrailer.md b/docs/api/namespaces/YTNodes/classes/YpcTrailer.md deleted file mode 100644 index 6135f44e..00000000 --- a/docs/api/namespaces/YTNodes/classes/YpcTrailer.md +++ /dev/null @@ -1,221 +0,0 @@ -[youtubei.js](../../../README.md) / [YTNodes](../README.md) / YpcTrailer - -# Class: YpcTrailer - -## Extends - -- [`YTNode`](../../Helpers/classes/YTNode.md) - -## Constructors - -### new YpcTrailer() - -> **new YpcTrailer**(`data`): [`YpcTrailer`](YpcTrailer.md) - -#### Parameters - -• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) - -#### Returns - -[`YpcTrailer`](YpcTrailer.md) - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) - -#### Defined in - -[src/parser/classes/YpcTrailer.ts:10](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/YpcTrailer.ts#L10) - -## Properties - -### player\_response - -> **player\_response**: [`IRawResponse`](../../APIResponseTypes/interfaces/IRawResponse.md) - -#### Defined in - -[src/parser/classes/YpcTrailer.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/YpcTrailer.ts#L8) - -*** - -### type - -> `readonly` **type**: `string` - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type) - -#### Defined in - -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L8) - -*** - -### video\_message - -> **video\_message**: `string` - -#### Defined in - -[src/parser/classes/YpcTrailer.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/YpcTrailer.ts#L7) - -*** - -### type - -> `static` **type**: `string` = `'YpcTrailer'` - -#### Overrides - -[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) - -#### Defined in - -[src/parser/classes/YpcTrailer.ts:5](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/classes/YpcTrailer.ts#L5) - -## Methods - -### as() - -> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\> - -Cast to one of the given types. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The types to cast to - -#### Returns - -`InstanceType`\<`K`\[`number`\]\> - -The node cast to one of the given types - -#### Throws - -If the node is not of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) - -#### Defined in - -[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L29) - -*** - -### hasKey() - -> **hasKey**\<`T`, `R`\>(`key`): `this is YpcTrailer & { [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 YpcTrailer & { [k in string]: R }` - -Whether the node has the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) - -#### Defined in - -[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L41) - -*** - -### is() - -> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` - -Check if the node is of the given type. - -#### Type Parameters - -• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) - -• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] - -#### Parameters - -• ...**types**: `K` - -The type to check - -#### Returns - -`this is InstanceType` - -whether the node is of the given type - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) - -#### Defined in - -[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L19) - -*** - -### key() - -> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) - -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 - -[`Maybe`](../../Helpers/classes/Maybe.md) - -The value of the key wrapped in a Maybe - -#### Throws - -If the node does not have the key - -#### Inherited from - -[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) - -#### Defined in - -[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md b/docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md deleted file mode 100644 index ab0418b1..00000000 --- a/docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md +++ /dev/null @@ -1,595 +0,0 @@ -[youtubei.js](../../../README.md) / [YTShorts](../README.md) / ShortFormVideoInfo - -# Class: ShortFormVideoInfo - -## Extends - -- [`MediaInfo`](../../Mixins/classes/MediaInfo.md) - -## Constructors - -### new ShortFormVideoInfo() - -> **new ShortFormVideoInfo**(`data`, `actions`, `cpn`, `reel_watch_sequence_response`): [`ShortFormVideoInfo`](ShortFormVideoInfo.md) - -#### Parameters - -• **data**: [[`ApiResponse`](../../../interfaces/ApiResponse.md), `ApiResponse?`] - -• **actions**: [`Actions`](../../../classes/Actions.md) - -• **cpn**: `string` - -• **reel\_watch\_sequence\_response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) - -#### Returns - -[`ShortFormVideoInfo`](ShortFormVideoInfo.md) - -#### Overrides - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`constructor`](../../Mixins/classes/MediaInfo.md#constructors) - -#### Defined in - -[src/parser/ytshorts/ShortFormVideoInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytshorts/ShortFormVideoInfo.ts#L15) - -## Properties - -### annotations? - -> `optional` **annotations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`annotations`](../../Mixins/classes/MediaInfo.md#annotations) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L40) - -*** - -### basic\_info - -> **basic\_info**: `object` - -#### allow\_ratings? - -> `optional` **allow\_ratings**: `boolean` - -#### author? - -> `optional` **author**: `string` - -#### category - -> **category**: `null` \| `string` - -#### channel - -> **channel**: `null` \| `object` - -#### channel\_id? - -> `optional` **channel\_id**: `string` - -#### duration? - -> `optional` **duration**: `number` - -#### embed - -> **embed**: `undefined` \| `null` \| `object` - -#### end\_timestamp - -> **end\_timestamp**: `null` \| `Date` - -#### has\_ypc\_metadata - -> **has\_ypc\_metadata**: `null` \| `boolean` - -#### id? - -> `optional` **id**: `string` - -#### is\_crawlable? - -> `optional` **is\_crawlable**: `boolean` - -#### is\_disliked - -> **is\_disliked**: `undefined` \| `boolean` - -#### is\_family\_safe - -> **is\_family\_safe**: `undefined` \| `boolean` = `info.microformat.is_family_safe` - -#### is\_liked - -> **is\_liked**: `undefined` \| `boolean` - -#### is\_live? - -> `optional` **is\_live**: `boolean` - -#### is\_live\_content? - -> `optional` **is\_live\_content**: `boolean` - -#### is\_live\_dvr\_enabled? - -> `optional` **is\_live\_dvr\_enabled**: `boolean` - -#### is\_low\_latency\_live\_stream? - -> `optional` **is\_low\_latency\_live\_stream**: `boolean` - -#### is\_owner\_viewing? - -> `optional` **is\_owner\_viewing**: `boolean` - -#### is\_post\_live\_dvr? - -> `optional` **is\_post\_live\_dvr**: `boolean` - -#### is\_private? - -> `optional` **is\_private**: `boolean` - -#### is\_unlisted - -> **is\_unlisted**: `undefined` \| `boolean` = `info.microformat.is_unlisted` - -#### is\_upcoming? - -> `optional` **is\_upcoming**: `boolean` - -#### keywords? - -> `optional` **keywords**: `string`[] - -#### like\_count - -> **like\_count**: `undefined` \| `number` - -#### live\_chunk\_readahead? - -> `optional` **live\_chunk\_readahead**: `number` - -#### short\_description? - -> `optional` **short\_description**: `string` - -#### start\_timestamp - -> **start\_timestamp**: `null` \| `Date` - -#### tags - -> **tags**: `null` \| `string`[] - -#### thumbnail? - -> `optional` **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] - -#### title? - -> `optional` **title**: `string` - -#### url\_canonical - -> **url\_canonical**: `null` \| `string` - -#### view\_count - -> **view\_count**: `undefined` \| `number` - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`basic_info`](../../Mixins/classes/MediaInfo.md#basic_info) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L39) - -*** - -### captions? - -> `optional` **captions**: [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`captions`](../../Mixins/classes/MediaInfo.md#captions) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L43) - -*** - -### cards? - -> `optional` **cards**: [`CardCollection`](../../YTNodes/classes/CardCollection.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`cards`](../../Mixins/classes/MediaInfo.md#cards) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L44) - -*** - -### current\_video\_endpoint? - -> `optional` **current\_video\_endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - -#### Defined in - -[src/parser/ytshorts/ShortFormVideoInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytshorts/ShortFormVideoInfo.ts#L12) - -*** - -### endscreen? - -> `optional` **endscreen**: [`Endscreen`](../../YTNodes/classes/Endscreen.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`endscreen`](../../Mixins/classes/MediaInfo.md#endscreen) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L42) - -*** - -### playability\_status? - -> `optional` **playability\_status**: [`IPlayabilityStatus`](../../APIResponseTypes/interfaces/IPlayabilityStatus.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`playability_status`](../../Mixins/classes/MediaInfo.md#playability_status) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L46) - -*** - -### player\_config? - -> `optional` **player\_config**: [`IPlayerConfig`](../../APIResponseTypes/interfaces/IPlayerConfig.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`player_config`](../../Mixins/classes/MediaInfo.md#player_config) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L47) - -*** - -### player\_overlays? - -> `optional` **player\_overlays**: [`PlayerOverlay`](../../YTNodes/classes/PlayerOverlay.md) - -#### Defined in - -[src/parser/ytshorts/ShortFormVideoInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytshorts/ShortFormVideoInfo.ts#L13) - -*** - -### storyboards? - -> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`storyboards`](../../Mixins/classes/MediaInfo.md#storyboards) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L41) - -*** - -### streaming\_data? - -> `optional` **streaming\_data**: [`IStreamingData`](../../APIResponseTypes/interfaces/IStreamingData.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`streaming_data`](../../Mixins/classes/MediaInfo.md#streaming_data) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L45) - -*** - -### watch\_next\_feed? - -> `optional` **watch\_next\_feed**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)[] - -#### Defined in - -[src/parser/ytshorts/ShortFormVideoInfo.ts:11](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytshorts/ShortFormVideoInfo.ts#L11) - -## Accessors - -### actions - -> `get` **actions**(): [`Actions`](../../../classes/Actions.md) - -#### Returns - -[`Actions`](../../../classes/Actions.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`actions`](../../Mixins/classes/MediaInfo.md#actions) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:247](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L247) - -*** - -### cpn - -> `get` **cpn**(): `string` - -Content Playback Nonce. - -#### Returns - -`string` - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`cpn`](../../Mixins/classes/MediaInfo.md#cpn) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:254](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L254) - -*** - -### page - -> `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] - -Parsed InnerTube response. - -#### Returns - -[[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`page`](../../Mixins/classes/MediaInfo.md#page) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:261](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L261) - -*** - -### wn\_has\_continuation - -> `get` **wn\_has\_continuation**(): `boolean` - -Checks if continuation is available for the watch next feed. - -#### Returns - -`boolean` - -#### Defined in - -[src/parser/ytshorts/ShortFormVideoInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytshorts/ShortFormVideoInfo.ts#L47) - -## Methods - -### addToWatchHistory() - -> **addToWatchHistory**(`client_name`?, `client_version`?, `replacement`?): `Promise`\<`Response`\> - -#### Parameters - -• **client\_name?**: `string` - -• **client\_version?**: `string` - -• **replacement?**: `string` = `'https://www.'` - -#### Returns - -`Promise`\<`Response`\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`addToWatchHistory`](../../Mixins/classes/MediaInfo.md#addtowatchhistory) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:208](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L208) - -*** - -### chooseFormat() - -> **chooseFormat**(`options`): [`Format`](../../Misc/classes/Format.md) - -Selects the format that best matches the given options. - -#### Parameters - -• **options**: [`FormatOptions`](../../Types/interfaces/FormatOptions.md) - -Options - -#### Returns - -[`Format`](../../Misc/classes/Format.md) - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`chooseFormat`](../../Mixins/classes/MediaInfo.md#chooseformat) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:161](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L161) - -*** - -### download() - -> **download**(`options`): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -Downloads the video. - -#### Parameters - -• **options**: [`DownloadOptions`](../../Types/interfaces/DownloadOptions.md) = `{}` - -Download options. - -#### Returns - -`Promise`\<`ReadableStream`\<`Uint8Array`\>\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`download`](../../Mixins/classes/MediaInfo.md#download) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:169](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L169) - -*** - -### getStreamingInfo() - -> **getStreamingInfo**(`url_transformer`?, `format_filter`?): `Promise`\<`StreamingInfo`\> - -Get a cleaned up representation of the adaptive_formats - -#### Parameters - -• **url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) - -• **format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) - -#### Returns - -`Promise`\<`StreamingInfo`\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`getStreamingInfo`](../../Mixins/classes/MediaInfo.md#getstreaminginfo) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:144](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L144) - -*** - -### getTranscript() - -> **getTranscript**(): `Promise`\<[`TranscriptInfo`](../../YT/classes/TranscriptInfo.md)\> - -Retrieves the video's transcript. - -#### Returns - -`Promise`\<[`TranscriptInfo`](../../YT/classes/TranscriptInfo.md)\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`getTranscript`](../../Mixins/classes/MediaInfo.md#gettranscript) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:182](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L182) - -*** - -### getWatchNextContinuation() - -> **getWatchNextContinuation**(): `Promise`\<[`ShortFormVideoInfo`](ShortFormVideoInfo.md)\> - -#### Returns - -`Promise`\<[`ShortFormVideoInfo`](ShortFormVideoInfo.md)\> - -#### Defined in - -[src/parser/ytshorts/ShortFormVideoInfo.ts:27](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/ytshorts/ShortFormVideoInfo.ts#L27) - -*** - -### toDash() - -> **toDash**(`options`): `Promise`\<`string`\> - -Generates a DASH manifest from the streaming data. - -#### Parameters - -• **options** = `{}` - -• **options.format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) - -• **options.manifest\_options?**: `DashOptions` - -• **options.url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) - -#### Returns - -`Promise`\<`string`\> - -DASH manifest - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`toDash`](../../Mixins/classes/MediaInfo.md#todash) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:104](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L104) - -*** - -### updateWatchTime() - -> **updateWatchTime**(`startTime`, `client_name`, `client_version`, `replacement`): `Promise`\<`Response`\> - -#### Parameters - -• **startTime**: `number` - -• **client\_name**: `string` = `Constants.CLIENTS.WEB.NAME` - -• **client\_version**: `string` = `Constants.CLIENTS.WEB.VERSION` - -• **replacement**: `string` = `'https://www.'` - -#### Returns - -`Promise`\<`Response`\> - -#### Inherited from - -[`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`updateWatchTime`](../../Mixins/classes/MediaInfo.md#updatewatchtime) - -#### Defined in - -[src/core/mixins/MediaInfo.ts:227](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/mixins/MediaInfo.ts#L227) diff --git a/docs/api/type-aliases/Context.md b/docs/api/type-aliases/Context.md index 1beaaf68..a9c7b3ea 100644 --- a/docs/api/type-aliases/Context.md +++ b/docs/api/type-aliases/Context.md @@ -2,226 +2,238 @@ # Type Alias: Context -> **Context**: `object` +> **Context** = `object` -## Type declaration +Defined in: [src/core/Session.ts:38](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L38) + +## Properties ### client > **client**: `object` -### client.androidSdkVersion? +Defined in: [src/core/Session.ts:39](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L39) + +#### androidSdkVersion? > `optional` **androidSdkVersion**: `number` -### client.browserName? +#### browserName? > `optional` **browserName**: `string` -### client.browserVersion? +#### browserVersion? > `optional` **browserVersion**: `string` -### client.clientFormFactor +#### clientFormFactor > **clientFormFactor**: `string` -### client.clientName +#### clientName > **clientName**: `string` -### client.clientScreen? +#### clientScreen? > `optional` **clientScreen**: `string` -### client.clientVersion +#### clientVersion > **clientVersion**: `string` -### client.configInfo? +#### configInfo? > `optional` **configInfo**: `object` -### client.configInfo.appInstallData? +##### configInfo.appInstallData? > `optional` **appInstallData**: `string` -### client.configInfo.coldConfigData? +##### configInfo.coldConfigData? > `optional` **coldConfigData**: `string` -### client.configInfo.coldHashData? +##### configInfo.coldHashData? > `optional` **coldHashData**: `string` -### client.configInfo.hotHashData? +##### configInfo.hotHashData? > `optional` **hotHashData**: `string` -### client.deviceExperimentId? +#### deviceExperimentId? > `optional` **deviceExperimentId**: `string` -### client.deviceMake +#### deviceMake > **deviceMake**: `string` -### client.deviceModel +#### deviceModel > **deviceModel**: `string` -### client.gl +#### gl > **gl**: `string` -### client.hl +#### hl > **hl**: `string` -### client.kidsAppInfo? +#### kidsAppInfo? > `optional` **kidsAppInfo**: `object` -### client.kidsAppInfo.categorySettings +##### kidsAppInfo.categorySettings > **categorySettings**: `object` -### client.kidsAppInfo.categorySettings.enabledCategories +##### kidsAppInfo.categorySettings.enabledCategories > **enabledCategories**: `string`[] -### client.kidsAppInfo.contentSettings +##### kidsAppInfo.contentSettings > **contentSettings**: `object` -### client.kidsAppInfo.contentSettings.corpusPreference +##### kidsAppInfo.contentSettings.corpusPreference > **corpusPreference**: `string` -### client.kidsAppInfo.contentSettings.kidsNoSearchMode +##### kidsAppInfo.contentSettings.kidsNoSearchMode > **kidsNoSearchMode**: `string` -### client.mainAppWebInfo? +#### mainAppWebInfo? > `optional` **mainAppWebInfo**: `object` -### client.mainAppWebInfo.graftUrl +##### mainAppWebInfo.graftUrl > **graftUrl**: `string` -### client.mainAppWebInfo.isWebNativeShareAvailable +##### mainAppWebInfo.isWebNativeShareAvailable > **isWebNativeShareAvailable**: `boolean` -### client.mainAppWebInfo.pwaInstallabilityStatus +##### mainAppWebInfo.pwaInstallabilityStatus > **pwaInstallabilityStatus**: `string` -### client.mainAppWebInfo.webDisplayMode +##### mainAppWebInfo.webDisplayMode > **webDisplayMode**: `string` -### client.memoryTotalKbytes? +#### memoryTotalKbytes? > `optional` **memoryTotalKbytes**: `string` -### client.originalUrl? +#### originalUrl? > `optional` **originalUrl**: `string` -### client.osName +#### osName > **osName**: `string` -### client.osVersion +#### osVersion > **osVersion**: `string` -### client.platform +#### platform > **platform**: `string` -### client.remoteHost? +#### remoteHost? > `optional` **remoteHost**: `string` -### client.rolloutToken? +#### rolloutToken? > `optional` **rolloutToken**: `string` -### client.screenDensityFloat? +#### screenDensityFloat? > `optional` **screenDensityFloat**: `number` -### client.screenHeightPoints? +#### screenHeightPoints? > `optional` **screenHeightPoints**: `number` -### client.screenPixelDensity? +#### screenPixelDensity? > `optional` **screenPixelDensity**: `number` -### client.screenWidthPoints? +#### screenWidthPoints? > `optional` **screenWidthPoints**: `number` -### client.timeZone +#### timeZone > **timeZone**: `string` -### client.userAgent +#### userAgent > **userAgent**: `string` -### client.userInterfaceTheme? +#### userInterfaceTheme? > `optional` **userInterfaceTheme**: `string` -### client.utcOffsetMinutes +#### utcOffsetMinutes > **utcOffsetMinutes**: `number` -### client.visitorData? +#### visitorData? > `optional` **visitorData**: `string` +*** + ### request? > `optional` **request**: `object` -### request.internalExperimentFlags +Defined in: [src/core/Session.ts:98](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L98) + +#### internalExperimentFlags > **internalExperimentFlags**: `any`[] -### request.useSsl +#### useSsl > **useSsl**: `boolean` +*** + ### thirdParty? > `optional` **thirdParty**: `object` -### thirdParty.embedUrl +Defined in: [src/core/Session.ts:95](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L95) + +#### embedUrl > **embedUrl**: `string` +*** + ### user > **user**: `object` -### user.enableSafetyMode +Defined in: [src/core/Session.ts:90](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L90) + +#### enableSafetyMode > **enableSafetyMode**: `boolean` -### user.lockedSafetyMode +#### lockedSafetyMode > **lockedSafetyMode**: `boolean` -### user.onBehalfOfUser? +#### onBehalfOfUser? > `optional` **onBehalfOfUser**: `string` - -## Defined in - -[src/core/Session.ts:38](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L38) diff --git a/docs/api/type-aliases/DeviceAndUserCode.md b/docs/api/type-aliases/DeviceAndUserCode.md index fc0ae7d4..494b9b32 100644 --- a/docs/api/type-aliases/DeviceAndUserCode.md +++ b/docs/api/type-aliases/DeviceAndUserCode.md @@ -2,34 +2,54 @@ # Type Alias: DeviceAndUserCode -> **DeviceAndUserCode**: `object` +> **DeviceAndUserCode** = `object` -## Type declaration +Defined in: [src/core/OAuth2.ts:22](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L22) + +## Properties ### device\_code > **device\_code**: `string` +Defined in: [src/core/OAuth2.ts:23](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L23) + +*** + ### error\_code? > `optional` **error\_code**: `string` +Defined in: [src/core/OAuth2.ts:28](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L28) + +*** + ### expires\_in > **expires\_in**: `number` +Defined in: [src/core/OAuth2.ts:24](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L24) + +*** + ### interval > **interval**: `number` +Defined in: [src/core/OAuth2.ts:25](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L25) + +*** + ### user\_code > **user\_code**: `string` +Defined in: [src/core/OAuth2.ts:26](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L26) + +*** + ### verification\_url > **verification\_url**: `string` -## Defined in - -[src/core/OAuth2.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L22) +Defined in: [src/core/OAuth2.ts:27](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L27) diff --git a/docs/api/type-aliases/InnertubeEndpoint.md b/docs/api/type-aliases/InnertubeEndpoint.md index 47fbbe45..213f1173 100644 --- a/docs/api/type-aliases/InnertubeEndpoint.md +++ b/docs/api/type-aliases/InnertubeEndpoint.md @@ -2,8 +2,6 @@ # Type Alias: InnertubeEndpoint -> **InnertubeEndpoint**: `"/player"` \| `"/search"` \| `"/browse"` \| `"/next"` \| `"/reel"` \| `"/updated_metadata"` \| `"/notification/get_notification_menu"` \| `"/att/get"` \| `string` +> **InnertubeEndpoint** = `"/player"` \| `"/search"` \| `"/browse"` \| `"/next"` \| `"/reel"` \| `"/updated_metadata"` \| `"/notification/get_notification_menu"` \| `"/att/get"` \| `string` -## Defined in - -[src/core/Actions.ts:24](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L24) +Defined in: [src/core/Actions.ts:24](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L24) diff --git a/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md b/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md index 032bb443..1e40733d 100644 --- a/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md +++ b/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md @@ -2,16 +2,16 @@ # Type Alias: OAuth2AuthErrorEventHandler() -> **OAuth2AuthErrorEventHandler**: (`err`) => `void` +> **OAuth2AuthErrorEventHandler** = (`err`) => `void` + +Defined in: [src/core/OAuth2.ts:33](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L33) ## Parameters -• **err**: [`OAuth2Error`](../namespaces/Utils/classes/OAuth2Error.md) +### err + +[`OAuth2Error`](../youtubei.js/namespaces/Utils/classes/OAuth2Error.md) ## Returns `void` - -## Defined in - -[src/core/OAuth2.ts:33](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L33) diff --git a/docs/api/type-aliases/OAuth2AuthEventHandler.md b/docs/api/type-aliases/OAuth2AuthEventHandler.md index 3a6166e3..8f449110 100644 --- a/docs/api/type-aliases/OAuth2AuthEventHandler.md +++ b/docs/api/type-aliases/OAuth2AuthEventHandler.md @@ -2,18 +2,18 @@ # Type Alias: OAuth2AuthEventHandler() -> **OAuth2AuthEventHandler**: (`data`) => `void` +> **OAuth2AuthEventHandler** = (`data`) => `void` + +Defined in: [src/core/OAuth2.ts:31](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L31) ## Parameters -• **data** +### data -• **data.credentials**: [`OAuth2Tokens`](OAuth2Tokens.md) +#### credentials + +[`OAuth2Tokens`](OAuth2Tokens.md) ## Returns `void` - -## Defined in - -[src/core/OAuth2.ts:31](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L31) diff --git a/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md b/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md index 84b4f9dc..06db3508 100644 --- a/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md +++ b/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md @@ -2,16 +2,16 @@ # Type Alias: OAuth2AuthPendingEventHandler() -> **OAuth2AuthPendingEventHandler**: (`data`) => `void` +> **OAuth2AuthPendingEventHandler** = (`data`) => `void` + +Defined in: [src/core/OAuth2.ts:32](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L32) ## Parameters -• **data**: [`DeviceAndUserCode`](DeviceAndUserCode.md) +### data + +[`DeviceAndUserCode`](DeviceAndUserCode.md) ## Returns `void` - -## Defined in - -[src/core/OAuth2.ts:32](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L32) diff --git a/docs/api/type-aliases/OAuth2ClientID.md b/docs/api/type-aliases/OAuth2ClientID.md index 432c189e..3df8f89e 100644 --- a/docs/api/type-aliases/OAuth2ClientID.md +++ b/docs/api/type-aliases/OAuth2ClientID.md @@ -2,18 +2,22 @@ # Type Alias: OAuth2ClientID -> **OAuth2ClientID**: `object` +> **OAuth2ClientID** = `object` -## Type declaration +Defined in: [src/core/OAuth2.ts:7](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L7) + +## Properties ### client\_id > **client\_id**: `string` +Defined in: [src/core/OAuth2.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L8) + +*** + ### client\_secret > **client\_secret**: `string` -## Defined in - -[src/core/OAuth2.ts:7](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L7) +Defined in: [src/core/OAuth2.ts:9](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L9) diff --git a/docs/api/type-aliases/OAuth2Tokens.md b/docs/api/type-aliases/OAuth2Tokens.md index b42a3184..e237e932 100644 --- a/docs/api/type-aliases/OAuth2Tokens.md +++ b/docs/api/type-aliases/OAuth2Tokens.md @@ -2,38 +2,62 @@ # Type Alias: OAuth2Tokens -> **OAuth2Tokens**: `object` +> **OAuth2Tokens** = `object` -## Type declaration +Defined in: [src/core/OAuth2.ts:12](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L12) + +## Properties ### access\_token > **access\_token**: `string` +Defined in: [src/core/OAuth2.ts:13](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L13) + +*** + ### client? > `optional` **client**: [`OAuth2ClientID`](OAuth2ClientID.md) +Defined in: [src/core/OAuth2.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L19) + +*** + ### expires\_in? > `optional` **expires\_in**: `number` +Defined in: [src/core/OAuth2.ts:15](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L15) + +*** + ### expiry\_date > **expiry\_date**: `string` +Defined in: [src/core/OAuth2.ts:14](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L14) + +*** + ### refresh\_token > **refresh\_token**: `string` +Defined in: [src/core/OAuth2.ts:16](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L16) + +*** + ### scope? > `optional` **scope**: `string` +Defined in: [src/core/OAuth2.ts:17](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L17) + +*** + ### token\_type? > `optional` **token\_type**: `string` -## Defined in - -[src/core/OAuth2.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/OAuth2.ts#L12) +Defined in: [src/core/OAuth2.ts:18](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/OAuth2.ts#L18) diff --git a/docs/api/type-aliases/ParsedResponse.md b/docs/api/type-aliases/ParsedResponse.md index b0a1062b..29114418 100644 --- a/docs/api/type-aliases/ParsedResponse.md +++ b/docs/api/type-aliases/ParsedResponse.md @@ -2,12 +2,12 @@ # Type Alias: ParsedResponse\ -> **ParsedResponse**\<`T`\>: `T` *extends* `"/player"` ? [`IPlayerResponse`](../namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md) : `T` *extends* `"/search"` ? [`ISearchResponse`](../namespaces/APIResponseTypes/type-aliases/ISearchResponse.md) : `T` *extends* `"/browse"` ? [`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md) : `T` *extends* `"/next"` ? [`INextResponse`](../namespaces/APIResponseTypes/type-aliases/INextResponse.md) : `T` *extends* `"/updated_metadata"` ? [`IUpdatedMetadataResponse`](../namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md) : `T` *extends* `"/navigation/resolve_url"` ? [`IResolveURLResponse`](../namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md) : `T` *extends* `"/notification/get_notification_menu"` ? [`IGetNotificationsMenuResponse`](../namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md) : `T` *extends* `"/att/get"` ? [`IGetChallengeResponse`](../namespaces/APIResponseTypes/type-aliases/IGetChallengeResponse.md) : [`IParsedResponse`](../namespaces/APIResponseTypes/interfaces/IParsedResponse.md) +> **ParsedResponse**\<`T`\> = `T` *extends* `"/player"` ? [`IPlayerResponse`](IPlayerResponse.md) : `T` *extends* `"/search"` ? [`ISearchResponse`](ISearchResponse.md) : `T` *extends* `"/browse"` ? [`IBrowseResponse`](IBrowseResponse.md) : `T` *extends* `"/next"` ? [`INextResponse`](INextResponse.md) : `T` *extends* `"/updated_metadata"` ? [`IUpdatedMetadataResponse`](IUpdatedMetadataResponse.md) : `T` *extends* `"/navigation/resolve_url"` ? [`IResolveURLResponse`](IResolveURLResponse.md) : `T` *extends* `"/notification/get_notification_menu"` ? [`IGetNotificationsMenuResponse`](IGetNotificationsMenuResponse.md) : `T` *extends* `"/att/get"` ? [`IGetChallengeResponse`](IGetChallengeResponse.md) : [`IParsedResponse`](../interfaces/IParsedResponse.md) + +Defined in: [src/core/Actions.ts:35](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L35) ## Type Parameters -• **T** +### T -## Defined in - -[src/core/Actions.ts:35](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L35) +`T` diff --git a/docs/api/type-aliases/SWSessionData.md b/docs/api/type-aliases/SWSessionData.md index a9c27fee..6fabab12 100644 --- a/docs/api/type-aliases/SWSessionData.md +++ b/docs/api/type-aliases/SWSessionData.md @@ -2,22 +2,30 @@ # Type Alias: SWSessionData -> **SWSessionData**: `object` +> **SWSessionData** = `object` -## Type declaration +Defined in: [src/core/Session.ts:228](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L228) + +## Properties ### api\_key > **api\_key**: `string` +Defined in: [src/core/Session.ts:230](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L230) + +*** + ### api\_version > **api\_version**: `string` +Defined in: [src/core/Session.ts:231](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L231) + +*** + ### context\_data > **context\_data**: `ContextData` -## Defined in - -[src/core/Session.ts:228](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L228) +Defined in: [src/core/Session.ts:229](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L229) diff --git a/docs/api/type-aliases/SessionArgs.md b/docs/api/type-aliases/SessionArgs.md index 94892cc1..654ec316 100644 --- a/docs/api/type-aliases/SessionArgs.md +++ b/docs/api/type-aliases/SessionArgs.md @@ -2,46 +2,78 @@ # Type Alias: SessionArgs -> **SessionArgs**: `object` +> **SessionArgs** = `object` -## Type declaration +Defined in: [src/core/Session.ts:234](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L234) + +## Properties ### client\_name > **client\_name**: [`ClientType`](../enumerations/ClientType.md) +Defined in: [src/core/Session.ts:240](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L240) + +*** + ### device\_category -> **device\_category**: [`DeviceCategory`](../namespaces/Utils/type-aliases/DeviceCategory.md) +> **device\_category**: [`DeviceCategory`](../youtubei.js/namespaces/Utils/type-aliases/DeviceCategory.md) + +Defined in: [src/core/Session.ts:239](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L239) + +*** ### enable\_safety\_mode > **enable\_safety\_mode**: `boolean` +Defined in: [src/core/Session.ts:241](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L241) + +*** + ### lang > **lang**: `string` +Defined in: [src/core/Session.ts:235](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L235) + +*** + ### location > **location**: `string` +Defined in: [src/core/Session.ts:236](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L236) + +*** + ### on\_behalf\_of\_user > **on\_behalf\_of\_user**: `string` \| `undefined` +Defined in: [src/core/Session.ts:243](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L243) + +*** + ### time\_zone > **time\_zone**: `string` +Defined in: [src/core/Session.ts:237](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L237) + +*** + ### user\_agent > **user\_agent**: `string` +Defined in: [src/core/Session.ts:238](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L238) + +*** + ### visitor\_data > **visitor\_data**: `string` -## Defined in - -[src/core/Session.ts:234](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L234) +Defined in: [src/core/Session.ts:242](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L242) diff --git a/docs/api/type-aliases/SessionData.md b/docs/api/type-aliases/SessionData.md index 05b70c2e..bd91efe8 100644 --- a/docs/api/type-aliases/SessionData.md +++ b/docs/api/type-aliases/SessionData.md @@ -2,26 +2,38 @@ # Type Alias: SessionData -> **SessionData**: `object` +> **SessionData** = `object` -## Type declaration +Defined in: [src/core/Session.ts:217](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L217) + +## Properties ### api\_key > **api\_key**: `string` +Defined in: [src/core/Session.ts:219](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L219) + +*** + ### api\_version > **api\_version**: `string` +Defined in: [src/core/Session.ts:220](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L220) + +*** + ### config\_data? > `optional` **config\_data**: `string` +Defined in: [src/core/Session.ts:221](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L221) + +*** + ### context > **context**: [`Context`](Context.md) -## Defined in - -[src/core/Session.ts:217](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L217) +Defined in: [src/core/Session.ts:218](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L218) diff --git a/docs/api/type-aliases/SessionOptions.md b/docs/api/type-aliases/SessionOptions.md index f97cded3..d36d3601 100644 --- a/docs/api/type-aliases/SessionOptions.md +++ b/docs/api/type-aliases/SessionOptions.md @@ -2,135 +2,207 @@ # Type Alias: SessionOptions -> **SessionOptions**: `object` +> **SessionOptions** = `object` -## Type declaration +Defined in: [src/core/Session.ts:127](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L127) + +## Properties ### account\_index? > `optional` **account\_index**: `number` +Defined in: [src/core/Session.ts:145](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L145) + The account index to use. This is useful if you have multiple accounts logged in. **NOTE:** Only works if you are signed in with cookies. +*** + ### cache? -> `optional` **cache**: [`ICache`](../namespaces/Types/interfaces/ICache.md) +> `optional` **cache**: [`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) + +Defined in: [src/core/Session.ts:191](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L191) Used to cache algorithms, session data, and OAuth2 tokens. +*** + ### client\_type? > `optional` **client\_type**: [`ClientType`](../enumerations/ClientType.md) +Defined in: [src/core/Session.ts:183](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L183) + InnerTube client type. +*** + ### cookie? > `optional` **cookie**: `string` +Defined in: [src/core/Session.ts:195](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L195) + YouTube cookies. +*** + ### device\_category? -> `optional` **device\_category**: [`DeviceCategory`](../namespaces/Utils/type-aliases/DeviceCategory.md) +> `optional` **device\_category**: [`DeviceCategory`](../youtubei.js/namespaces/Utils/type-aliases/DeviceCategory.md) + +Defined in: [src/core/Session.ts:179](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L179) Platform to use for the session. +*** + ### enable\_safety\_mode? > `optional` **enable\_safety\_mode**: `boolean` +Defined in: [src/core/Session.ts:159](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L159) + Specifies whether to enable safety mode. This will prevent the session from loading any potentially unsafe content. +*** + ### enable\_session\_cache? > `optional` **enable\_session\_cache**: `boolean` +Defined in: [src/core/Session.ts:175](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L175) + Specifies whether the session data should be cached. +*** + ### fetch? -> `optional` **fetch**: [`FetchFunction`](../namespaces/Types/type-aliases/FetchFunction.md) +> `optional` **fetch**: [`FetchFunction`](../youtubei.js/namespaces/Types/type-aliases/FetchFunction.md) + +Defined in: [src/core/Session.ts:204](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L204) Fetch function to use. +*** + ### generate\_session\_locally? > `optional` **generate\_session\_locally**: `boolean` +Defined in: [src/core/Session.ts:171](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L171) + Specifies whether to generate the session data locally or retrieve it from YouTube. This can be useful if you need more performance. **NOTE:** If you are using the cache option and a session has already been generated, this will be ignored. If you want to force a new session to be generated, you must clear the cache or disable session caching. +*** + ### lang? > `optional` **lang**: `string` +Defined in: [src/core/Session.ts:131](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L131) + Language. +*** + ### location? > `optional` **location**: `string` +Defined in: [src/core/Session.ts:135](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L135) + Geolocation. +*** + ### on\_behalf\_of\_user? > `optional` **on\_behalf\_of\_user**: `string` +Defined in: [src/core/Session.ts:149](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L149) + Specify the Page ID of the YouTube profile/channel to use, if the logged-in account has multiple profiles. +*** + ### player\_id? > `optional` **player\_id**: `string` +Defined in: [src/core/Session.ts:214](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L214) + Player ID override. In most cases, this isn't necessary; but when YouTube introduces breaking changes, forcing an older Player ID can help work around temporary issues. +*** + ### po\_token? > `optional` **po\_token**: `string` +Defined in: [src/core/Session.ts:208](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L208) + Session bound Proof of Origin Token. This is an attestation token generated by BotGuard/DroidGuard. It is used to confirm that the request is coming from a real client. +*** + ### retrieve\_innertube\_config? > `optional` **retrieve\_innertube\_config**: `boolean` +Defined in: [src/core/Session.ts:163](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L163) + Specifies whether to retrieve the InnerTube config. Useful for "onesie" requests. +*** + ### retrieve\_player? > `optional` **retrieve\_player**: `boolean` +Defined in: [src/core/Session.ts:155](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L155) + Specifies whether to retrieve the JS player. Disabling this will make session creation faster. **NOTE:** Deciphering formats is not possible without the JS player. +*** + ### timezone? > `optional` **timezone**: `string` +Defined in: [src/core/Session.ts:187](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L187) + The time zone. +*** + ### user\_agent? > `optional` **user\_agent**: `string` +Defined in: [src/core/Session.ts:139](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L139) + User agent (InnerTube requests only). +*** + ### visitor\_data? > `optional` **visitor\_data**: `string` +Defined in: [src/core/Session.ts:200](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Session.ts#L200) + Setting this to a valid and persistent visitor data string will allow YouTube to give this session tailored content even when not logged in. A good way to get a valid one is by either grabbing it from a browser or calling InnerTube's `/visitor_id` endpoint. - -## Defined in - -[src/core/Session.ts:127](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Session.ts#L127) diff --git a/package-lock.json b/package-lock.json index 5ed0f32e..698fa851 100644 --- a/package-lock.json +++ b/package-lock.json @@ -30,7 +30,7 @@ "ts-patch": "^3.0.2", "ts-proto": "^2.2.0", "typedoc": "^0.28.14", - "typedoc-plugin-markdown": "^4.2.7", + "typedoc-plugin-markdown": "^4.9.0", "typescript": "^5.0.0", "typescript-eslint": "^8.2.0", "vitest": "^3.2.4" @@ -4773,15 +4773,16 @@ } }, "node_modules/typedoc-plugin-markdown": { - "version": "4.2.7", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.2.7.tgz", - "integrity": "sha512-bLsQdweSm48P9j6kGqQ3/4GCH5zu2EnURSkkxqirNc+uVFE9YK825ogDw+WbNkRHIV6eZK/1U43gT7YfglyYOg==", + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.9.0.tgz", + "integrity": "sha512-9Uu4WR9L7ZBgAl60N/h+jqmPxxvnC9nQAlnnO/OujtG2ubjnKTVUFY1XDhcMY+pCqlX3N2HsQM2QTYZIU9tJuw==", "dev": true, + "license": "MIT", "engines": { "node": ">= 18" }, "peerDependencies": { - "typedoc": "0.26.x" + "typedoc": "0.28.x" } }, "node_modules/typedoc/node_modules/brace-expansion": { diff --git a/package.json b/package.json index b937ff13..368a8fb9 100644 --- a/package.json +++ b/package.json @@ -123,7 +123,7 @@ "ts-patch": "^3.0.2", "ts-proto": "^2.2.0", "typedoc": "^0.28.14", - "typedoc-plugin-markdown": "^4.2.7", + "typedoc-plugin-markdown": "^4.9.0", "typescript": "^5.0.0", "typescript-eslint": "^8.2.0", "vitest": "^3.2.4"