diff --git a/docs/api/README.md b/docs/api/README.md index e667692a..10a0b2de 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -2,30 +2,108 @@ ## 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) + +*** + ### CpnSource Re-exports [CpnSource](namespaces/APIResponseTypes/type-aliases/CpnSource.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) + +*** + ### IBrowseResponse Re-exports [IBrowseResponse](namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md) *** +### IEndpoint + +Re-exports [IEndpoint](namespaces/APIResponseTypes/interfaces/IEndpoint.md) + +*** + ### IGetNotificationsMenuResponse Re-exports [IGetNotificationsMenuResponse](namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md) @@ -50,6 +128,12 @@ Re-exports [INextResponse](namespaces/APIResponseTypes/type-aliases/INextRespons *** +### InlineSettingStatus + +Re-exports [InlineSettingStatus](namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md) + +*** + ### IParsedResponse Re-exports [IParsedResponse](namespaces/APIResponseTypes/interfaces/IParsedResponse.md) @@ -128,6 +212,54 @@ Re-exports [IUpdatedMetadataResponse](namespaces/APIResponseTypes/type-aliases/I *** +### 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) @@ -138,15 +270,57 @@ Re-exports [RawData](namespaces/APIResponseTypes/type-aliases/RawData.md) 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) - [Clients](namespaces/Clients/README.md) - [Constants](namespaces/Constants/README.md) -- [Endpoints](namespaces/Endpoints/README.md) - [FormatUtils](namespaces/FormatUtils/README.md) - [Generator](namespaces/Generator/README.md) - [Helpers](namespaces/Helpers/README.md) +- [Log](namespaces/Log/README.md) - [LZW](namespaces/LZW/README.md) - [Managers](namespaces/Managers/README.md) - [Misc](namespaces/Misc/README.md) @@ -176,7 +350,6 @@ Re-exports [RawNode](namespaces/APIResponseTypes/type-aliases/RawNode.md) - [Innertube](classes/Innertube.md) - [ItemSectionContinuation](classes/ItemSectionContinuation.md) - [LiveChatContinuation](classes/LiveChatContinuation.md) -- [Log](classes/Log.md) - [MusicPlaylistShelfContinuation](classes/MusicPlaylistShelfContinuation.md) - [MusicShelfContinuation](classes/MusicShelfContinuation.md) - [NavigateAction](classes/NavigateAction.md) diff --git a/docs/api/classes/Actions.md b/docs/api/classes/Actions.md index 74949979..5329d68a 100644 --- a/docs/api/classes/Actions.md +++ b/docs/api/classes/Actions.md @@ -18,7 +18,7 @@ #### Defined in -[src/core/Actions.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L34) +[src/core/Actions.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L33) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/core/Actions.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L32) +[src/core/Actions.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L31) ## Methods @@ -66,7 +66,7 @@ Call arguments ##### Defined in -[src/core/Actions.ts:78](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L78) +[src/core/Actions.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L75) #### execute(endpoint, args) @@ -94,7 +94,7 @@ Call arguments ##### Defined in -[src/core/Actions.ts:79](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L79) +[src/core/Actions.ts:76](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L76) *** @@ -128,4 +128,4 @@ Call parameters. #### Defined in -[src/core/Actions.ts:56](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L56) +[src/core/Actions.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L55) diff --git a/docs/api/classes/Continuation.md b/docs/api/classes/Continuation.md index 2c7a1e1d..1fa069b2 100644 --- a/docs/api/classes/Continuation.md +++ b/docs/api/classes/Continuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L147) +[src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L147) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L142) +[src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L142) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L144) +[src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L144) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L143) +[src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L143) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L145) +[src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L145) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L140) +[src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L140) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/ContinuationCommand.md b/docs/api/classes/ContinuationCommand.md index 84de52f3..67c7388d 100644 --- a/docs/api/classes/ContinuationCommand.md +++ b/docs/api/classes/ContinuationCommand.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L220) +[src/parser/continuations.ts:220](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L220) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:217](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L217) +[src/parser/continuations.ts:217](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L217) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:218](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L218) +[src/parser/continuations.ts:218](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L218) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:215](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L215) +[src/parser/continuations.ts:215](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L215) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/EventEmitter.md b/docs/api/classes/EventEmitter.md index 51289b25..c8ccef8e 100644 --- a/docs/api/classes/EventEmitter.md +++ b/docs/api/classes/EventEmitter.md @@ -27,7 +27,7 @@ #### Defined in -[src/utils/EventEmitterLike.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L6) +[src/utils/EventEmitterLike.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L6) ## Methods @@ -69,7 +69,7 @@ The event listener is appended to target's event listener list and is not append #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8303 +node\_modules/typescript/lib/lib.dom.d.ts:8256 *** @@ -95,7 +95,7 @@ Dispatches a synthetic event event to target and returns true if either event's #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8309 +node\_modules/typescript/lib/lib.dom.d.ts:8262 *** @@ -115,7 +115,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L10) +[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L10) *** @@ -135,7 +135,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L40) +[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L40) *** @@ -155,7 +155,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L15) +[src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L15) *** @@ -175,7 +175,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/utils/EventEmitterLike.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L27) +[src/utils/EventEmitterLike.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L27) *** @@ -205,4 +205,4 @@ Removes the event listener in target's event listener list with the same type, c #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8315 +node\_modules/typescript/lib/lib.dom.d.ts:8268 diff --git a/docs/api/classes/GridContinuation.md b/docs/api/classes/GridContinuation.md index 414a7f56..579fb21d 100644 --- a/docs/api/classes/GridContinuation.md +++ b/docs/api/classes/GridContinuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:114](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L114) +[src/parser/continuations.ts:114](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L114) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L111) +[src/parser/continuations.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L111) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:112](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L112) +[src/parser/continuations.ts:112](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L112) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:109](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L109) +[src/parser/continuations.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L109) ## Accessors @@ -88,7 +88,7 @@ #### Defined in -[src/parser/continuations.ts:120](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L120) +[src/parser/continuations.ts:120](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L120) ## Methods @@ -108,17 +108,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -152,7 +160,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -186,7 +194,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -224,4 +232,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/HTTPClient.md b/docs/api/classes/HTTPClient.md index a81bc92a..71f5cd93 100644 --- a/docs/api/classes/HTTPClient.md +++ b/docs/api/classes/HTTPClient.md @@ -22,7 +22,7 @@ #### Defined in -[src/utils/HTTPClient.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/HTTPClient.ts#L23) +[src/utils/HTTPClient.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/HTTPClient.ts#L23) ## Accessors @@ -48,7 +48,7 @@ #### Defined in -[src/utils/HTTPClient.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/HTTPClient.ts#L29) +[src/utils/HTTPClient.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/HTTPClient.ts#L29) ## Methods @@ -68,4 +68,4 @@ #### Defined in -[src/utils/HTTPClient.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/HTTPClient.ts#L33) +[src/utils/HTTPClient.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/HTTPClient.ts#L33) diff --git a/docs/api/classes/Innertube.md b/docs/api/classes/Innertube.md index c655193f..38379644 100644 --- a/docs/api/classes/Innertube.md +++ b/docs/api/classes/Innertube.md @@ -27,7 +27,7 @@ const innertube = await Innertube.create({ cache: new UniversalCache(true)}); #### Defined in -[src/Innertube.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L65) +[src/Innertube.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L55) ## Accessors @@ -43,7 +43,7 @@ An interface for managing and retrieving account information. #### Defined in -[src/Innertube.ts:481](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L481) +[src/Innertube.ts:466](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L466) *** @@ -59,7 +59,7 @@ An internal class used to dispatch requests. #### Defined in -[src/Innertube.ts:502](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L502) +[src/Innertube.ts:487](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L487) *** @@ -75,7 +75,7 @@ An interface for directly interacting with certain YouTube features. #### Defined in -[src/Innertube.ts:495](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L495) +[src/Innertube.ts:480](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L480) *** @@ -91,7 +91,7 @@ An interface for interacting with YouTube Kids. #### Defined in -[src/Innertube.ts:474](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L474) +[src/Innertube.ts:459](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L459) *** @@ -107,7 +107,7 @@ An interface for interacting with YouTube Music. #### Defined in -[src/Innertube.ts:460](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L460) +[src/Innertube.ts:445](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L445) *** @@ -123,7 +123,7 @@ An interface for managing playlists. #### Defined in -[src/Innertube.ts:488](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L488) +[src/Innertube.ts:473](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L473) *** @@ -139,7 +139,7 @@ The session used by this instance. #### Defined in -[src/Innertube.ts:509](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L509) +[src/Innertube.ts:494](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L494) *** @@ -155,7 +155,7 @@ An interface for interacting with YouTube Studio. #### Defined in -[src/Innertube.ts:467](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L467) +[src/Innertube.ts:452](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L452) ## Methods @@ -185,7 +185,7 @@ Utility method to call an endpoint without having to use [Actions](Actions.md). ##### Defined in -[src/Innertube.ts:451](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L451) +[src/Innertube.ts:436](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L436) #### call(endpoint, args) @@ -205,7 +205,7 @@ Utility method to call an endpoint without having to use [Actions](Actions.md). ##### Defined in -[src/Innertube.ts:452](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L452) +[src/Innertube.ts:437](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L437) *** @@ -232,7 +232,7 @@ Download options. #### Defined in -[src/Innertube.ts:429](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L429) +[src/Innertube.ts:416](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L416) *** @@ -252,7 +252,7 @@ Download options. #### Defined in -[src/Innertube.ts:113](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L113) +[src/Innertube.ts:102](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L102) *** @@ -270,7 +270,7 @@ Download options. #### Defined in -[src/Innertube.ts:337](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L337) +[src/Innertube.ts:335](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L335) *** @@ -284,7 +284,7 @@ Download options. #### Defined in -[src/Innertube.ts:330](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L330) +[src/Innertube.ts:329](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L329) *** @@ -306,7 +306,21 @@ Download options. #### Defined in -[src/Innertube.ts:256](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L256) +[src/Innertube.ts:250](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L250) + +*** + +### getCourses() + +> **getCourses**(): `Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> + +#### Returns + +`Promise`\<[`Feed`](../namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md)\>\> + +#### Defined in + +[src/Innertube.ts:317](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L317) *** @@ -314,15 +328,13 @@ Download options. > **getGuide**(): `Promise`\<[`Guide`](../namespaces/YT/classes/Guide.md)\> -Retrieves YouTube's content guide. - #### Returns `Promise`\<[`Guide`](../namespaces/YT/classes/Guide.md)\> #### Defined in -[src/Innertube.ts:297](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L297) +[src/Innertube.ts:294](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L294) *** @@ -340,7 +352,7 @@ Retrieves YouTube's content guide. #### Defined in -[src/Innertube.ts:384](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L384) +[src/Innertube.ts:375](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L375) *** @@ -354,7 +366,7 @@ Retrieves YouTube's content guide. #### Defined in -[src/Innertube.ts:309](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L309) +[src/Innertube.ts:305](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L305) *** @@ -368,7 +380,7 @@ Retrieves YouTube's content guide. #### Defined in -[src/Innertube.ts:287](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L287) +[src/Innertube.ts:288](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L288) *** @@ -388,7 +400,7 @@ Retrieves YouTube's content guide. #### Defined in -[src/Innertube.ts:73](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L73) +[src/Innertube.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L63) *** @@ -402,7 +414,7 @@ Retrieves YouTube's content guide. #### Defined in -[src/Innertube.ts:302](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L302) +[src/Innertube.ts:299](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L299) *** @@ -416,7 +428,7 @@ Retrieves YouTube's content guide. #### Defined in -[src/Innertube.ts:345](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L345) +[src/Innertube.ts:342](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L342) *** @@ -434,7 +446,7 @@ Retrieves YouTube's content guide. #### Defined in -[src/Innertube.ts:370](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L370) +[src/Innertube.ts:362](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L362) *** @@ -450,7 +462,7 @@ Retrieves the user's playlists. #### Defined in -[src/Innertube.ts:363](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L363) +[src/Innertube.ts:356](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L356) *** @@ -468,7 +480,7 @@ Retrieves the user's playlists. #### Defined in -[src/Innertube.ts:235](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L235) +[src/Innertube.ts:231](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L231) *** @@ -488,7 +500,7 @@ Retrieves the user's playlists. #### Defined in -[src/Innertube.ts:130](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L130) +[src/Innertube.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L127) *** @@ -517,7 +529,7 @@ Format options. #### Defined in -[src/Innertube.ts:414](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L414) +[src/Innertube.ts:401](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L401) *** @@ -531,7 +543,7 @@ Format options. #### Defined in -[src/Innertube.ts:323](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L323) +[src/Innertube.ts:323](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L323) *** @@ -545,7 +557,7 @@ Format options. #### Defined in -[src/Innertube.ts:316](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L316) +[src/Innertube.ts:311](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L311) *** @@ -559,7 +571,7 @@ Format options. #### Defined in -[src/Innertube.ts:354](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L354) +[src/Innertube.ts:347](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L347) *** @@ -579,7 +591,7 @@ Resolves the given URL. #### Defined in -[src/Innertube.ts:437](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L437) +[src/Innertube.ts:424](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L424) *** @@ -599,7 +611,7 @@ Resolves the given URL. #### Defined in -[src/Innertube.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L161) +[src/Innertube.ts:160](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L160) *** @@ -617,4 +629,4 @@ Resolves the given URL. #### Defined in -[src/Innertube.ts:69](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/Innertube.ts#L69) +[src/Innertube.ts:59](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/Innertube.ts#L59) diff --git a/docs/api/classes/ItemSectionContinuation.md b/docs/api/classes/ItemSectionContinuation.md index 4aa8b0bf..a44d9f18 100644 --- a/docs/api/classes/ItemSectionContinuation.md +++ b/docs/api/classes/ItemSectionContinuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L15) +[src/parser/continuations.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L12) +[src/parser/continuations.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L13) +[src/parser/continuations.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L13) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L10) +[src/parser/continuations.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L10) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/LiveChatContinuation.md b/docs/api/classes/LiveChatContinuation.md index 06b49041..0c4218bb 100644 --- a/docs/api/classes/LiveChatContinuation.md +++ b/docs/api/classes/LiveChatContinuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:174](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L174) +[src/parser/continuations.ts:174](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L174) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:160](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L160) +[src/parser/continuations.ts:160](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L160) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:159](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L159) +[src/parser/continuations.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L159) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/continuations.ts:171](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L171) +[src/parser/continuations.ts:171](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L171) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/continuations.ts:165](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L165) +[src/parser/continuations.ts:165](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L165) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/continuations.ts:162](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L162) +[src/parser/continuations.ts:162](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L162) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/continuations.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L161) +[src/parser/continuations.ts:161](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L161) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/continuations.ts:163](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L163) +[src/parser/continuations.ts:163](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L163) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/continuations.ts:164](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L164) +[src/parser/continuations.ts:164](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L164) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/continuations.ts:172](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L172) +[src/parser/continuations.ts:172](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L172) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/continuations.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L157) +[src/parser/continuations.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L157) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/Log.md b/docs/api/classes/Log.md deleted file mode 100644 index be1d014e..00000000 --- a/docs/api/classes/Log.md +++ /dev/null @@ -1,161 +0,0 @@ -[youtubei.js](../README.md) / Log - -# Class: Log - -## Constructors - -### new Log() - -> **new Log**(): [`Log`](Log.md) - -#### Returns - -[`Log`](Log.md) - -## Properties - -### Level - -> `static` **Level**: `object` - -#### DEBUG - -> **DEBUG**: `number` = `4` - -#### ERROR - -> **ERROR**: `number` = `1` - -#### INFO - -> **INFO**: `number` = `3` - -#### NONE - -> **NONE**: `number` = `0` - -#### WARNING - -> **WARNING**: `number` = `2` - -#### Defined in - -[src/utils/Log.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Log.ts#L4) - -## Methods - -### debug() - -> `static` **debug**(`tag`?, ...`args`?): `void` - -#### Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -#### Returns - -`void` - -#### Defined in - -[src/utils/Log.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Log.ts#L32) - -*** - -### error() - -> `static` **error**(`tag`?, ...`args`?): `void` - -#### Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -#### Returns - -`void` - -#### Defined in - -[src/utils/Log.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Log.ts#L30) - -*** - -### info() - -> `static` **info**(`tag`?, ...`args`?): `void` - -#### Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -#### Returns - -`void` - -#### Defined in - -[src/utils/Log.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Log.ts#L31) - -*** - -### setLevel() - -> `static` **setLevel**(...`args`): `void` - -#### Parameters - -• ...**args**: `number`[] - -#### Returns - -`void` - -#### Defined in - -[src/utils/Log.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Log.ts#L46) - -*** - -### warn() - -> `static` **warn**(`tag`?, ...`args`?): `void` - -#### Parameters - -• **tag?**: `string` - -• ...**args?**: `any`[] - -#### Returns - -`void` - -#### Defined in - -[src/utils/Log.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Log.ts#L29) - -*** - -### warnOnce() - -> `static` **warnOnce**(`id`, ...`args`): `void` - -#### Parameters - -• **id**: `string` - -• ...**args**: `any`[] - -#### Returns - -`void` - -#### Defined in - -[src/utils/Log.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Log.ts#L22) diff --git a/docs/api/classes/MusicPlaylistShelfContinuation.md b/docs/api/classes/MusicPlaylistShelfContinuation.md index 31b5eefc..39757c6f 100644 --- a/docs/api/classes/MusicPlaylistShelfContinuation.md +++ b/docs/api/classes/MusicPlaylistShelfContinuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:86](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L86) +[src/parser/continuations.ts:86](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L86) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:84](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L84) +[src/parser/continuations.ts:84](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L84) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:83](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L83) +[src/parser/continuations.ts:83](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L83) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:81](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L81) +[src/parser/continuations.ts:81](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L81) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/MusicShelfContinuation.md b/docs/api/classes/MusicShelfContinuation.md index 1facba17..001b02fe 100644 --- a/docs/api/classes/MusicShelfContinuation.md +++ b/docs/api/classes/MusicShelfContinuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:99](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L99) +[src/parser/continuations.ts:99](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L99) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L97) +[src/parser/continuations.ts:97](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L97) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:96](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L96) +[src/parser/continuations.ts:96](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L96) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:94](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L94) +[src/parser/continuations.ts:94](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L94) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/NavigateAction.md b/docs/api/classes/NavigateAction.md index 78175d00..a7d1bd7d 100644 --- a/docs/api/classes/NavigateAction.md +++ b/docs/api/classes/NavigateAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L29) +[src/parser/continuations.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L29) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L27) +[src/parser/continuations.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L27) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/continuations.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L25) +[src/parser/continuations.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L25) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/OAuth2.md b/docs/api/classes/OAuth2.md index 54bbd4d3..14334149 100644 --- a/docs/api/classes/OAuth2.md +++ b/docs/api/classes/OAuth2.md @@ -18,7 +18,7 @@ #### Defined in -[src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L46) +[src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L46) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L39) +[src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L39) *** @@ -38,7 +38,7 @@ #### Defined in -[src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L41) +[src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L41) *** @@ -48,7 +48,7 @@ #### Defined in -[src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L40) +[src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L40) *** @@ -58,7 +58,7 @@ #### Defined in -[src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L43) +[src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L43) *** @@ -68,7 +68,7 @@ #### Defined in -[src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L44) +[src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L44) *** @@ -78,7 +78,7 @@ #### Defined in -[src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L38) +[src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L38) ## Methods @@ -92,7 +92,7 @@ #### Defined in -[src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L105) +[src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L105) *** @@ -106,7 +106,7 @@ #### Defined in -[src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L268) +[src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L268) *** @@ -120,7 +120,7 @@ #### Defined in -[src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L236) +[src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L236) *** @@ -138,13 +138,13 @@ #### Defined in -[src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L54) +[src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L54) *** ### pollForAccessToken() -> **pollForAccessToken**(`device_and_user_code`): `Promise`\<`void`\> +> **pollForAccessToken**(`device_and_user_code`): `void` #### Parameters @@ -152,11 +152,11 @@ #### Returns -`Promise`\<`void`\> +`void` #### Defined in -[src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L130) +[src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L130) *** @@ -170,7 +170,7 @@ #### Defined in -[src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L197) +[src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L197) *** @@ -184,7 +184,7 @@ #### Defined in -[src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L126) +[src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L126) *** @@ -198,7 +198,7 @@ #### Defined in -[src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L185) +[src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L185) *** @@ -216,7 +216,7 @@ #### Defined in -[src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L85) +[src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L85) *** @@ -230,7 +230,7 @@ #### Defined in -[src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L313) +[src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L313) *** @@ -248,4 +248,4 @@ #### Defined in -[src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L319) +[src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L319) diff --git a/docs/api/classes/Platform.md b/docs/api/classes/Platform.md index 8e71735d..392b986e 100644 --- a/docs/api/classes/Platform.md +++ b/docs/api/classes/Platform.md @@ -24,7 +24,7 @@ #### Defined in -[src/utils/Utils.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L19) +[src/utils/Utils.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L19) ## Methods @@ -42,4 +42,4 @@ #### Defined in -[src/utils/Utils.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L16) +[src/utils/Utils.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L16) diff --git a/docs/api/classes/Player.md b/docs/api/classes/Player.md index f8ec054e..8615a681 100644 --- a/docs/api/classes/Player.md +++ b/docs/api/classes/Player.md @@ -26,7 +26,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L17) +[src/core/Player.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L17) ## Properties @@ -36,7 +36,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L13) +[src/core/Player.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L13) *** @@ -46,7 +46,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L11) +[src/core/Player.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L11) *** @@ -56,7 +56,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L15) +[src/core/Player.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L15) *** @@ -66,7 +66,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L14) +[src/core/Player.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L14) *** @@ -76,7 +76,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L12) +[src/core/Player.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L12) ## Accessors @@ -90,7 +90,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:241](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L241) +[src/core/Player.ts:241](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L241) *** @@ -104,7 +104,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:245](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L245) +[src/core/Player.ts:245](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L245) ## Methods @@ -122,7 +122,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:197](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L197) +[src/core/Player.ts:197](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L197) *** @@ -146,7 +146,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:78](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L78) +[src/core/Player.ts:78](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L78) *** @@ -168,7 +168,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L24) +[src/core/Player.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L24) *** @@ -186,7 +186,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:234](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L234) +[src/core/Player.ts:234](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L234) *** @@ -204,7 +204,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L223) +[src/core/Player.ts:223](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L223) *** @@ -222,7 +222,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:219](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L219) +[src/core/Player.ts:219](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L219) *** @@ -242,7 +242,7 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:167](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L167) +[src/core/Player.ts:167](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L167) *** @@ -268,4 +268,4 @@ Represents YouTube's player script. This is required to decipher signatures. #### Defined in -[src/core/Player.ts:191](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Player.ts#L191) +[src/core/Player.ts:191](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Player.ts#L191) diff --git a/docs/api/classes/PlaylistPanelContinuation.md b/docs/api/classes/PlaylistPanelContinuation.md index be974356..947a1b12 100644 --- a/docs/api/classes/PlaylistPanelContinuation.md +++ b/docs/api/classes/PlaylistPanelContinuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:131](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L131) +[src/parser/continuations.ts:131](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L131) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:129](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L129) +[src/parser/continuations.ts:129](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L129) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:128](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L128) +[src/parser/continuations.ts:128](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L128) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:126](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L126) +[src/parser/continuations.ts:126](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L126) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/ReloadContinuationItemsCommand.md b/docs/api/classes/ReloadContinuationItemsCommand.md index 5586cf2e..2037eea2 100644 --- a/docs/api/classes/ReloadContinuationItemsCommand.md +++ b/docs/api/classes/ReloadContinuationItemsCommand.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L57) +[src/parser/continuations.ts:57](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L57) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L54) +[src/parser/continuations.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L54) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L55) +[src/parser/continuations.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L55) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/continuations.ts:53](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L53) +[src/parser/continuations.ts:53](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L53) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/continuations.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L51) +[src/parser/continuations.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L51) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/SectionListContinuation.md b/docs/api/classes/SectionListContinuation.md index 1271b536..6f716b8e 100644 --- a/docs/api/classes/SectionListContinuation.md +++ b/docs/api/classes/SectionListContinuation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:71](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L71) +[src/parser/continuations.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L71) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:69](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L69) +[src/parser/continuations.ts:69](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L69) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:68](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L68) +[src/parser/continuations.ts:68](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L68) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:66](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L66) +[src/parser/continuations.ts:66](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L66) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/Session.md b/docs/api/classes/Session.md index 6550ea39..02084892 100644 --- a/docs/api/classes/Session.md +++ b/docs/api/classes/Session.md @@ -44,7 +44,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:228](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L228) +[src/core/Session.ts:228](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L228) ## Properties @@ -54,7 +54,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:225](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L225) +[src/core/Session.ts:225](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L225) *** @@ -64,7 +64,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:221](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L221) +[src/core/Session.ts:221](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L221) *** @@ -74,7 +74,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:224](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L224) +[src/core/Session.ts:224](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L224) *** @@ -84,7 +84,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:222](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L222) +[src/core/Session.ts:222](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L222) *** @@ -94,7 +94,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:216](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L216) +[src/core/Session.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L216) *** @@ -104,7 +104,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:219](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L219) +[src/core/Session.ts:219](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L219) *** @@ -114,7 +114,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L223) +[src/core/Session.ts:223](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L223) *** @@ -124,7 +124,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L220) +[src/core/Session.ts:220](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L220) *** @@ -134,7 +134,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:218](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L218) +[src/core/Session.ts:218](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L218) *** @@ -144,7 +144,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:217](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L217) +[src/core/Session.ts:217](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L217) *** @@ -154,7 +154,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:226](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L226) +[src/core/Session.ts:226](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L226) ## Accessors @@ -168,7 +168,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:571](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L571) +[src/core/Session.ts:571](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L571) *** @@ -182,7 +182,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:567](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L567) +[src/core/Session.ts:567](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L567) *** @@ -196,7 +196,7 @@ Represents an InnerTube session. This holds all the data needed to make requests #### Defined in -[src/core/Session.ts:575](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L575) +[src/core/Session.ts:575](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L575) ## Methods @@ -238,7 +238,7 @@ The event listener is appended to target's event listener list and is not append #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8303 +node\_modules/typescript/lib/lib.dom.d.ts:8256 *** @@ -264,7 +264,7 @@ Dispatches a synthetic event event to target and returns true if either event's #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8309 +node\_modules/typescript/lib/lib.dom.d.ts:8262 *** @@ -288,7 +288,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L10) +[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L10) *** @@ -312,7 +312,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L40) +[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L40) *** @@ -338,7 +338,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 ##### Defined in -[src/core/Session.ts:243](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L243) +[src/core/Session.ts:243](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L243) #### on(type, listener) @@ -360,7 +360,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 ##### Defined in -[src/core/Session.ts:244](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L244) +[src/core/Session.ts:244](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L244) #### on(type, listener) @@ -382,7 +382,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 ##### Defined in -[src/core/Session.ts:245](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L245) +[src/core/Session.ts:245](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L245) #### on(type, listener) @@ -404,7 +404,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 ##### Defined in -[src/core/Session.ts:246](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L246) +[src/core/Session.ts:246](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L246) *** @@ -430,7 +430,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 ##### Defined in -[src/core/Session.ts:252](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L252) +[src/core/Session.ts:252](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L252) #### once(type, listener) @@ -452,7 +452,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 ##### Defined in -[src/core/Session.ts:253](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L253) +[src/core/Session.ts:253](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L253) #### once(type, listener) @@ -474,7 +474,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 ##### Defined in -[src/core/Session.ts:254](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L254) +[src/core/Session.ts:254](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L254) *** @@ -504,7 +504,7 @@ Removes the event listener in target's event listener list with the same type, c #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8315 +node\_modules/typescript/lib/lib.dom.d.ts:8268 *** @@ -522,7 +522,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/core/Session.ts:534](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L534) +[src/core/Session.ts:534](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L534) *** @@ -538,7 +538,7 @@ Signs out of the current account and revokes the credentials. #### Defined in -[src/core/Session.ts:557](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L557) +[src/core/Session.ts:557](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L557) *** @@ -556,7 +556,7 @@ Signs out of the current account and revokes the credentials. #### Defined in -[src/core/Session.ts:260](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L260) +[src/core/Session.ts:260](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L260) *** @@ -582,7 +582,7 @@ User provided session arguments. #### Defined in -[src/core/Session.ts:290](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L290) +[src/core/Session.ts:290](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L290) *** @@ -642,4 +642,4 @@ User provided session arguments. #### Defined in -[src/core/Session.ts:326](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L326) +[src/core/Session.ts:326](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L326) diff --git a/docs/api/classes/ShowMiniplayerCommand.md b/docs/api/classes/ShowMiniplayerCommand.md index c6857519..684dbe23 100644 --- a/docs/api/classes/ShowMiniplayerCommand.md +++ b/docs/api/classes/ShowMiniplayerCommand.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L41) +[src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L41) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L38) +[src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L38) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L39) +[src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L39) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/continuations.ts#L36) +[src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/continuations.ts#L36) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/classes/UniversalCache.md b/docs/api/classes/UniversalCache.md index 3f857023..91b1641e 100644 --- a/docs/api/classes/UniversalCache.md +++ b/docs/api/classes/UniversalCache.md @@ -24,7 +24,7 @@ #### Defined in -[src/utils/Cache.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Cache.ts#L6) +[src/utils/Cache.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Cache.ts#L6) ## Accessors @@ -42,7 +42,7 @@ #### Defined in -[src/utils/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Cache.ts#L9) +[src/utils/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Cache.ts#L9) ## Methods @@ -64,7 +64,7 @@ #### Defined in -[src/utils/Cache.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Cache.ts#L12) +[src/utils/Cache.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Cache.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/utils/Cache.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Cache.ts#L18) +[src/utils/Cache.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Cache.ts#L18) *** @@ -110,4 +110,4 @@ #### Defined in -[src/utils/Cache.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Cache.ts#L15) +[src/utils/Cache.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Cache.ts#L15) diff --git a/docs/api/enumerations/ClientType.md b/docs/api/enumerations/ClientType.md index 56a9472b..4651cde5 100644 --- a/docs/api/enumerations/ClientType.md +++ b/docs/api/enumerations/ClientType.md @@ -10,7 +10,7 @@ #### Defined in -[src/core/Session.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L21) +[src/core/Session.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L21) *** @@ -20,7 +20,7 @@ #### Defined in -[src/core/Session.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L23) +[src/core/Session.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L23) *** @@ -30,7 +30,7 @@ #### Defined in -[src/core/Session.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L22) +[src/core/Session.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L22) *** @@ -40,7 +40,7 @@ #### Defined in -[src/core/Session.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L20) +[src/core/Session.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L20) *** @@ -50,7 +50,7 @@ #### Defined in -[src/core/Session.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L18) +[src/core/Session.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L18) *** @@ -60,7 +60,7 @@ #### Defined in -[src/core/Session.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L19) +[src/core/Session.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L19) *** @@ -70,7 +70,7 @@ #### Defined in -[src/core/Session.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L24) +[src/core/Session.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L24) *** @@ -80,7 +80,7 @@ #### Defined in -[src/core/Session.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L25) +[src/core/Session.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L25) *** @@ -90,7 +90,7 @@ #### Defined in -[src/core/Session.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L17) +[src/core/Session.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L17) *** @@ -100,7 +100,7 @@ #### Defined in -[src/core/Session.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L27) +[src/core/Session.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L27) *** @@ -110,4 +110,4 @@ #### Defined in -[src/core/Session.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L26) +[src/core/Session.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L26) diff --git a/docs/api/interfaces/ApiResponse.md b/docs/api/interfaces/ApiResponse.md index 2d7be2f5..61673838 100644 --- a/docs/api/interfaces/ApiResponse.md +++ b/docs/api/interfaces/ApiResponse.md @@ -10,7 +10,7 @@ #### Defined in -[src/core/Actions.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L16) +[src/core/Actions.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L15) *** @@ -20,7 +20,7 @@ #### Defined in -[src/core/Actions.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L15) +[src/core/Actions.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L14) *** @@ -30,4 +30,4 @@ #### Defined in -[src/core/Actions.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L14) +[src/core/Actions.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L13) diff --git a/docs/api/interfaces/HTTPClientInit.md b/docs/api/interfaces/HTTPClientInit.md index 226887b2..c46cdcf2 100644 --- a/docs/api/interfaces/HTTPClientInit.md +++ b/docs/api/interfaces/HTTPClientInit.md @@ -10,4 +10,4 @@ #### Defined in -[src/utils/HTTPClient.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/HTTPClient.ts#L15) +[src/utils/HTTPClient.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/HTTPClient.ts#L15) diff --git a/docs/api/namespaces/APIResponseTypes/README.md b/docs/api/namespaces/APIResponseTypes/README.md index c0e76e11..2b5d3173 100644 --- a/docs/api/namespaces/APIResponseTypes/README.md +++ b/docs/api/namespaces/APIResponseTypes/README.md @@ -6,6 +6,7 @@ ### Interfaces +- [IEndpoint](interfaces/IEndpoint.md) - [IParsedResponse](interfaces/IParsedResponse.md) - [IPlayabilityStatus](interfaces/IPlayabilityStatus.md) - [IPlaybackTracking](interfaces/IPlaybackTracking.md) @@ -18,15 +19,43 @@ ### Type Aliases +- [AddToPlaylistServiceRequest](type-aliases/AddToPlaylistServiceRequest.md) +- [BrowseRequest](type-aliases/BrowseRequest.md) +- [BrowseRequestSupportedMetadata](type-aliases/BrowseRequestSupportedMetadata.md) +- [ContinuationRequest](type-aliases/ContinuationRequest.md) - [CpnSource](type-aliases/CpnSource.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) - [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/IEndpoint.md b/docs/api/namespaces/APIResponseTypes/interfaces/IEndpoint.md new file mode 100644 index 00000000..58ab66b1 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IEndpoint.md @@ -0,0 +1,35 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/CommandEndpoints.ts#L2) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md b/docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md index 8de95691..549942b6 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IParsedResponse.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L26) +[src/parser/types/ParsedResponse.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L26) *** @@ -20,7 +20,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L27) +[src/parser/types/ParsedResponse.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L27) *** @@ -30,7 +30,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:50](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L50) +[src/parser/types/ParsedResponse.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L50) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:62](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L62) +[src/parser/types/ParsedResponse.ts:62](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L62) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L25) +[src/parser/types/ParsedResponse.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L25) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:60](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L60) +[src/parser/types/ParsedResponse.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L60) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L65) +[src/parser/types/ParsedResponse.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L65) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L28) +[src/parser/types/ParsedResponse.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L28) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L29) +[src/parser/types/ParsedResponse.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L29) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L43) +[src/parser/types/ParsedResponse.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L43) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L44) +[src/parser/types/ParsedResponse.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L44) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L46) +[src/parser/types/ParsedResponse.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L46) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:74](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L74) +[src/parser/types/ParsedResponse.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L74) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:66](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L66) +[src/parser/types/ParsedResponse.ts:66](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L66) *** @@ -158,7 +158,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:58](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L58) +[src/parser/types/ParsedResponse.ts:58](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L58) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:59](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L59) +[src/parser/types/ParsedResponse.ts:59](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L59) *** @@ -178,7 +178,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:64](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L64) +[src/parser/types/ParsedResponse.ts:64](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L64) *** @@ -188,7 +188,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L70) +[src/parser/types/ParsedResponse.ts:70](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L70) *** @@ -198,7 +198,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:72](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L72) +[src/parser/types/ParsedResponse.ts:72](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L72) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:73](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L73) +[src/parser/types/ParsedResponse.ts:73](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L73) *** @@ -218,7 +218,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:52](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L52) +[src/parser/types/ParsedResponse.ts:52](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L52) *** @@ -228,7 +228,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L30) +[src/parser/types/ParsedResponse.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L30) *** @@ -238,7 +238,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L31) +[src/parser/types/ParsedResponse.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L31) *** @@ -248,7 +248,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:71](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L71) +[src/parser/types/ParsedResponse.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L71) *** @@ -258,7 +258,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L36) +[src/parser/types/ParsedResponse.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L36) *** @@ -268,7 +268,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L34) +[src/parser/types/ParsedResponse.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L34) *** @@ -278,7 +278,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L35) +[src/parser/types/ParsedResponse.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L35) *** @@ -288,7 +288,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L47) +[src/parser/types/ParsedResponse.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L47) *** @@ -298,7 +298,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L48) +[src/parser/types/ParsedResponse.ts:48](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L48) *** @@ -308,7 +308,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L37) +[src/parser/types/ParsedResponse.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L37) *** @@ -318,7 +318,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L38) +[src/parser/types/ParsedResponse.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L38) *** @@ -328,7 +328,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L41) +[src/parser/types/ParsedResponse.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L41) *** @@ -338,7 +338,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L42) +[src/parser/types/ParsedResponse.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L42) *** @@ -348,7 +348,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L39) +[src/parser/types/ParsedResponse.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L39) *** @@ -358,7 +358,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L40) +[src/parser/types/ParsedResponse.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L40) *** @@ -368,7 +368,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L49) +[src/parser/types/ParsedResponse.ts:49](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L49) *** @@ -378,7 +378,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L55) +[src/parser/types/ParsedResponse.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L55) *** @@ -388,7 +388,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L54) +[src/parser/types/ParsedResponse.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L54) *** @@ -398,7 +398,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L57) +[src/parser/types/ParsedResponse.ts:57](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L57) *** @@ -408,7 +408,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:53](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L53) +[src/parser/types/ParsedResponse.ts:53](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L53) *** @@ -418,7 +418,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:75](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L75) +[src/parser/types/ParsedResponse.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L75) *** @@ -428,7 +428,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L51) +[src/parser/types/ParsedResponse.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L51) *** @@ -438,7 +438,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L32) +[src/parser/types/ParsedResponse.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L32) *** @@ -448,17 +448,17 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L33) +[src/parser/types/ParsedResponse.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L33) *** ### storyboards? -> `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) +> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) #### Defined in -[src/parser/types/ParsedResponse.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L63) +[src/parser/types/ParsedResponse.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L63) *** @@ -468,7 +468,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:56](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L56) +[src/parser/types/ParsedResponse.ts:56](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L56) *** @@ -478,7 +478,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:61](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L61) +[src/parser/types/ParsedResponse.ts:61](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L61) *** @@ -488,4 +488,4 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:76](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L76) +[src/parser/types/ParsedResponse.ts:76](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L76) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md b/docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md index ee0f9446..dd5f11c1 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IPlayabilityStatus.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:86](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L86) +[src/parser/types/ParsedResponse.ts:86](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L86) *** @@ -20,7 +20,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:87](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L87) +[src/parser/types/ParsedResponse.ts:87](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L87) *** @@ -30,7 +30,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:85](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L85) +[src/parser/types/ParsedResponse.ts:85](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L85) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:88](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L88) +[src/parser/types/ParsedResponse.ts:88](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L88) *** @@ -50,4 +50,4 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:84](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L84) +[src/parser/types/ParsedResponse.ts:84](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L84) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md b/docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md index c7fb14e6..d9893f32 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IPlaybackTracking.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:81](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L81) +[src/parser/types/ParsedResponse.ts:81](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L81) *** @@ -20,4 +20,4 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:80](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L80) +[src/parser/types/ParsedResponse.ts:80](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L80) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md b/docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md index 8e0e536b..1a2d64a1 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IPlayerConfig.md @@ -22,7 +22,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:92](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L92) +[src/parser/types/ParsedResponse.ts:92](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L92) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:100](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L100) +[src/parser/types/ParsedResponse.ts:100](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L100) *** @@ -70,4 +70,4 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L97) +[src/parser/types/ParsedResponse.ts:97](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L97) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md b/docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md index 11ea6fbd..0626b575 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IRawPlayerConfig.md @@ -22,7 +22,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L20) +[src/parser/types/RawResponse.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L20) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L28) +[src/parser/types/RawResponse.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L28) *** @@ -70,4 +70,4 @@ #### Defined in -[src/parser/types/RawResponse.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L25) +[src/parser/types/RawResponse.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L25) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md b/docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md index 1a7e2c6d..27d1950a 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IRawResponse.md @@ -14,7 +14,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L48) +[src/parser/types/RawResponse.ts:48](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L48) *** @@ -24,7 +24,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:56](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L56) +[src/parser/types/RawResponse.ts:56](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L56) *** @@ -34,7 +34,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:92](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L92) +[src/parser/types/RawResponse.ts:92](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L92) *** @@ -44,7 +44,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L42) +[src/parser/types/RawResponse.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L42) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:90](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L90) +[src/parser/types/RawResponse.ts:90](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L90) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:95](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L95) +[src/parser/types/RawResponse.ts:95](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L95) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L43) +[src/parser/types/RawResponse.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L43) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:52](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L52) +[src/parser/types/RawResponse.ts:52](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L52) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L47) +[src/parser/types/RawResponse.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L47) *** @@ -112,7 +112,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:96](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L96) +[src/parser/types/RawResponse.ts:96](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L96) *** @@ -122,7 +122,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:86](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L86) +[src/parser/types/RawResponse.ts:86](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L86) *** @@ -132,7 +132,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:89](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L89) +[src/parser/types/RawResponse.ts:89](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L89) *** @@ -142,7 +142,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:94](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L94) +[src/parser/types/RawResponse.ts:94](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L94) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:102](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L102) +[src/parser/types/RawResponse.ts:102](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L102) *** @@ -162,7 +162,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:103](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L103) +[src/parser/types/RawResponse.ts:103](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L103) *** @@ -172,7 +172,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:58](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L58) +[src/parser/types/RawResponse.ts:58](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L58) *** @@ -182,7 +182,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:101](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L101) +[src/parser/types/RawResponse.ts:101](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L101) *** @@ -192,7 +192,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:50](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L50) +[src/parser/types/RawResponse.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L50) *** @@ -202,7 +202,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:100](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L100) +[src/parser/types/RawResponse.ts:100](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L100) *** @@ -212,7 +212,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L49) +[src/parser/types/RawResponse.ts:49](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L49) *** @@ -222,7 +222,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:53](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L53) +[src/parser/types/RawResponse.ts:53](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L53) *** @@ -232,7 +232,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L54) +[src/parser/types/RawResponse.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L54) *** @@ -242,7 +242,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L44) +[src/parser/types/RawResponse.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L44) *** @@ -252,7 +252,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L46) +[src/parser/types/RawResponse.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L46) *** @@ -262,7 +262,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L45) +[src/parser/types/RawResponse.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L45) *** @@ -272,7 +272,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L55) +[src/parser/types/RawResponse.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L55) *** @@ -302,7 +302,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:68](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L68) +[src/parser/types/RawResponse.ts:68](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L68) *** @@ -328,7 +328,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:60](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L60) +[src/parser/types/RawResponse.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L60) *** @@ -338,7 +338,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:83](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L83) +[src/parser/types/RawResponse.ts:83](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L83) *** @@ -348,7 +348,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:59](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L59) +[src/parser/types/RawResponse.ts:59](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L59) *** @@ -358,7 +358,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:84](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L84) +[src/parser/types/RawResponse.ts:84](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L84) *** @@ -368,7 +368,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:88](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L88) +[src/parser/types/RawResponse.ts:88](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L88) *** @@ -378,7 +378,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L57) +[src/parser/types/RawResponse.ts:57](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L57) *** @@ -388,7 +388,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L41) +[src/parser/types/RawResponse.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L41) *** @@ -398,7 +398,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L51) +[src/parser/types/RawResponse.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L51) *** @@ -408,7 +408,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L93) +[src/parser/types/RawResponse.ts:93](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L93) *** @@ -442,7 +442,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:75](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L75) +[src/parser/types/RawResponse.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L75) *** @@ -452,7 +452,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:87](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L87) +[src/parser/types/RawResponse.ts:87](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L87) *** @@ -462,7 +462,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L91) +[src/parser/types/RawResponse.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L91) *** @@ -472,4 +472,4 @@ #### Defined in -[src/parser/types/RawResponse.ts:85](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L85) +[src/parser/types/RawResponse.ts:85](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L85) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IResponseContext.md b/docs/api/namespaces/APIResponseTypes/interfaces/IResponseContext.md index d1260d66..c47e4ec5 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IResponseContext.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IResponseContext.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L16) +[src/parser/types/RawResponse.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L16) *** @@ -20,4 +20,4 @@ #### Defined in -[src/parser/types/RawResponse.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L15) +[src/parser/types/RawResponse.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L15) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IServiceTrackingParams.md b/docs/api/namespaces/APIResponseTypes/interfaces/IServiceTrackingParams.md index b77347c7..4ed39065 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IServiceTrackingParams.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IServiceTrackingParams.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/types/RawResponse.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L8) +[src/parser/types/RawResponse.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L8) *** @@ -20,4 +20,4 @@ #### Defined in -[src/parser/types/RawResponse.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L7) +[src/parser/types/RawResponse.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L7) diff --git a/docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md b/docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md index d52915b4..5c33f892 100644 --- a/docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md +++ b/docs/api/namespaces/APIResponseTypes/interfaces/IStreamingData.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L115) +[src/parser/types/ParsedResponse.ts:115](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L115) *** @@ -20,7 +20,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:116](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L116) +[src/parser/types/ParsedResponse.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L116) *** @@ -30,7 +30,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:113](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L113) +[src/parser/types/ParsedResponse.ts:113](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L113) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:114](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L114) +[src/parser/types/ParsedResponse.ts:114](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L114) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:117](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L117) +[src/parser/types/ParsedResponse.ts:117](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L117) *** @@ -60,4 +60,4 @@ #### Defined in -[src/parser/types/ParsedResponse.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L118) +[src/parser/types/ParsedResponse.ts:118](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L118) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md new file mode 100644 index 00000000..810ab0c1 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md @@ -0,0 +1,27 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..a833162a --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequest.md @@ -0,0 +1,39 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..8922a5c7 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/BrowseRequestSupportedMetadata.md @@ -0,0 +1,23 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..251d34e7 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/ContinuationRequest.md @@ -0,0 +1,31 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/CommandEndpoints.ts#L143) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/CpnSource.md b/docs/api/namespaces/APIResponseTypes/type-aliases/CpnSource.md index f476724f..1c7111b6 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/CpnSource.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/CpnSource.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/RawResponse.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L4) +[src/parser/types/RawResponse.ts:4](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/RawResponse.ts#L4) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md b/docs/api/namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md new file mode 100644 index 00000000..3618525e --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/CreateCommentRequest.md @@ -0,0 +1,63 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..23ffa018 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/CreatePlaylistServiceRequest.md @@ -0,0 +1,35 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..08e82d11 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/DeletePlaylistServiceRequest.md @@ -0,0 +1,15 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..c3c4ef98 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackContext.md @@ -0,0 +1,15 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..266ac319 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/FeedbackRequest.md @@ -0,0 +1,27 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..e28c99a8 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/FormData.md @@ -0,0 +1,31 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..f985c67c --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/GetAccountsListInnertubeRequest.md @@ -0,0 +1,43 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..e1975d37 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/GetKidsBlocklistPickerRequest.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 index ebfa0ae1..fb5a7c6c 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/IBrowseResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:123](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L123) +[src/parser/types/ParsedResponse.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L123) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md index 7983e90b..2e40d8b6 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L127) +[src/parser/types/ParsedResponse.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L127) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md index 9a43fc3f..bf70aa54 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/IGetTranscriptResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:126](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L126) +[src/parser/types/ParsedResponse.ts:126](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L126) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md index 46308e8d..5d0d4389 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/IGuideResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:129](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L129) +[src/parser/types/ParsedResponse.ts:129](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L129) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md index 199c1882..6292d1eb 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/INextResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:122](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L122) +[src/parser/types/ParsedResponse.ts:122](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L122) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md index a8786fa9..bfc7638f 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/IPlayerResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:121](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L121) +[src/parser/types/ParsedResponse.ts:121](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L121) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md index 5233bd13..b27b4597 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/IResolveURLResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L125) +[src/parser/types/ParsedResponse.ts:125](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L125) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md index 98ac74c1..c1ca009a 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/ISearchResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:124](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L124) +[src/parser/types/ParsedResponse.ts:124](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L124) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md b/docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md index 4a436d1a..6ccd2ca6 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/IUpdatedMetadataResponse.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/ParsedResponse.ts:128](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/ParsedResponse.ts#L128) +[src/parser/types/ParsedResponse.ts:128](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/ParsedResponse.ts#L128) diff --git a/docs/api/namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md b/docs/api/namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md new file mode 100644 index 00000000..ce801027 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/InlineSettingStatus.md @@ -0,0 +1,9 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..4020492d --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/LikeRequest.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..fb7a029d --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/LikeTarget.md @@ -0,0 +1,15 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..7fae681a --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/LiveChatItemContextMenuRequest.md @@ -0,0 +1,15 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..773199d6 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/ModifyChannelNotificationPreferenceRequest.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..8e4bdf7f --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/NextNavendpoint.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..8d7d592f --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/PerformCommentActionRequest.md @@ -0,0 +1,15 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..b5a1dc80 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistEditRequest.md @@ -0,0 +1,23 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..03d905ea --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/PlaylistPrivacyStatus.md @@ -0,0 +1,9 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 index 58440c29..6f78c6a2 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/RawData.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/RawData.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/RawResponse.ts:2](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L2) +[src/parser/types/RawResponse.ts:2](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index 5fc1f2d5..1a726fd2 100644 --- a/docs/api/namespaces/APIResponseTypes/type-aliases/RawNode.md +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/RawNode.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/types/RawResponse.ts:1](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/types/RawResponse.ts#L1) +[src/parser/types/RawResponse.ts:1](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..292bd058 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/ReelWatchRequest.md @@ -0,0 +1,43 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..52e39d24 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/SearchRequest.md @@ -0,0 +1,27 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..6af536ef --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/ShareEntityServiceRequest.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..4d9348a2 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/SubscribeRequest.md @@ -0,0 +1,31 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..ffb4f9d1 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/UnsubscribeRequest.md @@ -0,0 +1,23 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..8eec014d --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/WatchNextRequest.md @@ -0,0 +1,35 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..b3b44f20 --- /dev/null +++ b/docs/api/namespaces/APIResponseTypes/type-aliases/WatchRequest.md @@ -0,0 +1,51 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/types/CommandEndpoints.ts#L62) diff --git a/docs/api/namespaces/Clients/classes/Kids.md b/docs/api/namespaces/Clients/classes/Kids.md index 53c60c0a..81546a3d 100644 --- a/docs/api/namespaces/Clients/classes/Kids.md +++ b/docs/api/namespaces/Clients/classes/Kids.md @@ -18,7 +18,7 @@ #### Defined in -[src/core/clients/Kids.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L18) +[src/core/clients/Kids.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L12) ## Methods @@ -43,7 +43,7 @@ A list of API responses. #### Defined in -[src/core/clients/Kids.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L91) +[src/core/clients/Kids.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L65) *** @@ -51,21 +51,17 @@ A list of API responses. > **getChannel**(`channel_id`): `Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\> -Retrieves the contents of the given channel. - #### Parameters • **channel\_id**: `string` -The channel id. - #### Returns `Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\> #### Defined in -[src/core/clients/Kids.ts:62](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L62) +[src/core/clients/Kids.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L47) *** @@ -73,15 +69,13 @@ The channel id. > **getHomeFeed**(): `Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\> -Retrieves the home feed. - #### Returns `Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\> #### Defined in -[src/core/clients/Kids.ts:75](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L75) +[src/core/clients/Kids.ts:53](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L53) *** @@ -89,21 +83,17 @@ Retrieves the home feed. > **getInfo**(`video_id`): `Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\> -Retrieves video info. - #### Parameters • **video\_id**: `string` -The video id. - #### Returns `Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\> #### Defined in -[src/core/clients/Kids.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L37) +[src/core/clients/Kids.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L22) *** @@ -111,18 +101,14 @@ The video id. > **search**(`query`): `Promise`\<[`Search`](../../YTKids/classes/Search.md)\> -Searches the given query. - #### Parameters • **query**: `string` -The query. - #### Returns `Promise`\<[`Search`](../../YTKids/classes/Search.md)\> #### Defined in -[src/core/clients/Kids.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L26) +[src/core/clients/Kids.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L16) diff --git a/docs/api/namespaces/Clients/classes/Music.md b/docs/api/namespaces/Clients/classes/Music.md index 3ef338cf..899a8956 100644 --- a/docs/api/namespaces/Clients/classes/Music.md +++ b/docs/api/namespaces/Clients/classes/Music.md @@ -18,7 +18,7 @@ #### Defined in -[src/core/clients/Music.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L40) +[src/core/clients/Music.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L37) ## Methods @@ -26,21 +26,17 @@ > **getAlbum**(`album_id`): `Promise`\<[`Album`](../../YTMusic/classes/Album.md)\> -Retrieves album. - #### Parameters • **album\_id**: `string` -The album id. - #### Returns `Promise`\<[`Album`](../../YTMusic/classes/Album.md)\> #### Defined in -[src/core/clients/Music.ts:209](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L209) +[src/core/clients/Music.ts:160](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L160) *** @@ -48,21 +44,17 @@ The album id. > **getArtist**(`artist_id`): `Promise`\<[`Artist`](../../YTMusic/classes/Artist.md)\> -Retrieves artist's info & content. - #### Parameters • **artist\_id**: `string` -The artist id. - #### Returns `Promise`\<[`Artist`](../../YTMusic/classes/Artist.md)\> #### Defined in -[src/core/clients/Music.ts:189](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L189) +[src/core/clients/Music.ts:150](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L150) *** @@ -70,15 +62,13 @@ The artist id. > **getExplore**(): `Promise`\<[`Explore`](../../YTMusic/classes/Explore.md)\> -Retrieves the Explore feed. - #### Returns `Promise`\<[`Explore`](../../YTMusic/classes/Explore.md)\> #### Defined in -[src/core/clients/Music.ts:159](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L159) +[src/core/clients/Music.ts:137](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L137) *** @@ -86,15 +76,13 @@ Retrieves the Explore feed. > **getHomeFeed**(): `Promise`\<[`HomeFeed`](../../YTMusic/classes/HomeFeed.md)\> -Retrieves the home feed. - #### Returns `Promise`\<[`HomeFeed`](../../YTMusic/classes/HomeFeed.md)\> #### Defined in -[src/core/clients/Music.ts:145](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L145) +[src/core/clients/Music.ts:131](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L131) *** @@ -116,7 +104,7 @@ Video id or a list item. #### Defined in -[src/core/clients/Music.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L49) +[src/core/clients/Music.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L46) *** @@ -124,15 +112,13 @@ Video id or a list item. > **getLibrary**(): `Promise`\<[`Library`](../../YTMusic/classes/Library.md)\> -Retrieves the library. - #### Returns `Promise`\<[`Library`](../../YTMusic/classes/Library.md)\> #### Defined in -[src/core/clients/Music.ts:174](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L174) +[src/core/clients/Music.ts:144](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L144) *** @@ -140,21 +126,17 @@ Retrieves the library. > **getLyrics**(`video_id`): `Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\> -Retrieves song lyrics. - #### Parameters • **video\_id**: `string` -The video id. - #### Returns `Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\> #### Defined in -[src/core/clients/Music.ts:325](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L325) +[src/core/clients/Music.ts:241](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L241) *** @@ -162,21 +144,17 @@ The video id. > **getPlaylist**(`playlist_id`): `Promise`\<[`Playlist`](../../YTMusic/classes/Playlist.md)\> -Retrieves playlist. - #### Parameters • **playlist\_id**: `string` -The playlist id. - #### Returns `Promise`\<[`Playlist`](../../YTMusic/classes/Playlist.md)\> #### Defined in -[src/core/clients/Music.ts:229](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L229) +[src/core/clients/Music.ts:170](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L170) *** @@ -184,15 +162,13 @@ The playlist id. > **getRecap**(): `Promise`\<[`Recap`](../../YTMusic/classes/Recap.md)\> -Retrieves recap. - #### Returns `Promise`\<[`Recap`](../../YTMusic/classes/Recap.md)\> #### Defined in -[src/core/clients/Music.ts:355](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L355) +[src/core/clients/Music.ts:267](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L267) *** @@ -200,35 +176,27 @@ Retrieves recap. > **getRelated**(`video_id`): `Promise`\<[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`Message`](../../YTNodes/classes/Message.md)\> -Retrieves related content. - #### Parameters • **video\_id**: `string` -The video id. - #### Returns `Promise`\<[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`Message`](../../YTNodes/classes/Message.md)\> #### Defined in -[src/core/clients/Music.ts:297](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L297) +[src/core/clients/Music.ts:220](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L220) *** ### getSearchSuggestions() -> **getSearchSuggestions**(`query`): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchSuggestionsSection`](../../YTNodes/classes/SearchSuggestionsSection.md)\>\> - -Retrieves search suggestions for the given query. +> **getSearchSuggestions**(`input`): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchSuggestionsSection`](../../YTNodes/classes/SearchSuggestionsSection.md)\>\> #### Parameters -• **query**: `string` - -The query. +• **input**: `string` #### Returns @@ -236,7 +204,7 @@ The query. #### Defined in -[src/core/clients/Music.ts:370](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L370) +[src/core/clients/Music.ts:273](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L273) *** @@ -244,25 +212,19 @@ The query. > **getUpNext**(`video_id`, `automix`): `Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\> -Retrieves up next. - #### Parameters • **video\_id**: `string` -The video id. - • **automix**: `boolean` = `true` -Whether to enable automix. - #### Returns `Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\> #### Defined in -[src/core/clients/Music.ts:251](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L251) +[src/core/clients/Music.ts:180](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L180) *** @@ -270,22 +232,16 @@ Whether to enable automix. > **search**(`query`, `filters`): `Promise`\<[`Search`](../../YTMusic/classes/Search.md)\> -Searches on YouTube Music. - #### Parameters • **query**: `string` -Search query. - • **filters**: [`MusicSearchFilters`](../../Types/type-aliases/MusicSearchFilters.md) = `{}` -Search filters. - #### Returns `Promise`\<[`Search`](../../YTMusic/classes/Search.md)\> #### Defined in -[src/core/clients/Music.ts:116](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Music.ts#L116) +[src/core/clients/Music.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Music.ts#L109) diff --git a/docs/api/namespaces/Clients/classes/Studio.md b/docs/api/namespaces/Clients/classes/Studio.md index c5560afa..a4f975c2 100644 --- a/docs/api/namespaces/Clients/classes/Studio.md +++ b/docs/api/namespaces/Clients/classes/Studio.md @@ -18,7 +18,7 @@ #### Defined in -[src/core/clients/Studio.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Studio.ts#L26) +[src/core/clients/Studio.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Studio.ts#L25) ## Methods @@ -57,7 +57,7 @@ const response = await yt.studio.updateVideoMetadata(videoId, { #### Defined in -[src/core/clients/Studio.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Studio.ts#L48) +[src/core/clients/Studio.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Studio.ts#L47) *** @@ -86,4 +86,4 @@ const response = await yt.studio.upload(file.buffer, { title: 'Wow!' }); #### Defined in -[src/core/clients/Studio.ts:151](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Studio.ts#L151) +[src/core/clients/Studio.ts:148](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Studio.ts#L148) diff --git a/docs/api/namespaces/Constants/variables/CLIENTS.md b/docs/api/namespaces/Constants/variables/CLIENTS.md index e504dec9..5c11a110 100644 --- a/docs/api/namespaces/Constants/variables/CLIENTS.md +++ b/docs/api/namespaces/Constants/variables/CLIENTS.md @@ -240,4 +240,4 @@ ## Defined in -[src/utils/Constants.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Constants.ts#L25) +[src/utils/Constants.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Constants.ts#L25) diff --git a/docs/api/namespaces/Constants/variables/INNERTUBE_HEADERS_BASE.md b/docs/api/namespaces/Constants/variables/INNERTUBE_HEADERS_BASE.md index 1252d6f4..373ffaab 100644 --- a/docs/api/namespaces/Constants/variables/INNERTUBE_HEADERS_BASE.md +++ b/docs/api/namespaces/Constants/variables/INNERTUBE_HEADERS_BASE.md @@ -20,4 +20,4 @@ ## Defined in -[src/utils/Constants.ts:102](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Constants.ts#L102) +[src/utils/Constants.ts:102](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Constants.ts#L102) diff --git a/docs/api/namespaces/Constants/variables/OAUTH.md b/docs/api/namespaces/Constants/variables/OAUTH.md index 5f015b01..b4114d54 100644 --- a/docs/api/namespaces/Constants/variables/OAUTH.md +++ b/docs/api/namespaces/Constants/variables/OAUTH.md @@ -22,4 +22,4 @@ ## Defined in -[src/utils/Constants.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Constants.ts#L19) +[src/utils/Constants.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Constants.ts#L19) diff --git a/docs/api/namespaces/Constants/variables/STREAM_HEADERS.md b/docs/api/namespaces/Constants/variables/STREAM_HEADERS.md index 67ddb5ab..96873052 100644 --- a/docs/api/namespaces/Constants/variables/STREAM_HEADERS.md +++ b/docs/api/namespaces/Constants/variables/STREAM_HEADERS.md @@ -24,4 +24,4 @@ ## Defined in -[src/utils/Constants.ts:96](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Constants.ts#L96) +[src/utils/Constants.ts:96](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Constants.ts#L96) diff --git a/docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md b/docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md index 32fbe007..0c243b8d 100644 --- a/docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md +++ b/docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md @@ -6,4 +6,4 @@ ## Defined in -[src/utils/Constants.ts:108](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Constants.ts#L108) +[src/utils/Constants.ts:108](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Constants.ts#L108) diff --git a/docs/api/namespaces/Constants/variables/URLS.md b/docs/api/namespaces/Constants/variables/URLS.md index c06cb25c..e3fa70f4 100644 --- a/docs/api/namespaces/Constants/variables/URLS.md +++ b/docs/api/namespaces/Constants/variables/URLS.md @@ -66,4 +66,4 @@ ## Defined in -[src/utils/Constants.ts:2](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Constants.ts#L2) +[src/utils/Constants.ts:2](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Constants.ts#L2) diff --git a/docs/api/namespaces/Endpoints/README.md b/docs/api/namespaces/Endpoints/README.md deleted file mode 100644 index 0b716083..00000000 --- a/docs/api/namespaces/Endpoints/README.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../README.md) / Endpoints - -# Endpoints - -## Index - -### Namespaces - -- [Account](namespaces/Account/README.md) -- [Browse](namespaces/Browse/README.md) -- [BrowseEndpoint](namespaces/BrowseEndpoint/README.md) -- [Channel](namespaces/Channel/README.md) -- [Comment](namespaces/Comment/README.md) -- [GetNotificationMenuEndpoint](namespaces/GetNotificationMenuEndpoint/README.md) -- [GuideEndpoint](namespaces/GuideEndpoint/README.md) -- [Kids](namespaces/Kids/README.md) -- [Like](namespaces/Like/README.md) -- [Music](namespaces/Music/README.md) -- [NextEndpoint](namespaces/NextEndpoint/README.md) -- [Notification](namespaces/Notification/README.md) -- [PlayerEndpoint](namespaces/PlayerEndpoint/README.md) -- [Playlist](namespaces/Playlist/README.md) -- [Reel](namespaces/Reel/README.md) -- [ResolveURLEndpoint](namespaces/ResolveURLEndpoint/README.md) -- [SearchEndpoint](namespaces/SearchEndpoint/README.md) -- [Subscription](namespaces/Subscription/README.md) -- [Upload](namespaces/Upload/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Account/README.md b/docs/api/namespaces/Endpoints/namespaces/Account/README.md deleted file mode 100644 index c71dd86d..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Account/README.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Account - -# Account - -## Index - -### Namespaces - -- [AccountListEndpoint](namespaces/AccountListEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/README.md deleted file mode 100644 index e358c5cc..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Account](../../README.md) / AccountListEndpoint - -# AccountListEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/functions/build.md deleted file mode 100644 index a0d09c04..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/functions/build.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Account](../../../README.md) / [AccountListEndpoint](../README.md) / build - -# Function: build() - -> **build**(): [`IAccountListRequest`](../../../../../../Types/interfaces/IAccountListRequest.md) - -Builds a `/account/accounts_list` request payload. - -## Returns - -[`IAccountListRequest`](../../../../../../Types/interfaces/IAccountListRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/account/AccountListEndpoint.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/account/AccountListEndpoint.ts#L9) diff --git a/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/variables/PATH.md deleted file mode 100644 index 5da75ea5..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Account/namespaces/AccountListEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Account](../../../README.md) / [AccountListEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/account/accounts_list"` = `'/account/accounts_list'` - -## Defined in - -[src/core/endpoints/account/AccountListEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/account/AccountListEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Browse/README.md b/docs/api/namespaces/Endpoints/namespaces/Browse/README.md deleted file mode 100644 index f7d08707..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Browse/README.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Browse - -# Browse - -## Index - -### Namespaces - -- [EditPlaylistEndpoint](namespaces/EditPlaylistEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/README.md deleted file mode 100644 index d12b830a..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Browse](../../README.md) / EditPlaylistEndpoint - -# EditPlaylistEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/functions/build.md deleted file mode 100644 index 82defb94..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Browse](../../../README.md) / [EditPlaylistEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IEditPlaylistRequest`](../../../../../../Types/type-aliases/IEditPlaylistRequest.md) - -Builds a `/browse/edit_playlist` request payload. - -## Parameters - -• **opts**: [`EditPlaylistEndpointOptions`](../../../../../../Types/type-aliases/EditPlaylistEndpointOptions.md) - -The options to use. - -## Returns - -[`IEditPlaylistRequest`](../../../../../../Types/type-aliases/IEditPlaylistRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/browse/EditPlaylistEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/browse/EditPlaylistEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/variables/PATH.md deleted file mode 100644 index 634f483b..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Browse/namespaces/EditPlaylistEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Browse](../../../README.md) / [EditPlaylistEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/browse/edit_playlist"` = `'/browse/edit_playlist'` - -## Defined in - -[src/core/endpoints/browse/EditPlaylistEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/browse/EditPlaylistEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/README.md deleted file mode 100644 index f3d24daf..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / BrowseEndpoint - -# BrowseEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/functions/build.md deleted file mode 100644 index 583f45c1..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [BrowseEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IBrowseRequest`](../../../../Types/type-aliases/IBrowseRequest.md) - -Builds a `/browse` request payload. - -## Parameters - -• **opts**: [`BrowseEndpointOptions`](../../../../Types/type-aliases/BrowseEndpointOptions.md) - -The options to use. - -## Returns - -[`IBrowseRequest`](../../../../Types/type-aliases/IBrowseRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/BrowseEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/BrowseEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/variables/PATH.md deleted file mode 100644 index faf0b138..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/BrowseEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [BrowseEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/browse"` = `'/browse'` - -## Defined in - -[src/core/endpoints/BrowseEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/BrowseEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Channel/README.md b/docs/api/namespaces/Endpoints/namespaces/Channel/README.md deleted file mode 100644 index aa885237..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Channel/README.md +++ /dev/null @@ -1,10 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Channel - -# Channel - -## Index - -### Namespaces - -- [EditDescriptionEndpoint](namespaces/EditDescriptionEndpoint/README.md) -- [EditNameEndpoint](namespaces/EditNameEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/README.md deleted file mode 100644 index b1acaaeb..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Channel](../../README.md) / EditDescriptionEndpoint - -# EditDescriptionEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/functions/build.md deleted file mode 100644 index 03975208..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Channel](../../../README.md) / [EditDescriptionEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IChannelEditDescriptionRequest`](../../../../../../Types/interfaces/IChannelEditDescriptionRequest.md) - -Builds a `/channel/edit_description` request payload. - -## Parameters - -• **options**: [`ChannelEditDescriptionEndpointOptions`](../../../../../../Types/type-aliases/ChannelEditDescriptionEndpointOptions.md) - -The options to use. - -## Returns - -[`IChannelEditDescriptionRequest`](../../../../../../Types/interfaces/IChannelEditDescriptionRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/channel/EditDescriptionEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/channel/EditDescriptionEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/variables/PATH.md deleted file mode 100644 index 1c496c58..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditDescriptionEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Channel](../../../README.md) / [EditDescriptionEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/channel/edit_description"` = `'/channel/edit_description'` - -## Defined in - -[src/core/endpoints/channel/EditDescriptionEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/channel/EditDescriptionEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/README.md deleted file mode 100644 index 214384c8..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Channel](../../README.md) / EditNameEndpoint - -# EditNameEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/functions/build.md deleted file mode 100644 index 2af91c39..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Channel](../../../README.md) / [EditNameEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IChannelEditNameRequest`](../../../../../../Types/interfaces/IChannelEditNameRequest.md) - -Builds a `/channel/edit_name` request payload. - -## Parameters - -• **options**: [`ChannelEditNameEndpointOptions`](../../../../../../Types/type-aliases/ChannelEditNameEndpointOptions.md) - -The options to use. - -## Returns - -[`IChannelEditNameRequest`](../../../../../../Types/interfaces/IChannelEditNameRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/channel/EditNameEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/channel/EditNameEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/variables/PATH.md deleted file mode 100644 index 22922151..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Channel/namespaces/EditNameEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Channel](../../../README.md) / [EditNameEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/channel/edit_name"` = `'/channel/edit_name'` - -## Defined in - -[src/core/endpoints/channel/EditNameEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/channel/EditNameEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Comment/README.md b/docs/api/namespaces/Endpoints/namespaces/Comment/README.md deleted file mode 100644 index 04425667..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Comment/README.md +++ /dev/null @@ -1,10 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Comment - -# Comment - -## Index - -### Namespaces - -- [CreateCommentEndpoint](namespaces/CreateCommentEndpoint/README.md) -- [PerformCommentActionEndpoint](namespaces/PerformCommentActionEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/README.md deleted file mode 100644 index edab77bf..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Comment](../../README.md) / CreateCommentEndpoint - -# CreateCommentEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/functions/build.md deleted file mode 100644 index e3de4bc3..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Comment](../../../README.md) / [CreateCommentEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`ICreateCommentRequest`](../../../../../../Types/type-aliases/ICreateCommentRequest.md) - -Builds a `/comment/create_comment` request payload. - -## Parameters - -• **options**: [`CreateCommentEndpointOptions`](../../../../../../Types/type-aliases/CreateCommentEndpointOptions.md) - -The options to use. - -## Returns - -[`ICreateCommentRequest`](../../../../../../Types/type-aliases/ICreateCommentRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/comment/CreateCommentEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/comment/CreateCommentEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/variables/PATH.md deleted file mode 100644 index 603647b9..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/CreateCommentEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Comment](../../../README.md) / [CreateCommentEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/comment/create_comment"` = `'/comment/create_comment'` - -## Defined in - -[src/core/endpoints/comment/CreateCommentEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/comment/CreateCommentEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/README.md deleted file mode 100644 index 5fbc488b..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Comment](../../README.md) / PerformCommentActionEndpoint - -# PerformCommentActionEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/functions/build.md deleted file mode 100644 index 0d9e5ec2..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Comment](../../../README.md) / [PerformCommentActionEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IPerformCommentActionRequest`](../../../../../../Types/interfaces/IPerformCommentActionRequest.md) - -Builds a `/comment/perform_comment_action` request payload. - -## Parameters - -• **options**: [`IPerformCommentActionRequest`](../../../../../../Types/interfaces/IPerformCommentActionRequest.md) - -The options to use. - -## Returns - -[`IPerformCommentActionRequest`](../../../../../../Types/interfaces/IPerformCommentActionRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/comment/PerformCommentActionEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/comment/PerformCommentActionEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/variables/PATH.md deleted file mode 100644 index 97d29755..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Comment/namespaces/PerformCommentActionEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Comment](../../../README.md) / [PerformCommentActionEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/comment/perform_comment_action"` = `'/comment/perform_comment_action'` - -## Defined in - -[src/core/endpoints/comment/PerformCommentActionEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/comment/PerformCommentActionEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/README.md deleted file mode 100644 index a4c639ed..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / GetNotificationMenuEndpoint - -# GetNotificationMenuEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/functions/build.md deleted file mode 100644 index e94552f9..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [GetNotificationMenuEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IGetNotificationMenuRequest`](../../../../Types/type-aliases/IGetNotificationMenuRequest.md) - -Builds a `/get_notification_menu` request payload. - -## Parameters - -• **opts**: [`GetNotificationMenuEndpointOptions`](../../../../Types/type-aliases/GetNotificationMenuEndpointOptions.md) - -The options to use. - -## Returns - -[`IGetNotificationMenuRequest`](../../../../Types/type-aliases/IGetNotificationMenuRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/GetNotificationMenuEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/GetNotificationMenuEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/variables/PATH.md deleted file mode 100644 index 191da64c..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/GetNotificationMenuEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [GetNotificationMenuEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/notification/get_notification_menu"` = `'/notification/get_notification_menu'` - -## Defined in - -[src/core/endpoints/GetNotificationMenuEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/GetNotificationMenuEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/GuideEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/GuideEndpoint/README.md deleted file mode 100644 index f1dc39c4..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/GuideEndpoint/README.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / GuideEndpoint - -# GuideEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/GuideEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/GuideEndpoint/variables/PATH.md deleted file mode 100644 index 31f4bdf1..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/GuideEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [GuideEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/guide"` = `'/guide'` - -## Defined in - -[src/core/endpoints/GuideEndpoint.ts:1](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/GuideEndpoint.ts#L1) diff --git a/docs/api/namespaces/Endpoints/namespaces/Kids/README.md b/docs/api/namespaces/Endpoints/namespaces/Kids/README.md deleted file mode 100644 index ea676965..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Kids/README.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Kids - -# Kids - -## Index - -### Namespaces - -- [BlocklistPickerEndpoint](namespaces/BlocklistPickerEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/README.md deleted file mode 100644 index f37c0ef6..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Kids](../../README.md) / BlocklistPickerEndpoint - -# BlocklistPickerEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/functions/build.md deleted file mode 100644 index 7edbc8f6..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Kids](../../../README.md) / [BlocklistPickerEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IBlocklistPickerRequest`](../../../../../../Types/type-aliases/IBlocklistPickerRequest.md) - -Builds a `/kids/get_kids_blocklist_picker` request payload. - -## Parameters - -• **options**: [`BlocklistPickerRequestEndpointOptions`](../../../../../../Types/type-aliases/BlocklistPickerRequestEndpointOptions.md) - -The options to use. - -## Returns - -[`IBlocklistPickerRequest`](../../../../../../Types/type-aliases/IBlocklistPickerRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/kids/BlocklistPickerEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/kids/BlocklistPickerEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/variables/PATH.md deleted file mode 100644 index 4a57ffd9..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Kids/namespaces/BlocklistPickerEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Kids](../../../README.md) / [BlocklistPickerEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/kids/get_kids_blocklist_picker"` = `'/kids/get_kids_blocklist_picker'` - -## Defined in - -[src/core/endpoints/kids/BlocklistPickerEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/kids/BlocklistPickerEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/README.md b/docs/api/namespaces/Endpoints/namespaces/Like/README.md deleted file mode 100644 index 51f9914f..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/README.md +++ /dev/null @@ -1,11 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Like - -# Like - -## Index - -### Namespaces - -- [DislikeEndpoint](namespaces/DislikeEndpoint/README.md) -- [LikeEndpoint](namespaces/LikeEndpoint/README.md) -- [RemoveLikeEndpoint](namespaces/RemoveLikeEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/README.md deleted file mode 100644 index d38be5c1..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Like](../../README.md) / DislikeEndpoint - -# DislikeEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/functions/build.md deleted file mode 100644 index d538fcc6..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Like](../../../README.md) / [DislikeEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IDislikeRequest`](../../../../../../Types/type-aliases/IDislikeRequest.md) - -Builds a `/like/dislike` endpoint payload. - -## Parameters - -• **options**: [`LikeEndpointOptions`](../../../../../../Types/type-aliases/LikeEndpointOptions.md) - -The options to use. - -## Returns - -[`IDislikeRequest`](../../../../../../Types/type-aliases/IDislikeRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/like/DislikeEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/like/DislikeEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/variables/PATH.md deleted file mode 100644 index 115df819..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/DislikeEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Like](../../../README.md) / [DislikeEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/like/dislike"` = `'/like/dislike'` - -## Defined in - -[src/core/endpoints/like/DislikeEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/like/DislikeEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/README.md deleted file mode 100644 index 63a21d6c..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Like](../../README.md) / LikeEndpoint - -# LikeEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/functions/build.md deleted file mode 100644 index 951bccc6..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Like](../../../README.md) / [LikeEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`ILikeRequest`](../../../../../../Types/type-aliases/ILikeRequest.md) - -Builds a `/like/like` endpoint payload. - -## Parameters - -• **options**: [`LikeEndpointOptions`](../../../../../../Types/type-aliases/LikeEndpointOptions.md) - -The options to use. - -## Returns - -[`ILikeRequest`](../../../../../../Types/type-aliases/ILikeRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/like/LikeEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/like/LikeEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/variables/PATH.md deleted file mode 100644 index afa248ae..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/LikeEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Like](../../../README.md) / [LikeEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/like/like"` = `'/like/like'` - -## Defined in - -[src/core/endpoints/like/LikeEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/like/LikeEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/README.md deleted file mode 100644 index ab4f85ba..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Like](../../README.md) / RemoveLikeEndpoint - -# RemoveLikeEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/functions/build.md deleted file mode 100644 index 60aa9246..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Like](../../../README.md) / [RemoveLikeEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IRemoveLikeRequest`](../../../../../../Types/type-aliases/IRemoveLikeRequest.md) - -Builds a `/like/removelike` endpoint payload. - -## Parameters - -• **options**: [`LikeEndpointOptions`](../../../../../../Types/type-aliases/LikeEndpointOptions.md) - -The options to use. - -## Returns - -[`IRemoveLikeRequest`](../../../../../../Types/type-aliases/IRemoveLikeRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/like/RemoveLikeEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/like/RemoveLikeEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/variables/PATH.md deleted file mode 100644 index bbd85b34..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Like/namespaces/RemoveLikeEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Like](../../../README.md) / [RemoveLikeEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/like/removelike"` = `'/like/removelike'` - -## Defined in - -[src/core/endpoints/like/RemoveLikeEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/like/RemoveLikeEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Music/README.md b/docs/api/namespaces/Endpoints/namespaces/Music/README.md deleted file mode 100644 index 95dc620b..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Music/README.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Music - -# Music - -## Index - -### Namespaces - -- [GetSearchSuggestionsEndpoint](namespaces/GetSearchSuggestionsEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/README.md deleted file mode 100644 index 5aa29b07..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Music](../../README.md) / GetSearchSuggestionsEndpoint - -# GetSearchSuggestionsEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/functions/build.md deleted file mode 100644 index 95a91d77..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Music](../../../README.md) / [GetSearchSuggestionsEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IMusicGetSearchSuggestionsRequest`](../../../../../../Types/interfaces/IMusicGetSearchSuggestionsRequest.md) - -Builds a `/music/get_search_suggestions` request payload. - -## Parameters - -• **opts**: [`MusicGetSearchSuggestionsEndpointOptions`](../../../../../../Types/type-aliases/MusicGetSearchSuggestionsEndpointOptions.md) - -The options to use. - -## Returns - -[`IMusicGetSearchSuggestionsRequest`](../../../../../../Types/interfaces/IMusicGetSearchSuggestionsRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/music/GetSearchSuggestionsEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/music/GetSearchSuggestionsEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/variables/PATH.md deleted file mode 100644 index 490d719c..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Music/namespaces/GetSearchSuggestionsEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Music](../../../README.md) / [GetSearchSuggestionsEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/music/get_search_suggestions"` = `'/music/get_search_suggestions'` - -## Defined in - -[src/core/endpoints/music/GetSearchSuggestionsEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/music/GetSearchSuggestionsEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/README.md deleted file mode 100644 index 9faa56b2..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / NextEndpoint - -# NextEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/functions/build.md deleted file mode 100644 index 63ab4b20..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [NextEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`INextRequest`](../../../../Types/type-aliases/INextRequest.md) - -Builds a `/next` request payload. - -## Parameters - -• **opts**: [`NextEndpointOptions`](../../../../Types/type-aliases/NextEndpointOptions.md) - -The options to use. - -## Returns - -[`INextRequest`](../../../../Types/type-aliases/INextRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/NextEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/NextEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/variables/PATH.md deleted file mode 100644 index 3aceb778..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/NextEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [NextEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/next"` = `'/next'` - -## Defined in - -[src/core/endpoints/NextEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/NextEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Notification/README.md b/docs/api/namespaces/Endpoints/namespaces/Notification/README.md deleted file mode 100644 index a98ffbbf..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Notification/README.md +++ /dev/null @@ -1,10 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Notification - -# Notification - -## Index - -### Namespaces - -- [GetUnseenCountEndpoint](namespaces/GetUnseenCountEndpoint/README.md) -- [ModifyChannelPreferenceEndpoint](namespaces/ModifyChannelPreferenceEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/GetUnseenCountEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/GetUnseenCountEndpoint/README.md deleted file mode 100644 index 06837d71..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/GetUnseenCountEndpoint/README.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Notification](../../README.md) / GetUnseenCountEndpoint - -# GetUnseenCountEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/GetUnseenCountEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/GetUnseenCountEndpoint/variables/PATH.md deleted file mode 100644 index 83c605fd..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/GetUnseenCountEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Notification](../../../README.md) / [GetUnseenCountEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/notification/get_unseen_count"` = `'/notification/get_unseen_count'` - -## Defined in - -[src/core/endpoints/notification/GetUnseenCountEndpoint.ts:1](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/notification/GetUnseenCountEndpoint.ts#L1) diff --git a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/README.md deleted file mode 100644 index 631481fe..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Notification](../../README.md) / ModifyChannelPreferenceEndpoint - -# ModifyChannelPreferenceEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/functions/build.md deleted file mode 100644 index 08faae83..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Notification](../../../README.md) / [ModifyChannelPreferenceEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IModifyChannelPreferenceRequest`](../../../../../../Types/interfaces/IModifyChannelPreferenceRequest.md) - -Builds a `/notification/modify_channel_preference` request payload. - -## Parameters - -• **options**: [`IModifyChannelPreferenceRequest`](../../../../../../Types/interfaces/IModifyChannelPreferenceRequest.md) - -The options to use. - -## Returns - -[`IModifyChannelPreferenceRequest`](../../../../../../Types/interfaces/IModifyChannelPreferenceRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/notification/ModifyChannelPreferenceEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/notification/ModifyChannelPreferenceEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/variables/PATH.md deleted file mode 100644 index da883d86..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Notification/namespaces/ModifyChannelPreferenceEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Notification](../../../README.md) / [ModifyChannelPreferenceEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/notification/modify_channel_preference"` = `'/notification/modify_channel_preference'` - -## Defined in - -[src/core/endpoints/notification/ModifyChannelPreferenceEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/notification/ModifyChannelPreferenceEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/README.md deleted file mode 100644 index d09e8b62..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / PlayerEndpoint - -# PlayerEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/functions/build.md deleted file mode 100644 index 393506ea..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [PlayerEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IPlayerRequest`](../../../../Types/interfaces/IPlayerRequest.md) - -Builds a `/player` request payload. - -## Parameters - -• **opts**: [`PlayerEndpointOptions`](../../../../Types/type-aliases/PlayerEndpointOptions.md) - -The options to use. - -## Returns - -[`IPlayerRequest`](../../../../Types/interfaces/IPlayerRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/PlayerEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/PlayerEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/variables/PATH.md deleted file mode 100644 index 83aba76b..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/PlayerEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [PlayerEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/player"` = `'/player'` - -## Defined in - -[src/core/endpoints/PlayerEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/PlayerEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Playlist/README.md b/docs/api/namespaces/Endpoints/namespaces/Playlist/README.md deleted file mode 100644 index e30fe96a..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Playlist/README.md +++ /dev/null @@ -1,10 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Playlist - -# Playlist - -## Index - -### Namespaces - -- [CreateEndpoint](namespaces/CreateEndpoint/README.md) -- [DeleteEndpoint](namespaces/DeleteEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/README.md deleted file mode 100644 index f6a71b31..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Playlist](../../README.md) / CreateEndpoint - -# CreateEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/functions/build.md deleted file mode 100644 index 62f0137a..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Playlist](../../../README.md) / [CreateEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`ICreatePlaylistRequest`](../../../../../../Types/type-aliases/ICreatePlaylistRequest.md) - -Builds a `/playlist/create` request payload. - -## Parameters - -• **opts**: [`CreatePlaylistEndpointOptions`](../../../../../../Types/type-aliases/CreatePlaylistEndpointOptions.md) - -The options to use. - -## Returns - -[`ICreatePlaylistRequest`](../../../../../../Types/type-aliases/ICreatePlaylistRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/playlist/CreateEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/playlist/CreateEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/variables/PATH.md deleted file mode 100644 index 93ff055c..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/CreateEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Playlist](../../../README.md) / [CreateEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/playlist/create"` = `'/playlist/create'` - -## Defined in - -[src/core/endpoints/playlist/CreateEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/playlist/CreateEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/README.md deleted file mode 100644 index 4aa2ba9f..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Playlist](../../README.md) / DeleteEndpoint - -# DeleteEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/functions/build.md deleted file mode 100644 index 076c055c..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Playlist](../../../README.md) / [DeleteEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IDeletePlaylistRequest`](../../../../../../Types/type-aliases/IDeletePlaylistRequest.md) - -Builds a `/playlist/delete` request payload. - -## Parameters - -• **opts**: [`DeletePlaylistEndpointOptions`](../../../../../../Types/type-aliases/DeletePlaylistEndpointOptions.md) - -The options to use. - -## Returns - -[`IDeletePlaylistRequest`](../../../../../../Types/type-aliases/IDeletePlaylistRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/playlist/DeleteEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/playlist/DeleteEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/variables/PATH.md deleted file mode 100644 index fdbcfcd7..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Playlist/namespaces/DeleteEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Playlist](../../../README.md) / [DeleteEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/playlist/delete"` = `'/playlist/delete'` - -## Defined in - -[src/core/endpoints/playlist/DeleteEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/playlist/DeleteEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Reel/README.md b/docs/api/namespaces/Endpoints/namespaces/Reel/README.md deleted file mode 100644 index f6f8a5c9..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Reel/README.md +++ /dev/null @@ -1,10 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Reel - -# Reel - -## Index - -### Namespaces - -- [ReelItemWatchEndpoint](namespaces/ReelItemWatchEndpoint/README.md) -- [ReelWatchSequenceEndpoint](namespaces/ReelWatchSequenceEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/README.md deleted file mode 100644 index ab63b552..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Reel](../../README.md) / ReelItemWatchEndpoint - -# ReelItemWatchEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/functions/build.md deleted file mode 100644 index c95c436e..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Reel](../../../README.md) / [ReelItemWatchEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IReelItemWatchRequest`](../../../../../../Types/interfaces/IReelItemWatchRequest.md) - -Builds a `/reel/reel_watch_sequence` request payload. - -## Parameters - -• **opts**: [`ReelItemWatchEndpointOptions`](../../../../../../Types/type-aliases/ReelItemWatchEndpointOptions.md) - -The options to use. - -## Returns - -[`IReelItemWatchRequest`](../../../../../../Types/interfaces/IReelItemWatchRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/reel/ReelItemWatchEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/reel/ReelItemWatchEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/variables/PATH.md deleted file mode 100644 index fc403696..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelItemWatchEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Reel](../../../README.md) / [ReelItemWatchEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/reel/reel_item_watch"` = `'/reel/reel_item_watch'` - -## Defined in - -[src/core/endpoints/reel/ReelItemWatchEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/reel/ReelItemWatchEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/README.md deleted file mode 100644 index fa8b7bad..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Reel](../../README.md) / ReelWatchSequenceEndpoint - -# ReelWatchSequenceEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/functions/build.md deleted file mode 100644 index 5b1840aa..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Reel](../../../README.md) / [ReelWatchSequenceEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IReelWatchSequenceRequest`](../../../../../../Types/interfaces/IReelWatchSequenceRequest.md) - -Builds a `/reel/reel_watch_sequence` request payload. - -## Parameters - -• **opts**: [`ReelWatchSequenceEndpointOptions`](../../../../../../Types/type-aliases/ReelWatchSequenceEndpointOptions.md) - -The options to use. - -## Returns - -[`IReelWatchSequenceRequest`](../../../../../../Types/interfaces/IReelWatchSequenceRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/reel/ReelWatchSequenceEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/reel/ReelWatchSequenceEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/variables/PATH.md deleted file mode 100644 index 61b69da3..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Reel/namespaces/ReelWatchSequenceEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Reel](../../../README.md) / [ReelWatchSequenceEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/reel/reel_watch_sequence"` = `'/reel/reel_watch_sequence'` - -## Defined in - -[src/core/endpoints/reel/ReelWatchSequenceEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/reel/ReelWatchSequenceEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/README.md deleted file mode 100644 index f7cdee09..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / ResolveURLEndpoint - -# ResolveURLEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/functions/build.md deleted file mode 100644 index 2f6374de..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [ResolveURLEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`IResolveURLRequest`](../../../../Types/interfaces/IResolveURLRequest.md) - -Builds a `/resolve_url` request payload. - -## Parameters - -• **opts**: [`IResolveURLRequest`](../../../../Types/interfaces/IResolveURLRequest.md) - -The options to use. - -## Returns - -[`IResolveURLRequest`](../../../../Types/interfaces/IResolveURLRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/ResolveURLEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/ResolveURLEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/variables/PATH.md deleted file mode 100644 index f9b0d2f3..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/ResolveURLEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [ResolveURLEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/navigation/resolve_url"` = `'/navigation/resolve_url'` - -## Defined in - -[src/core/endpoints/ResolveURLEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/ResolveURLEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/README.md deleted file mode 100644 index 56f703d4..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / SearchEndpoint - -# SearchEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/functions/build.md deleted file mode 100644 index 0d02d44a..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [SearchEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`ISearchRequest`](../../../../Types/interfaces/ISearchRequest.md) - -Builds a `/search` request payload. - -## Parameters - -• **opts**: [`ISearchRequest`](../../../../Types/interfaces/ISearchRequest.md) - -The options to use. - -## Returns - -[`ISearchRequest`](../../../../Types/interfaces/ISearchRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/SearchEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/SearchEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/variables/PATH.md deleted file mode 100644 index 6b25b596..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/SearchEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [SearchEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/search"` = `'/search'` - -## Defined in - -[src/core/endpoints/SearchEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/SearchEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Subscription/README.md b/docs/api/namespaces/Endpoints/namespaces/Subscription/README.md deleted file mode 100644 index c44b7c25..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Subscription/README.md +++ /dev/null @@ -1,10 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Subscription - -# Subscription - -## Index - -### Namespaces - -- [SubscribeEndpoint](namespaces/SubscribeEndpoint/README.md) -- [UnsubscribeEndpoint](namespaces/UnsubscribeEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/README.md deleted file mode 100644 index 8a6fa32d..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Subscription](../../README.md) / SubscribeEndpoint - -# SubscribeEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/functions/build.md deleted file mode 100644 index e9897435..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Subscription](../../../README.md) / [SubscribeEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`ISubscribeRequest`](../../../../../../Types/type-aliases/ISubscribeRequest.md) - -Builds a `/subscription/subscribe` endpoint payload. - -## Parameters - -• **options**: [`SubscribeEndpointOptions`](../../../../../../Types/type-aliases/SubscribeEndpointOptions.md) - -The options to use. - -## Returns - -[`ISubscribeRequest`](../../../../../../Types/type-aliases/ISubscribeRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/subscription/SubscribeEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/subscription/SubscribeEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/variables/PATH.md deleted file mode 100644 index 18b1f406..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/SubscribeEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Subscription](../../../README.md) / [SubscribeEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/subscription/subscribe"` = `'/subscription/subscribe'` - -## Defined in - -[src/core/endpoints/subscription/SubscribeEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/subscription/SubscribeEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/README.md deleted file mode 100644 index 8cdf60f9..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Subscription](../../README.md) / UnsubscribeEndpoint - -# UnsubscribeEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/functions/build.md deleted file mode 100644 index 50685380..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Subscription](../../../README.md) / [UnsubscribeEndpoint](../README.md) / build - -# Function: build() - -> **build**(`options`): [`IUnsubscribeRequest`](../../../../../../Types/type-aliases/IUnsubscribeRequest.md) - -Builds a `/subscription/unsubscribe` endpoint payload. - -## Parameters - -• **options**: [`SubscribeEndpointOptions`](../../../../../../Types/type-aliases/SubscribeEndpointOptions.md) - -The options to use. - -## Returns - -[`IUnsubscribeRequest`](../../../../../../Types/type-aliases/IUnsubscribeRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/subscription/UnsubscribeEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/subscription/UnsubscribeEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/variables/PATH.md deleted file mode 100644 index 0238eb61..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Subscription/namespaces/UnsubscribeEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Subscription](../../../README.md) / [UnsubscribeEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/subscription/unsubscribe"` = `'/subscription/unsubscribe'` - -## Defined in - -[src/core/endpoints/subscription/UnsubscribeEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/subscription/UnsubscribeEndpoint.ts#L3) diff --git a/docs/api/namespaces/Endpoints/namespaces/Upload/README.md b/docs/api/namespaces/Endpoints/namespaces/Upload/README.md deleted file mode 100644 index d784c947..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Upload/README.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / Upload - -# Upload - -## Index - -### Namespaces - -- [CreateVideoEndpoint](namespaces/CreateVideoEndpoint/README.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/README.md b/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/README.md deleted file mode 100644 index caa661c9..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/README.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../../../../README.md) / [Endpoints](../../../../README.md) / [Upload](../../README.md) / CreateVideoEndpoint - -# CreateVideoEndpoint - -## Index - -### Variables - -- [PATH](variables/PATH.md) - -### Functions - -- [build](functions/build.md) diff --git a/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/functions/build.md b/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/functions/build.md deleted file mode 100644 index 4c6f9346..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/functions/build.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Upload](../../../README.md) / [CreateVideoEndpoint](../README.md) / build - -# Function: build() - -> **build**(`opts`): [`ICreateVideoRequest`](../../../../../../Types/type-aliases/ICreateVideoRequest.md) - -Builds a `/upload/createvideo` request payload. - -## Parameters - -• **opts**: [`CreateVideoEndpointOptions`](../../../../../../Types/type-aliases/CreateVideoEndpointOptions.md) - -The options to use. - -## Returns - -[`ICreateVideoRequest`](../../../../../../Types/type-aliases/ICreateVideoRequest.md) - -The payload. - -## Defined in - -[src/core/endpoints/upload/CreateVideoEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/upload/CreateVideoEndpoint.ts#L10) diff --git a/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/variables/PATH.md b/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/variables/PATH.md deleted file mode 100644 index 0d11a24c..00000000 --- a/docs/api/namespaces/Endpoints/namespaces/Upload/namespaces/CreateVideoEndpoint/variables/PATH.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../../../../../README.md) / [Endpoints](../../../../../README.md) / [Upload](../../../README.md) / [CreateVideoEndpoint](../README.md) / PATH - -# Variable: PATH - -> `const` **PATH**: `"/upload/createvideo"` = `'/upload/createvideo'` - -## Defined in - -[src/core/endpoints/upload/CreateVideoEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/endpoints/upload/CreateVideoEndpoint.ts#L3) diff --git a/docs/api/namespaces/FormatUtils/functions/chooseFormat.md b/docs/api/namespaces/FormatUtils/functions/chooseFormat.md index e09b5565..4e53a8ac 100644 --- a/docs/api/namespaces/FormatUtils/functions/chooseFormat.md +++ b/docs/api/namespaces/FormatUtils/functions/chooseFormat.md @@ -22,4 +22,4 @@ Streaming data ## Defined in -[src/utils/FormatUtils.ts:133](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/FormatUtils.ts#L133) +[src/utils/FormatUtils.ts:138](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/FormatUtils.ts#L138) diff --git a/docs/api/namespaces/FormatUtils/functions/download.md b/docs/api/namespaces/FormatUtils/functions/download.md index 010c3603..729759c5 100644 --- a/docs/api/namespaces/FormatUtils/functions/download.md +++ b/docs/api/namespaces/FormatUtils/functions/download.md @@ -24,4 +24,4 @@ ## Defined in -[src/utils/FormatUtils.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/FormatUtils.ts#L10) +[src/utils/FormatUtils.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/FormatUtils.ts#L10) diff --git a/docs/api/namespaces/FormatUtils/functions/toDash.md b/docs/api/namespaces/FormatUtils/functions/toDash.md index 7a488e21..cd99afdd 100644 --- a/docs/api/namespaces/FormatUtils/functions/toDash.md +++ b/docs/api/namespaces/FormatUtils/functions/toDash.md @@ -20,7 +20,7 @@ • **actions?**: [`Actions`](../../../classes/Actions.md) -• **storyboards?**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) +• **storyboards?**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) • **caption\_tracks?**: `CaptionTrackData`[] @@ -32,4 +32,4 @@ ## Defined in -[src/utils/DashManifest.tsx:269](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/DashManifest.tsx#L269) +[src/utils/DashManifest.tsx:269](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/DashManifest.tsx#L269) diff --git a/docs/api/namespaces/Generator/README.md b/docs/api/namespaces/Generator/README.md index 38e5bbfc..4e1b4bef 100644 --- a/docs/api/namespaces/Generator/README.md +++ b/docs/api/namespaces/Generator/README.md @@ -7,7 +7,7 @@ ### Interfaces - [ObjectInferenceType](interfaces/ObjectInferenceType.md) -- [PrimativeInferenceType](interfaces/PrimativeInferenceType.md) +- [PrimitiveInferenceType](interfaces/PrimitiveInferenceType.md) - [RendererInferenceType](interfaces/RendererInferenceType.md) ### Type Aliases diff --git a/docs/api/namespaces/Generator/functions/camelToSnake.md b/docs/api/namespaces/Generator/functions/camelToSnake.md index c38cb001..bb713205 100644 --- a/docs/api/namespaces/Generator/functions/camelToSnake.md +++ b/docs/api/namespaces/Generator/functions/camelToSnake.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/generator.ts:80](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L80) +[src/parser/generator.ts:82](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L82) diff --git a/docs/api/namespaces/Generator/functions/createRuntimeClass.md b/docs/api/namespaces/Generator/functions/createRuntimeClass.md index 3b477539..465a8917 100644 --- a/docs/api/namespaces/Generator/functions/createRuntimeClass.md +++ b/docs/api/namespaces/Generator/functions/createRuntimeClass.md @@ -18,6 +18,8 @@ The resolved key info • **logger**: [`ParserErrorHandler`](../../Parser/type-aliases/ParserErrorHandler.md) +The logger to log errors to + ## Returns [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md) @@ -26,4 +28,4 @@ Class based on the key info extending YTNode ## Defined in -[src/parser/generator.ts:408](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L408) +[src/parser/generator.ts:411](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L411) diff --git a/docs/api/namespaces/Generator/functions/generateRuntimeClass.md b/docs/api/namespaces/Generator/functions/generateRuntimeClass.md index b1df154f..158d1634 100644 --- a/docs/api/namespaces/Generator/functions/generateRuntimeClass.md +++ b/docs/api/namespaces/Generator/functions/generateRuntimeClass.md @@ -18,6 +18,8 @@ The example of the class • **logger**: [`ParserErrorHandler`](../../Parser/type-aliases/ParserErrorHandler.md) +The logger to log errors to + ## Returns [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> @@ -26,4 +28,4 @@ Class based on the example classdata extending YTNode ## Defined in -[src/parser/generator.ts:470](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L470) +[src/parser/generator.ts:474](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L474) diff --git a/docs/api/namespaces/Generator/functions/generateTypescriptClass.md b/docs/api/namespaces/Generator/functions/generateTypescriptClass.md index b69f52d4..8c295472 100644 --- a/docs/api/namespaces/Generator/functions/generateTypescriptClass.md +++ b/docs/api/namespaces/Generator/functions/generateTypescriptClass.md @@ -24,4 +24,4 @@ Typescript class file ## Defined in -[src/parser/generator.ts:491](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L491) +[src/parser/generator.ts:495](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L495) diff --git a/docs/api/namespaces/Generator/functions/inferType.md b/docs/api/namespaces/Generator/functions/inferType.md index 597c1445..aa1f1ecc 100644 --- a/docs/api/namespaces/Generator/functions/inferType.md +++ b/docs/api/namespaces/Generator/functions/inferType.md @@ -4,7 +4,7 @@ > **inferType**(`key`, `value`): [`InferenceType`](../type-aliases/InferenceType.md) -Infer the type of a key given its value +Infer the type of key given its value ## Parameters @@ -24,4 +24,4 @@ The inferred type ## Defined in -[src/parser/generator.ts:90](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L90) +[src/parser/generator.ts:92](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L92) diff --git a/docs/api/namespaces/Generator/functions/introspect.md b/docs/api/namespaces/Generator/functions/introspect.md index a5cdc551..375f6f0d 100644 --- a/docs/api/namespaces/Generator/functions/introspect.md +++ b/docs/api/namespaces/Generator/functions/introspect.md @@ -28,4 +28,4 @@ The key info and any unimplemented dependencies ## Defined in -[src/parser/generator.ts:374](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L374) +[src/parser/generator.ts:376](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L376) diff --git a/docs/api/namespaces/Generator/functions/isArrayType.md b/docs/api/namespaces/Generator/functions/isArrayType.md index 7b7b2e03..256e811a 100644 --- a/docs/api/namespaces/Generator/functions/isArrayType.md +++ b/docs/api/namespaces/Generator/functions/isArrayType.md @@ -20,4 +20,4 @@ If it is an array, return the InferenceType. Otherwise, return false. ## Defined in -[src/parser/generator.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L220) +[src/parser/generator.ts:222](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L222) diff --git a/docs/api/namespaces/Generator/functions/isIgnoredKey.md b/docs/api/namespaces/Generator/functions/isIgnoredKey.md index fea49b8a..a72a0bd9 100644 --- a/docs/api/namespaces/Generator/functions/isIgnoredKey.md +++ b/docs/api/namespaces/Generator/functions/isIgnoredKey.md @@ -20,4 +20,4 @@ Whether or not the key is ignored ## Defined in -[src/parser/generator.ts:398](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L398) +[src/parser/generator.ts:400](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L400) diff --git a/docs/api/namespaces/Generator/functions/isMiscType.md b/docs/api/namespaces/Generator/functions/isMiscType.md index aef939f9..95c5f014 100644 --- a/docs/api/namespaces/Generator/functions/isMiscType.md +++ b/docs/api/namespaces/Generator/functions/isMiscType.md @@ -24,4 +24,4 @@ If it is a misc type, return the InferenceType. Otherwise, return false. ## Defined in -[src/parser/generator.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L161) +[src/parser/generator.ts:163](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L163) diff --git a/docs/api/namespaces/Generator/functions/isRenderer.md b/docs/api/namespaces/Generator/functions/isRenderer.md index a15a24ed..478dfa05 100644 --- a/docs/api/namespaces/Generator/functions/isRenderer.md +++ b/docs/api/namespaces/Generator/functions/isRenderer.md @@ -20,4 +20,4 @@ If it is a renderer, return the class name. Otherwise, return false. ## Defined in -[src/parser/generator.ts:200](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L200) +[src/parser/generator.ts:202](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L202) diff --git a/docs/api/namespaces/Generator/functions/isRendererList.md b/docs/api/namespaces/Generator/functions/isRendererList.md index f2d409f4..3f6827c7 100644 --- a/docs/api/namespaces/Generator/functions/isRendererList.md +++ b/docs/api/namespaces/Generator/functions/isRendererList.md @@ -21,4 +21,4 @@ Otherwise, return false. ## Defined in -[src/parser/generator.ts:139](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L139) +[src/parser/generator.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L141) diff --git a/docs/api/namespaces/Generator/functions/mergeKeyInfo.md b/docs/api/namespaces/Generator/functions/mergeKeyInfo.md index 6bf6fb96..251bbc04 100644 --- a/docs/api/namespaces/Generator/functions/mergeKeyInfo.md +++ b/docs/api/namespaces/Generator/functions/mergeKeyInfo.md @@ -32,4 +32,4 @@ The merged key info ## Defined in -[src/parser/generator.ts:736](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L736) +[src/parser/generator.ts:734](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L734) diff --git a/docs/api/namespaces/Generator/functions/parse.md b/docs/api/namespaces/Generator/functions/parse.md index 210c8da6..db12dc9f 100644 --- a/docs/api/namespaces/Generator/functions/parse.md +++ b/docs/api/namespaces/Generator/functions/parse.md @@ -32,4 +32,4 @@ The parsed value ## Defined in -[src/parser/generator.ts:678](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L678) +[src/parser/generator.ts:681](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L681) diff --git a/docs/api/namespaces/Generator/functions/toParser.md b/docs/api/namespaces/Generator/functions/toParser.md index 3fff9fe5..5a2f6e8a 100644 --- a/docs/api/namespaces/Generator/functions/toParser.md +++ b/docs/api/namespaces/Generator/functions/toParser.md @@ -32,4 +32,4 @@ Statement to parse the given key ## Defined in -[src/parser/generator.ts:575](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L575) +[src/parser/generator.ts:578](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L578) diff --git a/docs/api/namespaces/Generator/functions/toTypeDeclaration.md b/docs/api/namespaces/Generator/functions/toTypeDeclaration.md index 3f49fa04..dfb4894e 100644 --- a/docs/api/namespaces/Generator/functions/toTypeDeclaration.md +++ b/docs/api/namespaces/Generator/functions/toTypeDeclaration.md @@ -24,4 +24,4 @@ Typescript type declaration ## Defined in -[src/parser/generator.ts:516](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L516) +[src/parser/generator.ts:520](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L520) diff --git a/docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md b/docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md index 9091a044..f0b11f29 100644 --- a/docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md +++ b/docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/generator.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L37) +[src/parser/generator.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L39) *** @@ -20,7 +20,7 @@ #### Defined in -[src/parser/generator.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L38) +[src/parser/generator.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L40) *** @@ -30,4 +30,4 @@ #### Defined in -[src/parser/generator.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L36) +[src/parser/generator.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L38) diff --git a/docs/api/namespaces/Generator/interfaces/PrimativeInferenceType.md b/docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md similarity index 50% rename from docs/api/namespaces/Generator/interfaces/PrimativeInferenceType.md rename to docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md index aee30823..02da4e22 100644 --- a/docs/api/namespaces/Generator/interfaces/PrimativeInferenceType.md +++ b/docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md @@ -1,6 +1,6 @@ -[youtubei.js](../../../README.md) / [Generator](../README.md) / PrimativeInferenceType +[youtubei.js](../../../README.md) / [Generator](../README.md) / PrimitiveInferenceType -# Interface: PrimativeInferenceType +# Interface: PrimitiveInferenceType ## Properties @@ -10,17 +10,17 @@ #### Defined in -[src/parser/generator.ts:50](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L50) +[src/parser/generator.ts:52](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L52) *** ### type -> **type**: `"primative"` +> **type**: `"primitive"` #### Defined in -[src/parser/generator.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L48) +[src/parser/generator.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L50) *** @@ -30,4 +30,4 @@ #### Defined in -[src/parser/generator.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L49) +[src/parser/generator.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L51) diff --git a/docs/api/namespaces/Generator/interfaces/RendererInferenceType.md b/docs/api/namespaces/Generator/interfaces/RendererInferenceType.md index cfdd6f10..7ac00d28 100644 --- a/docs/api/namespaces/Generator/interfaces/RendererInferenceType.md +++ b/docs/api/namespaces/Generator/interfaces/RendererInferenceType.md @@ -10,7 +10,7 @@ #### Defined in -[src/parser/generator.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L44) +[src/parser/generator.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L46) *** @@ -20,7 +20,7 @@ #### Defined in -[src/parser/generator.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L43) +[src/parser/generator.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L45) *** @@ -30,4 +30,4 @@ #### Defined in -[src/parser/generator.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L42) +[src/parser/generator.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index 36f7a77c..b260507d 100644 --- a/docs/api/namespaces/Generator/type-aliases/ArrayInferenceType.md +++ b/docs/api/namespaces/Generator/type-aliases/ArrayInferenceType.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/generator.ts:53](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L53) +[src/parser/generator.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index 3e234a60..691e16ea 100644 --- a/docs/api/namespaces/Generator/type-aliases/InferenceType.md +++ b/docs/api/namespaces/Generator/type-aliases/InferenceType.md @@ -2,8 +2,8 @@ # Type Alias: InferenceType -> **InferenceType**: [`RendererInferenceType`](../interfaces/RendererInferenceType.md) \| [`MiscInferenceType`](MiscInferenceType.md) \| [`ObjectInferenceType`](../interfaces/ObjectInferenceType.md) \| [`PrimativeInferenceType`](../interfaces/PrimativeInferenceType.md) \| [`ArrayInferenceType`](ArrayInferenceType.md) +> **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:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L70) +[src/parser/generator.ts:72](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index fb56c9e9..f66cb611 100644 --- a/docs/api/namespaces/Generator/type-aliases/KeyInfo.md +++ b/docs/api/namespaces/Generator/type-aliases/KeyInfo.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/generator.ts:72](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L72) +[src/parser/generator.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index ec09b93b..247e4947 100644 --- a/docs/api/namespaces/Generator/type-aliases/MiscInferenceType.md +++ b/docs/api/namespaces/Generator/type-aliases/MiscInferenceType.md @@ -6,4 +6,4 @@ ## Defined in -[src/parser/generator.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L13) +[src/parser/generator.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L15) diff --git a/docs/api/namespaces/Helpers/classes/Maybe.md b/docs/api/namespaces/Helpers/classes/Maybe.md index 639a2cdd..c662abfe 100644 --- a/docs/api/namespaces/Helpers/classes/Maybe.md +++ b/docs/api/namespaces/Helpers/classes/Maybe.md @@ -2,6 +2,8 @@ # Class: Maybe +A wrapper class that provides type-safe access to a value. + ## Constructors ### new Maybe() @@ -18,7 +20,7 @@ #### Defined in -[src/parser/helpers.ts:69](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L69) +[src/parser/helpers.ts:76](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L76) ## Accessors @@ -32,7 +34,7 @@ #### Defined in -[src/parser/helpers.ts:87](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L87) +[src/parser/helpers.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L91) ## Methods @@ -50,7 +52,7 @@ This call is not meant to be used outside of debugging. Please use the specific #### Defined in -[src/parser/helpers.ts:283](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L283) +[src/parser/helpers.ts:287](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L287) *** @@ -72,7 +74,7 @@ If the value is not an array. #### Defined in -[src/parser/helpers.ts:171](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L171) +[src/parser/helpers.ts:175](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L175) *** @@ -94,7 +96,7 @@ If the value is not an array #### Defined in -[src/parser/helpers.ts:183](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L183) +[src/parser/helpers.ts:187](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L187) *** @@ -108,7 +110,7 @@ If the value is not an array #### Defined in -[src/parser/helpers.ts:107](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L107) +[src/parser/helpers.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L111) *** @@ -122,7 +124,7 @@ If the value is not an array #### Defined in -[src/parser/helpers.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L115) +[src/parser/helpers.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L119) *** @@ -136,7 +138,7 @@ If the value is not an array #### Defined in -[src/parser/helpers.ts:158](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L158) +[src/parser/helpers.ts:162](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L162) *** @@ -168,7 +170,7 @@ If the node is not of the given type. #### Defined in -[src/parser/helpers.ts:294](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L294) +[src/parser/helpers.ts:298](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L298) *** @@ -186,7 +188,7 @@ whether the value is an array. #### Defined in -[src/parser/helpers.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L199) +[src/parser/helpers.ts:203](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L203) *** @@ -200,7 +202,7 @@ whether the value is an array. #### Defined in -[src/parser/helpers.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L111) +[src/parser/helpers.ts:115](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L115) *** @@ -214,7 +216,7 @@ whether the value is an array. #### Defined in -[src/parser/helpers.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L119) +[src/parser/helpers.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L123) *** @@ -228,7 +230,7 @@ whether the value is an array. #### Defined in -[src/parser/helpers.ts:162](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L162) +[src/parser/helpers.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L166) *** @@ -256,7 +258,7 @@ Whether the node is an instance of the given type. #### Defined in -[src/parser/helpers.ts:306](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L306) +[src/parser/helpers.ts:310](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L310) *** @@ -274,7 +276,7 @@ Whether the value is a YTNode. #### Defined in -[src/parser/helpers.ts:219](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L219) +[src/parser/helpers.ts:223](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L223) *** @@ -304,7 +306,7 @@ Whether the value is a YTNode of the given type. #### Defined in -[src/parser/helpers.ts:238](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L238) +[src/parser/helpers.ts:242](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L242) *** @@ -318,7 +320,7 @@ Whether the value is a YTNode of the given type. #### Defined in -[src/parser/helpers.ts:145](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L145) +[src/parser/helpers.ts:149](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L149) *** @@ -332,7 +334,7 @@ Whether the value is a YTNode of the given type. #### Defined in -[src/parser/helpers.ts:103](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L103) +[src/parser/helpers.ts:107](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L107) *** @@ -346,7 +348,7 @@ Whether the value is a YTNode of the given type. #### Defined in -[src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L153) +[src/parser/helpers.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L157) *** @@ -362,7 +364,7 @@ Check if the value is an ObservedArray. #### Defined in -[src/parser/helpers.ts:256](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L256) +[src/parser/helpers.ts:260](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L260) *** @@ -378,7 +380,7 @@ Is the result a SuperParsedResult? #### Defined in -[src/parser/helpers.ts:275](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L275) +[src/parser/helpers.ts:279](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L279) *** @@ -392,7 +394,7 @@ Is the result a SuperParsedResult? #### Defined in -[src/parser/helpers.ts:95](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L95) +[src/parser/helpers.ts:99](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L99) *** @@ -406,7 +408,7 @@ Is the result a SuperParsedResult? #### Defined in -[src/parser/helpers.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L127) +[src/parser/helpers.ts:131](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L131) *** @@ -420,7 +422,7 @@ Is the result a SuperParsedResult? #### Defined in -[src/parser/helpers.ts:135](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L135) +[src/parser/helpers.ts:139](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L139) *** @@ -442,7 +444,7 @@ If the value is not a YTNode. #### Defined in -[src/parser/helpers.ts:208](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L208) +[src/parser/helpers.ts:212](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L212) *** @@ -468,7 +470,7 @@ The type(s) to cast to. `InstanceType`\<`K`\[`number`\]\> -The node casted to the given type. +The node cast to the given type. #### Throws @@ -476,7 +478,7 @@ If the node is not of the given type. #### Defined in -[src/parser/helpers.ts:229](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L229) +[src/parser/helpers.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L233) *** @@ -490,7 +492,7 @@ If the node is not of the given type. #### Defined in -[src/parser/helpers.ts:139](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L139) +[src/parser/helpers.ts:143](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L143) *** @@ -504,7 +506,7 @@ If the node is not of the given type. #### Defined in -[src/parser/helpers.ts:99](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L99) +[src/parser/helpers.ts:103](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L103) *** @@ -518,7 +520,7 @@ If the node is not of the given type. #### Defined in -[src/parser/helpers.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L149) +[src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L153) *** @@ -536,7 +538,7 @@ the value of the Maybe as a ObservedArray. #### Defined in -[src/parser/helpers.ts:246](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L246) +[src/parser/helpers.ts:250](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L250) *** @@ -558,7 +560,7 @@ If the value is not a SuperParsedResult. #### Defined in -[src/parser/helpers.ts:265](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L265) +[src/parser/helpers.ts:269](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L269) *** @@ -572,7 +574,7 @@ If the value is not a SuperParsedResult. #### Defined in -[src/parser/helpers.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L91) +[src/parser/helpers.ts:95](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L95) *** @@ -586,7 +588,7 @@ If the value is not a SuperParsedResult. #### Defined in -[src/parser/helpers.ts:123](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L123) +[src/parser/helpers.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L127) *** @@ -600,4 +602,4 @@ If the value is not a SuperParsedResult. #### Defined in -[src/parser/helpers.ts:131](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L131) +[src/parser/helpers.ts:135](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L135) diff --git a/docs/api/namespaces/Helpers/classes/Memo.md b/docs/api/namespaces/Helpers/classes/Memo.md index 3ce359d3..c7c6207a 100644 --- a/docs/api/namespaces/Helpers/classes/Memo.md +++ b/docs/api/namespaces/Helpers/classes/Memo.md @@ -26,7 +26,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:50 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:50 ### new Memo() @@ -34,7 +34,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col #### Parameters -• **iterable?**: `null` \| `Iterable`\ +• **iterable?**: `null` \| `Iterable`\ #### Returns @@ -46,7 +46,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:49 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:49 ## Properties @@ -60,7 +60,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137 +node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137 *** @@ -68,17 +68,13 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.sym > `readonly` **size**: `number` -#### Returns - -the number of elements in the Map. - #### Inherited from `Map.size` #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:45 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:45 *** @@ -92,19 +88,19 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319 +node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319 ## Methods ### \[iterator\]() -> **\[iterator\]**(): `MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> +> **\[iterator\]**(): `IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> Returns an iterable of entries in the map. #### Returns -`MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> +`IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> #### Inherited from @@ -112,7 +108,7 @@ Returns an iterable of entries in the map. #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:143 +node\_modules/typescript/lib/lib.es2015.iterable.d.ts:119 *** @@ -130,7 +126,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.ite #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:20 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:20 *** @@ -154,19 +150,19 @@ true if an element in the Map existed and has been removed, or false if the elem #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:24 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:24 *** ### entries() -> **entries**(): `MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> +> **entries**(): `IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> Returns an iterable of key, value pairs for every entry in the map. #### Returns -`MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> +`IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\> #### Inherited from @@ -174,7 +170,7 @@ Returns an iterable of key, value pairs for every entry in the map. #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:148 +node\_modules/typescript/lib/lib.es2015.iterable.d.ts:124 *** @@ -200,7 +196,7 @@ Executes a provided function once per each key/value pair in the Map, in inserti #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:28 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:28 *** @@ -226,7 +222,7 @@ Returns the element associated with the specified key. If no element is associat #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:33 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:33 *** @@ -252,7 +248,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col ##### Defined in -[src/parser/helpers.ts:478](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L478) +[src/parser/helpers.ts:512](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L512) #### getType(types) @@ -274,7 +270,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col ##### Defined in -[src/parser/helpers.ts:479](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L479) +[src/parser/helpers.ts:513](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L513) *** @@ -298,19 +294,19 @@ boolean indicating whether an element with the specified key exists or not. #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:37 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:37 *** ### keys() -> **keys**(): `MapIterator`\<`string`\> +> **keys**(): `IterableIterator`\<`string`\> Returns an iterable of keys in the map #### Returns -`MapIterator`\<`string`\> +`IterableIterator`\<`string`\> #### Inherited from @@ -318,7 +314,7 @@ Returns an iterable of keys in the map #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:153 +node\_modules/typescript/lib/lib.es2015.iterable.d.ts:129 *** @@ -344,19 +340,19 @@ Adds a new element with a specified key and value to the Map. If an element with #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:41 +node\_modules/typescript/lib/lib.es2015.collection.d.ts:41 *** ### values() -> **values**(): `MapIterator`\<[`YTNode`](YTNode.md)[]\> +> **values**(): `IterableIterator`\<[`YTNode`](YTNode.md)[]\> Returns an iterable of values in the map #### Returns -`MapIterator`\<[`YTNode`](YTNode.md)[]\> +`IterableIterator`\<[`YTNode`](YTNode.md)[]\> #### Inherited from @@ -364,7 +360,7 @@ Returns an iterable of values in the map #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:158 +node\_modules/typescript/lib/lib.es2015.iterable.d.ts:134 *** @@ -382,7 +378,7 @@ Groups members of an iterable according to the return value of the passed callba #### Parameters -• **items**: `Iterable`\<`T`, `any`, `any`\> +• **items**: `Iterable`\<`T`\> An iterable. @@ -400,4 +396,4 @@ A callback which will be invoked for each item in items. #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.esnext.collection.d.ts:25 +node\_modules/typescript/lib/lib.esnext.collection.d.ts:25 diff --git a/docs/api/namespaces/Helpers/classes/SuperParsedResult.md b/docs/api/namespaces/Helpers/classes/SuperParsedResult.md index ecc441d9..395dc5f5 100644 --- a/docs/api/namespaces/Helpers/classes/SuperParsedResult.md +++ b/docs/api/namespaces/Helpers/classes/SuperParsedResult.md @@ -24,7 +24,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] #### Defined in -[src/parser/helpers.ts:326](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L326) +[src/parser/helpers.ts:330](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L330) ## Accessors @@ -38,7 +38,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] #### Defined in -[src/parser/helpers.ts:333](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L333) +[src/parser/helpers.ts:337](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L337) *** @@ -52,7 +52,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] #### Defined in -[src/parser/helpers.ts:336](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L336) +[src/parser/helpers.ts:340](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L340) *** @@ -66,7 +66,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] #### Defined in -[src/parser/helpers.ts:330](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L330) +[src/parser/helpers.ts:334](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L334) ## Methods @@ -80,7 +80,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] #### Defined in -[src/parser/helpers.ts:340](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L340) +[src/parser/helpers.ts:344](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L344) *** @@ -94,4 +94,4 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] #### Defined in -[src/parser/helpers.ts:347](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L347) +[src/parser/helpers.ts:351](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L351) diff --git a/docs/api/namespaces/Helpers/classes/YTNode.md b/docs/api/namespaces/Helpers/classes/YTNode.md index 95e3e749..2691f2e1 100644 --- a/docs/api/namespaces/Helpers/classes/YTNode.md +++ b/docs/api/namespaces/Helpers/classes/YTNode.md @@ -15,7 +15,11 @@ - [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) - [`GetMultiPageMenuAction`](../../YTNodes/classes/GetMultiPageMenuAction.md) - [`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) +- [`SendFeedbackAction`](../../YTNodes/classes/SendFeedbackAction.md) +- [`SignalAction`](../../YTNodes/classes/SignalAction.md) - [`UpdateEngagementPanelAction`](../../YTNodes/classes/UpdateEngagementPanelAction.md) +- [`UpdateSubscribeButtonAction`](../../YTNodes/classes/UpdateSubscribeButtonAction.md) +- [`AddToPlaylist`](../../YTNodes/classes/AddToPlaylist.md) - [`Alert`](../../YTNodes/classes/Alert.md) - [`AlertWithButton`](../../YTNodes/classes/AlertWithButton.md) - [`AnalyticsMainAppKeyMetrics`](../../YTNodes/classes/AnalyticsMainAppKeyMetrics.md) @@ -74,6 +78,11 @@ - [`CollaboratorInfoCardContent`](../../YTNodes/classes/CollaboratorInfoCardContent.md) - [`CollageHeroImage`](../../YTNodes/classes/CollageHeroImage.md) - [`CollectionThumbnailView`](../../YTNodes/classes/CollectionThumbnailView.md) +- [`AddToPlaylistCommand`](../../YTNodes/classes/AddToPlaylistCommand.md) +- [`CommandExecutorCommand`](../../YTNodes/classes/CommandExecutorCommand.md) +- [`ContinuationCommand`](../../YTNodes/classes/ContinuationCommand.md) +- [`GetKidsBlocklistPickerCommand`](../../YTNodes/classes/GetKidsBlocklistPickerCommand.md) +- [`ShowDialogCommand`](../../YTNodes/classes/ShowDialogCommand.md) - [`AuthorCommentBadge`](../../YTNodes/classes/AuthorCommentBadge.md) - [`Comment`](../../YTNodes/classes/Comment.md) - [`CommentActionButtons`](../../YTNodes/classes/CommentActionButtons.md) @@ -103,21 +112,45 @@ - [`ConversationBar`](../../YTNodes/classes/ConversationBar.md) - [`CopyLink`](../../YTNodes/classes/CopyLink.md) - [`CreatePlaylistDialog`](../../YTNodes/classes/CreatePlaylistDialog.md) +- [`CreatePlaylistDialogFormView`](../../YTNodes/classes/CreatePlaylistDialogFormView.md) - [`DecoratedAvatarView`](../../YTNodes/classes/DecoratedAvatarView.md) - [`DecoratedPlayerBar`](../../YTNodes/classes/DecoratedPlayerBar.md) - [`DefaultPromoPanel`](../../YTNodes/classes/DefaultPromoPanel.md) - [`DescriptionPreviewView`](../../YTNodes/classes/DescriptionPreviewView.md) +- [`DialogHeaderView`](../../YTNodes/classes/DialogHeaderView.md) +- [`DialogView`](../../YTNodes/classes/DialogView.md) - [`DidYouMean`](../../YTNodes/classes/DidYouMean.md) - [`DislikeButtonView`](../../YTNodes/classes/DislikeButtonView.md) - [`DownloadButton`](../../YTNodes/classes/DownloadButton.md) - [`Dropdown`](../../YTNodes/classes/Dropdown.md) - [`DropdownItem`](../../YTNodes/classes/DropdownItem.md) +- [`DropdownView`](../../YTNodes/classes/DropdownView.md) - [`DynamicTextView`](../../YTNodes/classes/DynamicTextView.md) - [`Element`](../../YTNodes/classes/Element.md) - [`EmergencyOnebox`](../../YTNodes/classes/EmergencyOnebox.md) - [`EmojiPickerCategory`](../../YTNodes/classes/EmojiPickerCategory.md) - [`EmojiPickerCategoryButton`](../../YTNodes/classes/EmojiPickerCategoryButton.md) - [`EmojiPickerUpsellCategory`](../../YTNodes/classes/EmojiPickerUpsellCategory.md) +- [`AddToPlaylistServiceEndpoint`](../../YTNodes/classes/AddToPlaylistServiceEndpoint.md) +- [`BrowseEndpoint`](../../YTNodes/classes/BrowseEndpoint.md) +- [`CreateCommentEndpoint`](../../YTNodes/classes/CreateCommentEndpoint.md) +- [`CreatePlaylistServiceEndpoint`](../../YTNodes/classes/CreatePlaylistServiceEndpoint.md) +- [`DeletePlaylistEndpoint`](../../YTNodes/classes/DeletePlaylistEndpoint.md) +- [`FeedbackEndpoint`](../../YTNodes/classes/FeedbackEndpoint.md) +- [`GetAccountsListInnertubeEndpoint`](../../YTNodes/classes/GetAccountsListInnertubeEndpoint.md) +- [`LikeEndpoint`](../../YTNodes/classes/LikeEndpoint.md) +- [`LiveChatItemContextMenuEndpoint`](../../YTNodes/classes/LiveChatItemContextMenuEndpoint.md) +- [`ModifyChannelNotificationPreferenceEndpoint`](../../YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md) +- [`PerformCommentActionEndpoint`](../../YTNodes/classes/PerformCommentActionEndpoint.md) +- [`PlaylistEditEndpoint`](../../YTNodes/classes/PlaylistEditEndpoint.md) +- [`ReelWatchEndpoint`](../../YTNodes/classes/ReelWatchEndpoint.md) +- [`SearchEndpoint`](../../YTNodes/classes/SearchEndpoint.md) +- [`ShareEntityServiceEndpoint`](../../YTNodes/classes/ShareEntityServiceEndpoint.md) +- [`SignalServiceEndpoint`](../../YTNodes/classes/SignalServiceEndpoint.md) +- [`SubscribeEndpoint`](../../YTNodes/classes/SubscribeEndpoint.md) +- [`UnsubscribeEndpoint`](../../YTNodes/classes/UnsubscribeEndpoint.md) +- [`WatchEndpoint`](../../YTNodes/classes/WatchEndpoint.md) +- [`WatchNextEndpoint`](../../YTNodes/classes/WatchNextEndpoint.md) - [`Endscreen`](../../YTNodes/classes/Endscreen.md) - [`EndscreenElement`](../../YTNodes/classes/EndscreenElement.md) - [`EndScreenPlaylist`](../../YTNodes/classes/EndScreenPlaylist.md) @@ -135,6 +168,7 @@ - [`FeedNudge`](../../YTNodes/classes/FeedNudge.md) - [`FeedTabbedHeader`](../../YTNodes/classes/FeedTabbedHeader.md) - [`FlexibleActionsView`](../../YTNodes/classes/FlexibleActionsView.md) +- [`FormFooterView`](../../YTNodes/classes/FormFooterView.md) - [`GameCard`](../../YTNodes/classes/GameCard.md) - [`GameDetails`](../../YTNodes/classes/GameDetails.md) - [`Grid`](../../YTNodes/classes/Grid.md) @@ -178,14 +212,20 @@ - [`DimChatItemAction`](../../YTNodes/classes/DimChatItemAction.md) - [`LiveChatAutoModMessage`](../../YTNodes/classes/LiveChatAutoModMessage.md) - [`LiveChatBanner`](../../YTNodes/classes/LiveChatBanner.md) +- [`LiveChatBannerChatSummary`](../../YTNodes/classes/LiveChatBannerChatSummary.md) - [`LiveChatBannerHeader`](../../YTNodes/classes/LiveChatBannerHeader.md) - [`LiveChatBannerPoll`](../../YTNodes/classes/LiveChatBannerPoll.md) +- [`LiveChatBannerRedirect`](../../YTNodes/classes/LiveChatBannerRedirect.md) - [`LiveChatMembershipItem`](../../YTNodes/classes/LiveChatMembershipItem.md) +- [`LiveChatModeChangeMessage`](../../YTNodes/classes/LiveChatModeChangeMessage.md) - [`LiveChatPaidMessage`](../../YTNodes/classes/LiveChatPaidMessage.md) - [`LiveChatPaidSticker`](../../YTNodes/classes/LiveChatPaidSticker.md) - [`LiveChatPlaceholderItem`](../../YTNodes/classes/LiveChatPlaceholderItem.md) - [`LiveChatProductItem`](../../YTNodes/classes/LiveChatProductItem.md) - [`LiveChatRestrictedParticipation`](../../YTNodes/classes/LiveChatRestrictedParticipation.md) +- [`LiveChatSponsorshipsGiftPurchaseAnnouncement`](../../YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md) +- [`LiveChatSponsorshipsGiftRedemptionAnnouncement`](../../YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md) +- [`LiveChatSponsorshipsHeader`](../../YTNodes/classes/LiveChatSponsorshipsHeader.md) - [`LiveChatTickerPaidMessageItem`](../../YTNodes/classes/LiveChatTickerPaidMessageItem.md) - [`LiveChatTickerSponsorItem`](../../YTNodes/classes/LiveChatTickerSponsorItem.md) - [`PollHeader`](../../YTNodes/classes/PollHeader.md) @@ -218,6 +258,7 @@ - [`MacroMarkersList`](../../YTNodes/classes/MacroMarkersList.md) - [`MacroMarkersListItem`](../../YTNodes/classes/MacroMarkersListItem.md) - [`Menu`](../../YTNodes/classes/Menu.md) +- [`MenuFlexibleItem`](../../YTNodes/classes/MenuFlexibleItem.md) - [`MenuPopup`](../../YTNodes/classes/MenuPopup.md) - [`MenuServiceItemDownload`](../../YTNodes/classes/MenuServiceItemDownload.md) - [`MultiPageMenu`](../../YTNodes/classes/MultiPageMenu.md) @@ -226,6 +267,7 @@ - [`MusicMultiSelectMenu`](../../YTNodes/classes/MusicMultiSelectMenu.md) - [`MusicMultiSelectMenuItem`](../../YTNodes/classes/MusicMultiSelectMenuItem.md) - [`SimpleMenuHeader`](../../YTNodes/classes/SimpleMenuHeader.md) +- [`MenuTitle`](../../YTNodes/classes/MenuTitle.md) - [`MerchandiseItem`](../../YTNodes/classes/MerchandiseItem.md) - [`MerchandiseShelf`](../../YTNodes/classes/MerchandiseShelf.md) - [`Message`](../../YTNodes/classes/Message.md) @@ -273,9 +315,11 @@ - [`MusicVisualHeader`](../../YTNodes/classes/MusicVisualHeader.md) - [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) - [`Notification`](../../YTNodes/classes/Notification.md) +- [`NotificationAction`](../../YTNodes/classes/NotificationAction.md) - [`PageHeader`](../../YTNodes/classes/PageHeader.md) - [`PageHeaderView`](../../YTNodes/classes/PageHeaderView.md) - [`PageIntroduction`](../../YTNodes/classes/PageIntroduction.md) +- [`PanelFooterView`](../../YTNodes/classes/PanelFooterView.md) - [`PivotButton`](../../YTNodes/classes/PivotButton.md) - [`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md) - [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md) @@ -288,8 +332,10 @@ - [`PlayerOverflow`](../../YTNodes/classes/PlayerOverflow.md) - [`PlayerOverlay`](../../YTNodes/classes/PlayerOverlay.md) - [`PlayerOverlayAutoplay`](../../YTNodes/classes/PlayerOverlayAutoplay.md) +- [`PlayerOverlayVideoDetails`](../../YTNodes/classes/PlayerOverlayVideoDetails.md) - [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) - [`Playlist`](../../YTNodes/classes/Playlist.md) +- [`PlaylistAddToOption`](../../YTNodes/classes/PlaylistAddToOption.md) - [`PlaylistCustomThumbnail`](../../YTNodes/classes/PlaylistCustomThumbnail.md) - [`PlaylistHeader`](../../YTNodes/classes/PlaylistHeader.md) - [`PlaylistInfoCardContent`](../../YTNodes/classes/PlaylistInfoCardContent.md) @@ -305,6 +351,7 @@ - [`PlaylistVideoThumbnail`](../../YTNodes/classes/PlaylistVideoThumbnail.md) - [`Poll`](../../YTNodes/classes/Poll.md) - [`PostMultiImage`](../../YTNodes/classes/PostMultiImage.md) +- [`PremiereTrailerBadge`](../../YTNodes/classes/PremiereTrailerBadge.md) - [`ProductList`](../../YTNodes/classes/ProductList.md) - [`ProductListHeader`](../../YTNodes/classes/ProductListHeader.md) - [`ProductListItem`](../../YTNodes/classes/ProductListItem.md) @@ -345,6 +392,9 @@ - [`SettingsSidebar`](../../YTNodes/classes/SettingsSidebar.md) - [`SettingsSwitch`](../../YTNodes/classes/SettingsSwitch.md) - [`SharedPost`](../../YTNodes/classes/SharedPost.md) +- [`SharePanelHeader`](../../YTNodes/classes/SharePanelHeader.md) +- [`SharePanelTitleV15`](../../YTNodes/classes/SharePanelTitleV15.md) +- [`ShareTarget`](../../YTNodes/classes/ShareTarget.md) - [`Shelf`](../../YTNodes/classes/Shelf.md) - [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) - [`ShowCustomThumbnail`](../../YTNodes/classes/ShowCustomThumbnail.md) @@ -360,6 +410,7 @@ - [`SlimVideoMetadata`](../../YTNodes/classes/SlimVideoMetadata.md) - [`SortFilterHeader`](../../YTNodes/classes/SortFilterHeader.md) - [`SortFilterSubMenu`](../../YTNodes/classes/SortFilterSubMenu.md) +- [`StartAt`](../../YTNodes/classes/StartAt.md) - [`StructuredDescriptionContent`](../../YTNodes/classes/StructuredDescriptionContent.md) - [`StructuredDescriptionPlaylistLockup`](../../YTNodes/classes/StructuredDescriptionPlaylistLockup.md) - [`SubFeedOption`](../../YTNodes/classes/SubFeedOption.md) @@ -369,7 +420,9 @@ - [`Tab`](../../YTNodes/classes/Tab.md) - [`Tabbed`](../../YTNodes/classes/Tabbed.md) - [`TabbedSearchResults`](../../YTNodes/classes/TabbedSearchResults.md) +- [`TextFieldView`](../../YTNodes/classes/TextFieldView.md) - [`TextHeader`](../../YTNodes/classes/TextHeader.md) +- [`ThirdPartyShareTargetSection`](../../YTNodes/classes/ThirdPartyShareTargetSection.md) - [`ThumbnailBadgeView`](../../YTNodes/classes/ThumbnailBadgeView.md) - [`ThumbnailHoverOverlayView`](../../YTNodes/classes/ThumbnailHoverOverlayView.md) - [`ThumbnailLandscapePortrait`](../../YTNodes/classes/ThumbnailLandscapePortrait.md) @@ -404,6 +457,7 @@ - [`TwoColumnBrowseResults`](../../YTNodes/classes/TwoColumnBrowseResults.md) - [`TwoColumnSearchResults`](../../YTNodes/classes/TwoColumnSearchResults.md) - [`TwoColumnWatchNextResults`](../../YTNodes/classes/TwoColumnWatchNextResults.md) +- [`UnifiedSharePanel`](../../YTNodes/classes/UnifiedSharePanel.md) - [`UniversalWatchCard`](../../YTNodes/classes/UniversalWatchCard.md) - [`UploadTimeFactoid`](../../YTNodes/classes/UploadTimeFactoid.md) - [`UpsellDialog`](../../YTNodes/classes/UpsellDialog.md) @@ -421,6 +475,7 @@ - [`VideoOwner`](../../YTNodes/classes/VideoOwner.md) - [`VideoPrimaryInfo`](../../YTNodes/classes/VideoPrimaryInfo.md) - [`VideoSecondaryInfo`](../../YTNodes/classes/VideoSecondaryInfo.md) +- [`VideoViewCount`](../../YTNodes/classes/VideoViewCount.md) - [`ViewCountFactoid`](../../YTNodes/classes/ViewCountFactoid.md) - [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md) - [`WatchCardHeroVideo`](../../YTNodes/classes/WatchCardHeroVideo.md) @@ -459,7 +514,7 @@ #### Defined in -[src/parser/helpers.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L10) +[src/parser/helpers.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L10) ## Properties @@ -469,7 +524,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -479,7 +534,7 @@ #### Defined in -[src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L7) +[src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L7) ## Methods @@ -499,13 +554,21 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -535,7 +598,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -565,7 +628,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -599,4 +662,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/Helpers/functions/observe.md b/docs/api/namespaces/Helpers/functions/observe.md index 63fe624b..59f359fa 100644 --- a/docs/api/namespaces/Helpers/functions/observe.md +++ b/docs/api/namespaces/Helpers/functions/observe.md @@ -4,21 +4,24 @@ > **observe**\<`T`\>(`obj`): [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\> -Creates a trap to intercept property access -and add utilities to an object. +Creates an observed array that provides additional utility methods for array manipulation and filtering. ## Type Parameters • **T** *extends* [`YTNode`](../classes/YTNode.md) +Type extending YTNode + ## Parameters • **obj**: `T`[] +Array to be observed + ## Returns [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\> ## Defined in -[src/parser/helpers.ts:394](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L394) +[src/parser/helpers.ts:433](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L433) diff --git a/docs/api/namespaces/Helpers/interfaces/Constructor.md b/docs/api/namespaces/Helpers/interfaces/Constructor.md index 41b15759..dc5b16c9 100644 --- a/docs/api/namespaces/Helpers/interfaces/Constructor.md +++ b/docs/api/namespaces/Helpers/interfaces/Constructor.md @@ -22,4 +22,4 @@ #### Defined in -[src/parser/helpers.ts:312](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L312) +[src/parser/helpers.ts:316](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L316) diff --git a/docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md b/docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md index ea8f5017..6050f18d 100644 --- a/docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md +++ b/docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md @@ -22,7 +22,7 @@ #### Defined in -[src/parser/helpers.ts:316](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L316) +[src/parser/helpers.ts:320](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L320) ## Properties @@ -32,4 +32,4 @@ #### Defined in -[src/parser/helpers.ts:317](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L317) +[src/parser/helpers.ts:321](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L321) diff --git a/docs/api/namespaces/Helpers/type-aliases/ObservedArray.md b/docs/api/namespaces/Helpers/type-aliases/ObservedArray.md index 83ed8149..5fe87ef5 100644 --- a/docs/api/namespaces/Helpers/type-aliases/ObservedArray.md +++ b/docs/api/namespaces/Helpers/type-aliases/ObservedArray.md @@ -4,136 +4,188 @@ > **ObservedArray**\<`T`\>: `T`[] & `object` +An extended array type that includes additional utility methods for filtering and manipulating YTNode objects. + ## Type declaration ### first() > **first**: () => `T` -Get the first item. +Returns the first item in the array. #### Returns `T` +The first item in the array + ### get() > **get**: (`rule`, `del_item`?) => `T` \| `undefined` -Returns the first object to match the rule. +Returns the first object that matches the specified rule object. #### Parameters • **rule**: `object` +An object containing properties to match against + • **del\_item?**: `boolean` +Optional flag to remove the matched item from the array + #### Returns `T` \| `undefined` +The first matching object or undefined if no match is found + ### getAll() > **getAll**: (`rule`, `del_items`?) => `T`[] -Returns all objects that match the rule. +Returns all objects that match the specified rule object. #### Parameters • **rule**: `object` +An object containing properties to match against + • **del\_items?**: `boolean` +Optional flag to remove all matched items from the array + #### Returns `T`[] +An array of all matching objects + ### matchCondition() > **matchCondition**: (`condition`) => `T` \| `undefined` -Returns the first object to match the condition. +Returns the first object that satisfies the provided condition function. #### Parameters • **condition** +A predicate function that tests each element + #### Returns `T` \| `undefined` +The first element that satisfies the condition or undefined if none found + ### remove() > **remove**: (`index`) => `T`[] -Removes the item at the given index. +Removes the item at the specified index. #### Parameters • **index**: `number` +The index of the item to remove + #### Returns `T`[] +The modified array after removal + ### as() -This is similar to filter but throws if there's a type mismatch. +Similar to `filter` but with strict type checking. Filters the array to include only items of the specified types. #### Type Parameters • **R** *extends* [`YTNode`](../classes/YTNode.md) +Type extending YTNode + • **K** *extends* [`YTNodeConstructor`](../interfaces/YTNodeConstructor.md)\<`R`\>[] +Array of types (YTNodes) + #### Parameters • ...**types**: `K` +Rest parameter of YTNode constructor types to filter by + #### Returns [`ObservedArray`](ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> +A new ObservedArray containing only items of the specified types + +#### Throws + +If an item is not of the specified type + ### filterType() -Get all items of a specific type. +Filters the array to only include items of the specified YTNode types. #### Type Parameters • **R** *extends* [`YTNode`](../classes/YTNode.md) +Type extending YTNode + • **K** *extends* [`YTNodeConstructor`](../interfaces/YTNodeConstructor.md)\<`R`\>[] +Array of types (YTNodes) + #### Parameters • ...**types**: `K` +Rest parameter of YTNode constructor types to filter by + #### Returns [`ObservedArray`](ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> +A new ObservedArray containing only items of the specified types + ### firstOfType() -Get the first of a specific type. +Returns the first item in the array that matches any of the specified YTNode types. #### Type Parameters • **R** *extends* [`YTNode`](../classes/YTNode.md) +Type extending YTNode + • **K** *extends* [`YTNodeConstructor`](../interfaces/YTNodeConstructor.md)\<`R`\>[] +Array of types (YTNodes) + #### Parameters • ...**types**: `K` +Rest parameter of YTNode constructor types to match against + #### Returns `undefined` \| `InstanceType`\<`K`\[`number`\]\> +The first matching item or undefined if none found + ## Type Parameters • **T** *extends* [`YTNode`](../classes/YTNode.md) = [`YTNode`](../classes/YTNode.md) ## Defined in -[src/parser/helpers.ts:355](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L355) +[src/parser/helpers.ts:362](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L362) diff --git a/docs/api/namespaces/LZW/functions/compress.md b/docs/api/namespaces/LZW/functions/compress.md index 0e618412..e72d84b2 100644 --- a/docs/api/namespaces/LZW/functions/compress.md +++ b/docs/api/namespaces/LZW/functions/compress.md @@ -18,4 +18,4 @@ The data to compress. ## Defined in -[src/utils/LZW.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/LZW.ts#L5) +[src/utils/LZW.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/LZW.ts#L5) diff --git a/docs/api/namespaces/LZW/functions/decompress.md b/docs/api/namespaces/LZW/functions/decompress.md index 41447abc..c5c374d8 100644 --- a/docs/api/namespaces/LZW/functions/decompress.md +++ b/docs/api/namespaces/LZW/functions/decompress.md @@ -18,4 +18,4 @@ The data to be decompressed. ## Defined in -[src/utils/LZW.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/LZW.ts#L40) +[src/utils/LZW.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/LZW.ts#L40) diff --git a/docs/api/namespaces/Log/README.md b/docs/api/namespaces/Log/README.md new file mode 100644 index 00000000..773010df --- /dev/null +++ b/docs/api/namespaces/Log/README.md @@ -0,0 +1,18 @@ +[youtubei.js](../../README.md) / Log + +# Log + +## Index + +### Variables + +- [Level](variables/Level.md) + +### Functions + +- [debug](functions/debug.md) +- [error](functions/error.md) +- [info](functions/info.md) +- [setLevel](functions/setLevel.md) +- [warn](functions/warn.md) +- [warnOnce](functions/warnOnce.md) diff --git a/docs/api/namespaces/Log/functions/debug.md b/docs/api/namespaces/Log/functions/debug.md new file mode 100644 index 00000000..d23ca2fd --- /dev/null +++ b/docs/api/namespaces/Log/functions/debug.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Log.ts#L44) diff --git a/docs/api/namespaces/Log/functions/error.md b/docs/api/namespaces/Log/functions/error.md new file mode 100644 index 00000000..8cf1aeb1 --- /dev/null +++ b/docs/api/namespaces/Log/functions/error.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Log.ts#L42) diff --git a/docs/api/namespaces/Log/functions/info.md b/docs/api/namespaces/Log/functions/info.md new file mode 100644 index 00000000..1730e874 --- /dev/null +++ b/docs/api/namespaces/Log/functions/info.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Log.ts#L43) diff --git a/docs/api/namespaces/Log/functions/setLevel.md b/docs/api/namespaces/Log/functions/setLevel.md new file mode 100644 index 00000000..3ccee1f8 --- /dev/null +++ b/docs/api/namespaces/Log/functions/setLevel.md @@ -0,0 +1,17 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Log.ts#L46) diff --git a/docs/api/namespaces/Log/functions/warn.md b/docs/api/namespaces/Log/functions/warn.md new file mode 100644 index 00000000..267fa1a8 --- /dev/null +++ b/docs/api/namespaces/Log/functions/warn.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Log.ts#L41) diff --git a/docs/api/namespaces/Log/functions/warnOnce.md b/docs/api/namespaces/Log/functions/warnOnce.md new file mode 100644 index 00000000..452822c3 --- /dev/null +++ b/docs/api/namespaces/Log/functions/warnOnce.md @@ -0,0 +1,19 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Log.ts#L33) diff --git a/docs/api/namespaces/Log/variables/Level.md b/docs/api/namespaces/Log/variables/Level.md new file mode 100644 index 00000000..7876768c --- /dev/null +++ b/docs/api/namespaces/Log/variables/Level.md @@ -0,0 +1,31 @@ +[youtubei.js](../../../README.md) / [Log](../README.md) / Level + +# Variable: Level + +> `const` **Level**: `object` + +## Type declaration + +### DEBUG + +> **DEBUG**: `number` = `4` + +### ERROR + +> **ERROR**: `number` = `1` + +### INFO + +> **INFO**: `number` = `3` + +### NONE + +> **NONE**: `number` = `0` + +### WARNING + +> **WARNING**: `number` = `2` + +## Defined in + +[src/utils/Log.ts:3](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Log.ts#L3) diff --git a/docs/api/namespaces/Managers/classes/AccountManager.md b/docs/api/namespaces/Managers/classes/AccountManager.md index c69d0efd..0e86c64e 100644 --- a/docs/api/namespaces/Managers/classes/AccountManager.md +++ b/docs/api/namespaces/Managers/classes/AccountManager.md @@ -18,72 +18,10 @@ #### Defined in -[src/core/managers/AccountManager.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L23) - -## Properties - -### channel - -> **channel**: `object` - -#### editDescription() - -> **editDescription**: (`new_description`) => `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -##### Parameters - -• **new\_description**: `string` - -##### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### editName() - -> **editName**: (`new_name`) => `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -##### Parameters - -• **new\_name**: `string` - -##### Returns - -`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> - -#### getBasicAnalytics() - -> **getBasicAnalytics**: () => `Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\> - -##### Returns - -`Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\> - -#### Defined in - -[src/core/managers/AccountManager.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L17) +[src/core/managers/AccountManager.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/AccountManager.ts#L12) ## Methods -### ~~getAnalytics()~~ - -> **getAnalytics**(): `Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\> - -Retrieves basic channel analytics. - -#### Returns - -`Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\> - -#### Deprecated - -This method is deprecated and will be removed in a future release. - -#### Defined in - -[src/core/managers/AccountManager.ts:113](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L113) - -*** - ### getInfo() > **getInfo**(): `Promise`\<[`AccountInfo`](../../YT/classes/AccountInfo.md)\> @@ -96,7 +34,7 @@ Retrieves channel info. #### Defined in -[src/core/managers/AccountManager.ts:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L70) +[src/core/managers/AccountManager.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/AccountManager.ts#L19) *** @@ -104,7 +42,7 @@ Retrieves channel info. > **getSettings**(): `Promise`\<[`Settings`](../../YT/classes/Settings.md)\> -Opens YouTube settings. +Gets YouTube settings. #### Returns @@ -112,24 +50,4 @@ Opens YouTube settings. #### Defined in -[src/core/managers/AccountManager.ts:100](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L100) - -*** - -### ~~getTimeWatched()~~ - -> **getTimeWatched**(): `Promise`\<[`TimeWatched`](../../YT/classes/TimeWatched.md)\> - -Retrieves time watched statistics. - -#### Returns - -`Promise`\<[`TimeWatched`](../../YT/classes/TimeWatched.md)\> - -#### Deprecated - -This method is deprecated and will be removed in a future release. - -#### Defined in - -[src/core/managers/AccountManager.ts:86](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L86) +[src/core/managers/AccountManager.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/AccountManager.ts#L30) diff --git a/docs/api/namespaces/Managers/classes/InteractionManager.md b/docs/api/namespaces/Managers/classes/InteractionManager.md index 66299c0e..51f76975 100644 --- a/docs/api/namespaces/Managers/classes/InteractionManager.md +++ b/docs/api/namespaces/Managers/classes/InteractionManager.md @@ -18,7 +18,7 @@ #### Defined in -[src/core/managers/InteractionManager.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L16) +[src/core/managers/InteractionManager.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L10) ## Methods @@ -44,7 +44,7 @@ The comment text #### Defined in -[src/core/managers/InteractionManager.ts:122](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L122) +[src/core/managers/InteractionManager.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L119) *** @@ -66,7 +66,7 @@ The video ID #### Defined in -[src/core/managers/InteractionManager.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L43) +[src/core/managers/InteractionManager.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L38) *** @@ -88,7 +88,7 @@ The video ID #### Defined in -[src/core/managers/InteractionManager.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L24) +[src/core/managers/InteractionManager.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L18) *** @@ -110,7 +110,7 @@ The video ID #### Defined in -[src/core/managers/InteractionManager.ts:62](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L62) +[src/core/managers/InteractionManager.ts:58](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L58) *** @@ -137,7 +137,7 @@ The notification type. #### Defined in -[src/core/managers/InteractionManager.ts:181](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L181) +[src/core/managers/InteractionManager.ts:174](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L174) *** @@ -145,7 +145,7 @@ The notification type. > **subscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> -Subscribes to a given channel. +Subscribes to the given channel. #### Parameters @@ -159,7 +159,7 @@ The channel ID #### Defined in -[src/core/managers/InteractionManager.ts:81](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L81) +[src/core/managers/InteractionManager.ts:78](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L78) *** @@ -167,12 +167,14 @@ The channel ID > **translate**(`text`, `target_language`, `args`): `Promise`\<`object`\> -Translates a given text using YouTube's comment translate feature. +Translates a given text using YouTube's comment translation feature. #### Parameters • **text**: `string` +The text to translate + • **target\_language**: `string` an ISO language code @@ -207,7 +209,7 @@ optional arguments #### Defined in -[src/core/managers/InteractionManager.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L154) +[src/core/managers/InteractionManager.ts:151](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L151) *** @@ -215,7 +217,7 @@ optional arguments > **unsubscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\> -Unsubscribes from a given channel. +Unsubscribes from the given channel. #### Parameters @@ -229,4 +231,4 @@ The channel ID #### Defined in -[src/core/managers/InteractionManager.ts:101](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L101) +[src/core/managers/InteractionManager.ts:98](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L98) diff --git a/docs/api/namespaces/Managers/classes/PlaylistManager.md b/docs/api/namespaces/Managers/classes/PlaylistManager.md index ebe1cba6..12468ed3 100644 --- a/docs/api/namespaces/Managers/classes/PlaylistManager.md +++ b/docs/api/namespaces/Managers/classes/PlaylistManager.md @@ -18,7 +18,7 @@ #### Defined in -[src/core/managers/PlaylistManager.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L14) +[src/core/managers/PlaylistManager.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L11) ## Methods @@ -52,7 +52,7 @@ An array of video IDs to add to the playlist. #### Defined in -[src/core/managers/PlaylistManager.ts:73](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L73) +[src/core/managers/PlaylistManager.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L74) *** @@ -94,7 +94,7 @@ An array of video IDs to add to the playlist. #### Defined in -[src/core/managers/PlaylistManager.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L23) +[src/core/managers/PlaylistManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L20) *** @@ -132,7 +132,7 @@ The playlist ID. #### Defined in -[src/core/managers/PlaylistManager.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L48) +[src/core/managers/PlaylistManager.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L47) *** @@ -170,7 +170,7 @@ The video ID to move the moved video before. #### Defined in -[src/core/managers/PlaylistManager.ts:156](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L156) +[src/core/managers/PlaylistManager.ts:154](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L154) *** @@ -208,7 +208,7 @@ Option to remove videos using set video IDs. #### Defined in -[src/core/managers/PlaylistManager.ts:101](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L101) +[src/core/managers/PlaylistManager.ts:104](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L104) *** @@ -242,7 +242,7 @@ The description to use for the playlist. #### Defined in -[src/core/managers/PlaylistManager.ts:239](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L239) +[src/core/managers/PlaylistManager.ts:243](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L243) *** @@ -250,7 +250,7 @@ The description to use for the playlist. > **setName**(`playlist_id`, `name`): `Promise`\<`object`\> -Sets the name (title) for the given playlist. +Sets the name for the given playlist. #### Parameters @@ -276,4 +276,4 @@ The name / title to use for the playlist. #### Defined in -[src/core/managers/PlaylistManager.ts:211](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L211) +[src/core/managers/PlaylistManager.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L216) diff --git a/docs/api/namespaces/Misc/classes/Author.md b/docs/api/namespaces/Misc/classes/Author.md index e49182fc..ce901303 100644 --- a/docs/api/namespaces/Misc/classes/Author.md +++ b/docs/api/namespaces/Misc/classes/Author.md @@ -24,7 +24,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L21) +[src/parser/classes/misc/Author.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L21) ## Properties @@ -34,7 +34,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L15) +[src/parser/classes/misc/Author.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L15) *** @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L14) +[src/parser/classes/misc/Author.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L14) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L11) +[src/parser/classes/misc/Author.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L11) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L16) +[src/parser/classes/misc/Author.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L16) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L17) +[src/parser/classes/misc/Author.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L17) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L18) +[src/parser/classes/misc/Author.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L18) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L12) +[src/parser/classes/misc/Author.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L12) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L13) +[src/parser/classes/misc/Author.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L13) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/misc/Author.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L19) +[src/parser/classes/misc/Author.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Author.ts#L19) ## Accessors @@ -128,4 +128,4 @@ #### Defined in -[src/parser/classes/misc/Author.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Author.ts#L51) +[src/parser/classes/misc/Author.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index 2ee1f3ee..8d19de20 100644 --- a/docs/api/namespaces/Misc/classes/ChildElement.md +++ b/docs/api/namespaces/Misc/classes/ChildElement.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/misc/ChildElement.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/ChildElement.ts#L11) +[src/parser/classes/misc/ChildElement.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/ChildElement.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/misc/ChildElement.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/ChildElement.ts#L9) +[src/parser/classes/misc/ChildElement.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/ChildElement.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/misc/ChildElement.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/ChildElement.ts#L8) +[src/parser/classes/misc/ChildElement.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/ChildElement.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/misc/ChildElement.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/ChildElement.ts#L7) +[src/parser/classes/misc/ChildElement.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/ChildElement.ts#L7) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/misc/ChildElement.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/ChildElement.ts#L5) +[src/parser/classes/misc/ChildElement.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/ChildElement.ts#L5) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/Misc/classes/EmojiRun.md b/docs/api/namespaces/Misc/classes/EmojiRun.md index 10900f2c..1ba57919 100644 --- a/docs/api/namespaces/Misc/classes/EmojiRun.md +++ b/docs/api/namespaces/Misc/classes/EmojiRun.md @@ -22,7 +22,7 @@ #### Defined in -[src/parser/classes/misc/EmojiRun.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/EmojiRun.ts#L15) +[src/parser/classes/misc/EmojiRun.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/EmojiRun.ts#L15) ## Properties @@ -52,7 +52,7 @@ #### Defined in -[src/parser/classes/misc/EmojiRun.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/EmojiRun.ts#L7) +[src/parser/classes/misc/EmojiRun.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/EmojiRun.ts#L7) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/misc/EmojiRun.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/EmojiRun.ts#L6) +[src/parser/classes/misc/EmojiRun.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/EmojiRun.ts#L6) ## Methods @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/misc/EmojiRun.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/EmojiRun.ts#L35) +[src/parser/classes/misc/EmojiRun.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/EmojiRun.ts#L35) *** @@ -102,4 +102,4 @@ #### Defined in -[src/parser/classes/misc/EmojiRun.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/EmojiRun.ts#L31) +[src/parser/classes/misc/EmojiRun.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/EmojiRun.ts#L31) diff --git a/docs/api/namespaces/Misc/classes/Format.md b/docs/api/namespaces/Misc/classes/Format.md index a060f428..8750e80e 100644 --- a/docs/api/namespaces/Misc/classes/Format.md +++ b/docs/api/namespaces/Misc/classes/Format.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:85](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L85) +[src/parser/classes/misc/Format.ts:85](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L85) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:58](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L58) +[src/parser/classes/misc/Format.ts:58](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L58) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:60](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L60) +[src/parser/classes/misc/Format.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L60) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L57) +[src/parser/classes/misc/Format.ts:57](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L57) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:59](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L59) +[src/parser/classes/misc/Format.ts:59](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L59) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:72](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L72) +[src/parser/classes/misc/Format.ts:72](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L72) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L49) +[src/parser/classes/misc/Format.ts:49](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L49) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:50](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L50) +[src/parser/classes/misc/Format.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L50) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:83](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L83) +[src/parser/classes/misc/Format.ts:83](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L83) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:71](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L71) +[src/parser/classes/misc/Format.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L71) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:82](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L82) +[src/parser/classes/misc/Format.ts:82](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L82) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L42) +[src/parser/classes/misc/Format.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L42) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L65) +[src/parser/classes/misc/Format.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L65) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L45) +[src/parser/classes/misc/Format.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L45) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:64](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L64) +[src/parser/classes/misc/Format.ts:64](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L64) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:53](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L53) +[src/parser/classes/misc/Format.ts:53](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L53) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L46) +[src/parser/classes/misc/Format.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L46) *** @@ -190,7 +190,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:73](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L73) +[src/parser/classes/misc/Format.ts:73](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L73) *** @@ -200,7 +200,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:75](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L75) +[src/parser/classes/misc/Format.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L75) *** @@ -210,7 +210,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:74](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L74) +[src/parser/classes/misc/Format.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L74) *** @@ -220,7 +220,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L39) +[src/parser/classes/misc/Format.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L39) *** @@ -230,7 +230,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:56](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L56) +[src/parser/classes/misc/Format.ts:56](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L56) *** @@ -240,7 +240,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L70) +[src/parser/classes/misc/Format.ts:70](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L70) *** @@ -250,7 +250,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:69](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L69) +[src/parser/classes/misc/Format.ts:69](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L69) *** @@ -260,7 +260,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:78](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L78) +[src/parser/classes/misc/Format.ts:78](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L78) *** @@ -270,7 +270,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:79](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L79) +[src/parser/classes/misc/Format.ts:79](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L79) *** @@ -280,7 +280,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L63) +[src/parser/classes/misc/Format.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L63) *** @@ -290,7 +290,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L77) +[src/parser/classes/misc/Format.ts:77](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L77) *** @@ -300,7 +300,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:81](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L81) +[src/parser/classes/misc/Format.ts:81](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L81) *** @@ -310,7 +310,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:80](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L80) +[src/parser/classes/misc/Format.ts:80](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L80) *** @@ -320,7 +320,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:68](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L68) +[src/parser/classes/misc/Format.ts:68](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L68) *** @@ -330,7 +330,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L36) +[src/parser/classes/misc/Format.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L36) *** @@ -340,7 +340,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:76](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L76) +[src/parser/classes/misc/Format.ts:76](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L76) *** @@ -350,7 +350,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L40) +[src/parser/classes/misc/Format.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L40) *** @@ -360,7 +360,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L41) +[src/parser/classes/misc/Format.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L41) *** @@ -370,7 +370,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:61](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L61) +[src/parser/classes/misc/Format.ts:61](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L61) *** @@ -380,7 +380,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L55) +[src/parser/classes/misc/Format.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L55) *** @@ -390,7 +390,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:67](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L67) +[src/parser/classes/misc/Format.ts:67](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L67) *** @@ -400,7 +400,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L48) +[src/parser/classes/misc/Format.ts:48](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L48) *** @@ -410,7 +410,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L43) +[src/parser/classes/misc/Format.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L43) *** @@ -420,7 +420,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L47) +[src/parser/classes/misc/Format.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L47) *** @@ -430,7 +430,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:62](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L62) +[src/parser/classes/misc/Format.ts:62](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L62) *** @@ -440,7 +440,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L51) +[src/parser/classes/misc/Format.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L51) *** @@ -450,7 +450,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L54) +[src/parser/classes/misc/Format.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L54) *** @@ -460,7 +460,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:52](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L52) +[src/parser/classes/misc/Format.ts:52](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L52) *** @@ -470,7 +470,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:66](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L66) +[src/parser/classes/misc/Format.ts:66](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L66) *** @@ -480,7 +480,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L37) +[src/parser/classes/misc/Format.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L37) *** @@ -490,7 +490,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L38) +[src/parser/classes/misc/Format.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L38) *** @@ -500,7 +500,7 @@ #### Defined in -[src/parser/classes/misc/Format.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L44) +[src/parser/classes/misc/Format.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L44) ## Methods @@ -524,4 +524,4 @@ The deciphered URL as a string. If no player is provided, returns the original U #### Defined in -[src/parser/classes/misc/Format.ts:244](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Format.ts#L244) +[src/parser/classes/misc/Format.ts:244](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Format.ts#L244) diff --git a/docs/api/namespaces/Misc/classes/Text.md b/docs/api/namespaces/Misc/classes/Text.md index df4fd17f..a605f431 100644 --- a/docs/api/namespaces/Misc/classes/Text.md +++ b/docs/api/namespaces/Misc/classes/Text.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/classes/misc/Text.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L31) +[src/parser/classes/misc/Text.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L31) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/classes/misc/Text.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L29) +[src/parser/classes/misc/Text.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L29) *** @@ -38,7 +38,7 @@ #### Defined in -[src/parser/classes/misc/Text.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L28) +[src/parser/classes/misc/Text.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L28) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/classes/misc/Text.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L27) +[src/parser/classes/misc/Text.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L27) ## Methods @@ -66,7 +66,7 @@ Whether the text is empty. #### Defined in -[src/parser/classes/misc/Text.ts:197](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L197) +[src/parser/classes/misc/Text.ts:197](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L197) *** @@ -84,7 +84,7 @@ The HTML. #### Defined in -[src/parser/classes/misc/Text.ts:189](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L189) +[src/parser/classes/misc/Text.ts:189](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L189) *** @@ -102,7 +102,7 @@ The text. #### Defined in -[src/parser/classes/misc/Text.ts:205](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L205) +[src/parser/classes/misc/Text.ts:205](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L205) *** @@ -120,4 +120,4 @@ The text. #### Defined in -[src/parser/classes/misc/Text.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Text.ts#L54) +[src/parser/classes/misc/Text.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Text.ts#L54) diff --git a/docs/api/namespaces/Misc/classes/TextRun.md b/docs/api/namespaces/Misc/classes/TextRun.md index c2fecaab..f1d9913c 100644 --- a/docs/api/namespaces/Misc/classes/TextRun.md +++ b/docs/api/namespaces/Misc/classes/TextRun.md @@ -22,7 +22,7 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L13) +[src/parser/classes/misc/TextRun.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L14) ## Properties @@ -32,7 +32,7 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L11) +[src/parser/classes/misc/TextRun.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L12) *** @@ -42,7 +42,17 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L8) +[src/parser/classes/misc/TextRun.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L8) + +*** + +### deemphasize + +> **deemphasize**: `boolean` + +#### Defined in + +[src/parser/classes/misc/TextRun.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L11) *** @@ -52,7 +62,7 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L7) +[src/parser/classes/misc/TextRun.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L7) *** @@ -62,7 +72,7 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L9) +[src/parser/classes/misc/TextRun.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L9) *** @@ -72,7 +82,7 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L10) +[src/parser/classes/misc/TextRun.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L10) *** @@ -86,7 +96,7 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L6) +[src/parser/classes/misc/TextRun.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L6) ## Methods @@ -104,7 +114,7 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L30) +[src/parser/classes/misc/TextRun.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L32) *** @@ -122,4 +132,4 @@ #### Defined in -[src/parser/classes/misc/TextRun.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/TextRun.ts#L26) +[src/parser/classes/misc/TextRun.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/TextRun.ts#L28) diff --git a/docs/api/namespaces/Misc/classes/Thumbnail.md b/docs/api/namespaces/Misc/classes/Thumbnail.md index a9dca06f..b51fba1a 100644 --- a/docs/api/namespaces/Misc/classes/Thumbnail.md +++ b/docs/api/namespaces/Misc/classes/Thumbnail.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/classes/misc/Thumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Thumbnail.ts#L8) +[src/parser/classes/misc/Thumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Thumbnail.ts#L8) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/classes/misc/Thumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Thumbnail.ts#L6) +[src/parser/classes/misc/Thumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Thumbnail.ts#L6) *** @@ -38,7 +38,7 @@ #### Defined in -[src/parser/classes/misc/Thumbnail.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Thumbnail.ts#L4) +[src/parser/classes/misc/Thumbnail.ts:4](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Thumbnail.ts#L4) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/classes/misc/Thumbnail.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Thumbnail.ts#L5) +[src/parser/classes/misc/Thumbnail.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/Thumbnail.ts#L5) ## Methods @@ -68,4 +68,4 @@ Get thumbnails from response object. #### Defined in -[src/parser/classes/misc/Thumbnail.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/Thumbnail.ts#L17) +[src/parser/classes/misc/Thumbnail.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index d112290d..fa77d130 100644 --- a/docs/api/namespaces/Misc/classes/VideoDetails.md +++ b/docs/api/namespaces/Misc/classes/VideoDetails.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L26) +[src/parser/classes/misc/VideoDetails.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L26) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L13) +[src/parser/classes/misc/VideoDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L13) *** @@ -38,7 +38,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L15) +[src/parser/classes/misc/VideoDetails.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L15) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L6) +[src/parser/classes/misc/VideoDetails.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L6) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L8) +[src/parser/classes/misc/VideoDetails.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L8) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L5) +[src/parser/classes/misc/VideoDetails.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L5) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L21) +[src/parser/classes/misc/VideoDetails.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L21) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L17) +[src/parser/classes/misc/VideoDetails.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L17) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L18) +[src/parser/classes/misc/VideoDetails.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L18) *** @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L19) +[src/parser/classes/misc/VideoDetails.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L19) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L23) +[src/parser/classes/misc/VideoDetails.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L23) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L10) +[src/parser/classes/misc/VideoDetails.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L10) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L22) +[src/parser/classes/misc/VideoDetails.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L22) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L16) +[src/parser/classes/misc/VideoDetails.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L16) *** @@ -158,7 +158,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L20) +[src/parser/classes/misc/VideoDetails.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L20) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L9) +[src/parser/classes/misc/VideoDetails.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L9) *** @@ -178,7 +178,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L24) +[src/parser/classes/misc/VideoDetails.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L24) *** @@ -188,7 +188,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L11) +[src/parser/classes/misc/VideoDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L11) *** @@ -198,7 +198,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L12) +[src/parser/classes/misc/VideoDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L12) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L7) +[src/parser/classes/misc/VideoDetails.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/misc/VideoDetails.ts#L7) *** @@ -218,4 +218,4 @@ #### Defined in -[src/parser/classes/misc/VideoDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/misc/VideoDetails.ts#L14) +[src/parser/classes/misc/VideoDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index 79db9c02..39425278 100644 --- a/docs/api/namespaces/Mixins/classes/Feed.md +++ b/docs/api/namespaces/Mixins/classes/Feed.md @@ -29,7 +29,7 @@ • **actions**: [`Actions`](../../../classes/Actions.md) -• **response**: [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) \| [`ApiResponse`](../../../interfaces/ApiResponse.md) +• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) • **already\_parsed**: `boolean` = `false` @@ -39,7 +39,7 @@ #### Defined in -[src/core/mixins/Feed.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L46) +[src/core/mixins/Feed.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L44) ## Accessors @@ -53,7 +53,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -69,7 +69,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -85,7 +85,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -99,7 +99,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -115,23 +115,23 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -147,23 +147,23 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`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:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -179,7 +179,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -195,7 +195,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -211,7 +211,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -227,7 +227,7 @@ Retrieves next batch of contents and returns a new [Feed](Feed.md) object. #### Defined in -[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L220) +[src/core/mixins/Feed.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L216) *** @@ -243,7 +243,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -263,7 +263,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -283,7 +283,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -303,4 +303,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/Mixins/classes/FilterableFeed.md b/docs/api/namespaces/Mixins/classes/FilterableFeed.md index 7f72d586..7df254d5 100644 --- a/docs/api/namespaces/Mixins/classes/FilterableFeed.md +++ b/docs/api/namespaces/Mixins/classes/FilterableFeed.md @@ -40,7 +40,7 @@ #### Defined in -[src/core/mixins/FilterableFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L13) +[src/core/mixins/FilterableFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L13) ## Accessors @@ -58,7 +58,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -78,7 +78,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -94,7 +94,7 @@ Returns the filter chips. #### Defined in -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L20) +[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L20) *** @@ -110,7 +110,7 @@ Returns available filters. #### Defined in -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L38) +[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L38) *** @@ -130,7 +130,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -148,7 +148,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -168,19 +168,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -188,7 +188,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -208,19 +208,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -228,7 +228,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -248,7 +248,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -268,7 +268,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -288,7 +288,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -308,7 +308,7 @@ Retrieves next batch of contents and returns a new [Feed](Feed.md) object. #### Defined in -[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L220) +[src/core/mixins/Feed.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L216) *** @@ -328,7 +328,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -348,7 +348,7 @@ Applies given filter and returns a new [Feed](Feed.md) object. #### Defined in -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L45) +[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L45) *** @@ -372,7 +372,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -396,7 +396,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -420,4 +420,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/Mixins/classes/MediaInfo.md b/docs/api/namespaces/Mixins/classes/MediaInfo.md index b13bde69..2fcfe436 100644 --- a/docs/api/namespaces/Mixins/classes/MediaInfo.md +++ b/docs/api/namespaces/Mixins/classes/MediaInfo.md @@ -29,7 +29,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L40) +[src/core/mixins/MediaInfo.ts:48](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L48) ## Properties @@ -39,7 +39,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L31) +[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L39) *** @@ -181,7 +181,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L30) +[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L38) *** @@ -191,7 +191,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L34) +[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L42) *** @@ -201,7 +201,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L35) +[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L43) *** @@ -211,7 +211,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L33) +[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L41) *** @@ -221,7 +221,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L37) +[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L45) *** @@ -231,17 +231,17 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L38) +[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L46) *** ### storyboards? -> `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) +> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) #### Defined in -[src/core/mixins/MediaInfo.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L32) +[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L40) *** @@ -251,7 +251,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L36) +[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L44) ## Accessors @@ -259,15 +259,13 @@ > `get` **actions**(): [`Actions`](../../../classes/Actions.md) -Actions instance. - #### Returns [`Actions`](../../../classes/Actions.md) #### Defined in -[src/core/mixins/MediaInfo.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L223) +[src/core/mixins/MediaInfo.ts:226](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L226) *** @@ -283,7 +281,7 @@ Content Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L230) +[src/core/mixins/MediaInfo.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L233) *** @@ -291,7 +289,7 @@ Content Playback Nonce. > `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] -Original parsed InnerTube response. +Parsed InnerTube response. #### Returns @@ -299,7 +297,7 @@ Original parsed InnerTube response. #### Defined in -[src/core/mixins/MediaInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L237) +[src/core/mixins/MediaInfo.ts:240](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L240) ## Methods @@ -323,7 +321,7 @@ Adds video to the watch history. #### Defined in -[src/core/mixins/MediaInfo.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L199) +[src/core/mixins/MediaInfo.ts:207](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L207) *** @@ -345,7 +343,7 @@ Options #### Defined in -[src/core/mixins/MediaInfo.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L149) +[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L157) *** @@ -367,7 +365,7 @@ Download options. #### Defined in -[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L157) +[src/core/mixins/MediaInfo.ts:165](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L165) *** @@ -389,7 +387,7 @@ Get a cleaned up representation of the adaptive_formats #### Defined in -[src/core/mixins/MediaInfo.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L132) +[src/core/mixins/MediaInfo.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L140) *** @@ -405,7 +403,7 @@ Retrieves the video's transcript. #### Defined in -[src/core/mixins/MediaInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L170) +[src/core/mixins/MediaInfo.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L178) *** @@ -437,4 +435,4 @@ DASH manifest #### Defined in -[src/core/mixins/MediaInfo.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L97) +[src/core/mixins/MediaInfo.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L105) diff --git a/docs/api/namespaces/Mixins/classes/TabbedFeed.md b/docs/api/namespaces/Mixins/classes/TabbedFeed.md index 0c76a02b..7608d2ea 100644 --- a/docs/api/namespaces/Mixins/classes/TabbedFeed.md +++ b/docs/api/namespaces/Mixins/classes/TabbedFeed.md @@ -24,7 +24,7 @@ • **actions**: [`Actions`](../../../classes/Actions.md) -• **data**: [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) \| [`ApiResponse`](../../../interfaces/ApiResponse.md) +• **data**: [`ApiResponse`](../../../interfaces/ApiResponse.md) \| [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) • **already\_parsed**: `boolean` = `false` @@ -38,7 +38,7 @@ #### Defined in -[src/core/mixins/TabbedFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L13) +[src/core/mixins/TabbedFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L13) ## Accessors @@ -56,7 +56,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -76,7 +76,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -96,7 +96,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -114,7 +114,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -134,19 +134,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -154,7 +154,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -174,19 +174,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -194,7 +194,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -214,7 +214,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -234,7 +234,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -248,7 +248,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/TabbedFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L19) +[src/core/mixins/TabbedFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L19) *** @@ -262,7 +262,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/TabbedFeed.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L55) +[src/core/mixins/TabbedFeed.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L55) *** @@ -282,7 +282,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -302,7 +302,7 @@ Retrieves next batch of contents and returns a new [Feed](Feed.md) object. #### Defined in -[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L220) +[src/core/mixins/Feed.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L216) *** @@ -322,7 +322,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -346,7 +346,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -364,7 +364,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/TabbedFeed.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L23) +[src/core/mixins/TabbedFeed.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L23) *** @@ -382,7 +382,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/TabbedFeed.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L37) +[src/core/mixins/TabbedFeed.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L37) *** @@ -400,7 +400,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/TabbedFeed.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L51) +[src/core/mixins/TabbedFeed.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L51) *** @@ -424,7 +424,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -448,4 +448,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/Parser/README.md b/docs/api/namespaces/Parser/README.md index be6d31cf..41dcda2b 100644 --- a/docs/api/namespaces/Parser/README.md +++ b/docs/api/namespaces/Parser/README.md @@ -21,6 +21,8 @@ - [parseActions](functions/parseActions.md) - [parseArray](functions/parseArray.md) - [parseC](functions/parseC.md) +- [parseCommand](functions/parseCommand.md) +- [parseCommands](functions/parseCommands.md) - [parseFormats](functions/parseFormats.md) - [parseItem](functions/parseItem.md) - [parseLC](functions/parseLC.md) diff --git a/docs/api/namespaces/Parser/functions/addRuntimeParser.md b/docs/api/namespaces/Parser/functions/addRuntimeParser.md index 8d329d7f..517acd99 100644 --- a/docs/api/namespaces/Parser/functions/addRuntimeParser.md +++ b/docs/api/namespaces/Parser/functions/addRuntimeParser.md @@ -16,4 +16,4 @@ ## Defined in -[src/parser/parser.ts:209](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L209) +[src/parser/parser.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L216) diff --git a/docs/api/namespaces/Parser/functions/applyCommentsMutations.md b/docs/api/namespaces/Parser/functions/applyCommentsMutations.md index 071b8202..3b38f5de 100644 --- a/docs/api/namespaces/Parser/functions/applyCommentsMutations.md +++ b/docs/api/namespaces/Parser/functions/applyCommentsMutations.md @@ -16,4 +16,4 @@ ## Defined in -[src/parser/parser.ts:720](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L720) +[src/parser/parser.ts:780](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L780) diff --git a/docs/api/namespaces/Parser/functions/applyMutations.md b/docs/api/namespaces/Parser/functions/applyMutations.md index 2b486e93..26ec8b85 100644 --- a/docs/api/namespaces/Parser/functions/applyMutations.md +++ b/docs/api/namespaces/Parser/functions/applyMutations.md @@ -16,4 +16,4 @@ ## Defined in -[src/parser/parser.ts:684](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L684) +[src/parser/parser.ts:744](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L744) diff --git a/docs/api/namespaces/Parser/functions/getDynamicParsers.md b/docs/api/namespaces/Parser/functions/getDynamicParsers.md index b468e3e1..2825189d 100644 --- a/docs/api/namespaces/Parser/functions/getDynamicParsers.md +++ b/docs/api/namespaces/Parser/functions/getDynamicParsers.md @@ -10,4 +10,4 @@ ## Defined in -[src/parser/parser.ts:214](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L214) +[src/parser/parser.ts:221](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L221) diff --git a/docs/api/namespaces/Parser/functions/getParserByName.md b/docs/api/namespaces/Parser/functions/getParserByName.md index 4dba7cb0..92b172aa 100644 --- a/docs/api/namespaces/Parser/functions/getParserByName.md +++ b/docs/api/namespaces/Parser/functions/getParserByName.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:193](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L193) +[src/parser/parser.ts:200](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L200) diff --git a/docs/api/namespaces/Parser/functions/hasParser.md b/docs/api/namespaces/Parser/functions/hasParser.md index d5c8172d..528828f2 100644 --- a/docs/api/namespaces/Parser/functions/hasParser.md +++ b/docs/api/namespaces/Parser/functions/hasParser.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:205](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L205) +[src/parser/parser.ts:212](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L212) diff --git a/docs/api/namespaces/Parser/functions/parse.md b/docs/api/namespaces/Parser/functions/parse.md index b5f40902..2b1d7ece 100644 --- a/docs/api/namespaces/Parser/functions/parse.md +++ b/docs/api/namespaces/Parser/functions/parse.md @@ -34,7 +34,7 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:604](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L604) +[src/parser/parser.ts:603](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L603) ## parse(data, requireArray, validTypes) @@ -60,7 +60,7 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:605](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L605) +[src/parser/parser.ts:604](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L604) ## parse(data, requireArray, validTypes) @@ -84,4 +84,4 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:606](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L606) +[src/parser/parser.ts:605](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L605) diff --git a/docs/api/namespaces/Parser/functions/parseActions.md b/docs/api/namespaces/Parser/functions/parseActions.md index c59e8577..4ec22124 100644 --- a/docs/api/namespaces/Parser/functions/parseActions.md +++ b/docs/api/namespaces/Parser/functions/parseActions.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:670](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L670) +[src/parser/parser.ts:730](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L730) diff --git a/docs/api/namespaces/Parser/functions/parseArray.md b/docs/api/namespaces/Parser/functions/parseArray.md index 8b922280..190c0c9f 100644 --- a/docs/api/namespaces/Parser/functions/parseArray.md +++ b/docs/api/namespaces/Parser/functions/parseArray.md @@ -30,7 +30,7 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:577](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L577) +[src/parser/parser.ts:576](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L576) ## parseArray(data, validType) @@ -52,7 +52,7 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:578](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L578) +[src/parser/parser.ts:577](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L577) ## parseArray(data) @@ -68,4 +68,4 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:579](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L579) +[src/parser/parser.ts:578](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L578) diff --git a/docs/api/namespaces/Parser/functions/parseC.md b/docs/api/namespaces/Parser/functions/parseC.md index 0554caea..24bde3f6 100644 --- a/docs/api/namespaces/Parser/functions/parseC.md +++ b/docs/api/namespaces/Parser/functions/parseC.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:630](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L630) +[src/parser/parser.ts:690](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L690) diff --git a/docs/api/namespaces/Parser/functions/parseCommand.md b/docs/api/namespaces/Parser/functions/parseCommand.md new file mode 100644 index 00000000..fd67ad51 --- /dev/null +++ b/docs/api/namespaces/Parser/functions/parseCommand.md @@ -0,0 +1,23 @@ +[youtubei.js](../../../README.md) / [Parser](../README.md) / parseCommand + +# Function: parseCommand() + +> **parseCommand**(`data`): [`YTNode`](../../Helpers/classes/YTNode.md) \| `undefined` + +Parses an InnerTube command and returns a YTNode instance if applicable. + +## Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +The raw node data to parse + +## Returns + +[`YTNode`](../../Helpers/classes/YTNode.md) \| `undefined` + +A YTNode instance if parsing is successful, undefined otherwise + +## Defined in + +[src/parser/parser.ts:638](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L638) diff --git a/docs/api/namespaces/Parser/functions/parseCommands.md b/docs/api/namespaces/Parser/functions/parseCommands.md new file mode 100644 index 00000000..cacb0bdc --- /dev/null +++ b/docs/api/namespaces/Parser/functions/parseCommands.md @@ -0,0 +1,23 @@ +[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:674](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L674) diff --git a/docs/api/namespaces/Parser/functions/parseFormats.md b/docs/api/namespaces/Parser/functions/parseFormats.md index e8252880..2fdda93d 100644 --- a/docs/api/namespaces/Parser/functions/parseFormats.md +++ b/docs/api/namespaces/Parser/functions/parseFormats.md @@ -16,4 +16,4 @@ ## Defined in -[src/parser/parser.ts:680](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L680) +[src/parser/parser.ts:740](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L740) diff --git a/docs/api/namespaces/Parser/functions/parseItem.md b/docs/api/namespaces/Parser/functions/parseItem.md index 745fe492..17a0eb3e 100644 --- a/docs/api/namespaces/Parser/functions/parseItem.md +++ b/docs/api/namespaces/Parser/functions/parseItem.md @@ -6,7 +6,7 @@ > **parseItem**\<`T`, `K`\>(`data`, `validTypes`): `InstanceType`\<`K`\[`number`\]\> \| `null` -Parses a single item. +Parses an item. ### Type Parameters @@ -30,7 +30,7 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:511](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L511) +[src/parser/parser.ts:510](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L510) ## parseItem(data, validTypes) @@ -52,7 +52,7 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:512](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L512) +[src/parser/parser.ts:511](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L511) ## parseItem(data) @@ -68,4 +68,4 @@ YTNode types that are allowed to be parsed. ### Defined in -[src/parser/parser.ts:513](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L513) +[src/parser/parser.ts:512](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L512) diff --git a/docs/api/namespaces/Parser/functions/parseLC.md b/docs/api/namespaces/Parser/functions/parseLC.md index fbea1b04..e8198cbe 100644 --- a/docs/api/namespaces/Parser/functions/parseLC.md +++ b/docs/api/namespaces/Parser/functions/parseLC.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:636](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L636) +[src/parser/parser.ts:696](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L696) diff --git a/docs/api/namespaces/Parser/functions/parseRR.md b/docs/api/namespaces/Parser/functions/parseRR.md index 26f5f84d..b770bacf 100644 --- a/docs/api/namespaces/Parser/functions/parseRR.md +++ b/docs/api/namespaces/Parser/functions/parseRR.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:657](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L657) +[src/parser/parser.ts:717](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L717) diff --git a/docs/api/namespaces/Parser/functions/parseResponse.md b/docs/api/namespaces/Parser/functions/parseResponse.md index cc46f846..303ef02a 100644 --- a/docs/api/namespaces/Parser/functions/parseResponse.md +++ b/docs/api/namespaces/Parser/functions/parseResponse.md @@ -4,7 +4,7 @@ > **parseResponse**\<`T`\>(`data`): `T` -Parses given InnerTube response. +Parses a given InnerTube response. ## Type Parameters @@ -22,4 +22,4 @@ Raw data. ## Defined in -[src/parser/parser.ts:222](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L222) +[src/parser/parser.ts:229](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L229) diff --git a/docs/api/namespaces/Parser/functions/sanitizeClassName.md b/docs/api/namespaces/Parser/functions/sanitizeClassName.md index 4c612ac7..038d330c 100644 --- a/docs/api/namespaces/Parser/functions/sanitizeClassName.md +++ b/docs/api/namespaces/Parser/functions/sanitizeClassName.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L187) +[src/parser/parser.ts:194](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L194) diff --git a/docs/api/namespaces/Parser/functions/setParserErrorHandler.md b/docs/api/namespaces/Parser/functions/setParserErrorHandler.md index 6b737a19..9964efe6 100644 --- a/docs/api/namespaces/Parser/functions/setParserErrorHandler.md +++ b/docs/api/namespaces/Parser/functions/setParserErrorHandler.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L154) +[src/parser/parser.ts:161](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L161) diff --git a/docs/api/namespaces/Parser/functions/shouldIgnore.md b/docs/api/namespaces/Parser/functions/shouldIgnore.md index 1085f509..ccb07382 100644 --- a/docs/api/namespaces/Parser/functions/shouldIgnore.md +++ b/docs/api/namespaces/Parser/functions/shouldIgnore.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:183](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L183) +[src/parser/parser.ts:190](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L190) diff --git a/docs/api/namespaces/Parser/type-aliases/ParserError.md b/docs/api/namespaces/Parser/type-aliases/ParserError.md index b663cbb2..db49d820 100644 --- a/docs/api/namespaces/Parser/type-aliases/ParserError.md +++ b/docs/api/namespaces/Parser/type-aliases/ParserError.md @@ -12,4 +12,4 @@ ## Defined in -[src/parser/parser.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L37) +[src/parser/parser.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L44) diff --git a/docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md b/docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md index ac0c9325..946c74b5 100644 --- a/docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md +++ b/docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md @@ -14,4 +14,4 @@ ## Defined in -[src/parser/parser.ts:64](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L64) +[src/parser/parser.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L71) diff --git a/docs/api/namespaces/ProtoUtils/README.md b/docs/api/namespaces/ProtoUtils/README.md index b7ac0cd0..491cae4d 100644 --- a/docs/api/namespaces/ProtoUtils/README.md +++ b/docs/api/namespaces/ProtoUtils/README.md @@ -4,6 +4,10 @@ ## Index +### Type Aliases + +- [CommentActionParamsArgs](type-aliases/CommentActionParamsArgs.md) + ### Functions - [decodeVisitorData](functions/decodeVisitorData.md) diff --git a/docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md b/docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md index 375b7839..4332653a 100644 --- a/docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md +++ b/docs/api/namespaces/ProtoUtils/functions/decodeVisitorData.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/ProtoUtils.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/ProtoUtils.ts#L9) +[src/utils/ProtoUtils.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/ProtoUtils.ts#L16) diff --git a/docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md b/docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md index 997e7fdd..b25596c7 100644 --- a/docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md +++ b/docs/api/namespaces/ProtoUtils/functions/encodeCommentActionParams.md @@ -8,15 +8,7 @@ • **type**: `number` -• **args** = `{}` - -• **args.comment\_id?**: `string` - -• **args.target\_language?**: `string` - -• **args.text?**: `string` - -• **args.video\_id?**: `string` +• **args**: [`CommentActionParamsArgs`](../type-aliases/CommentActionParamsArgs.md) = `{}` ## Returns @@ -24,4 +16,4 @@ ## Defined in -[src/utils/ProtoUtils.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/ProtoUtils.ts#L14) +[src/utils/ProtoUtils.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/ProtoUtils.ts#L20) diff --git a/docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md b/docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md index b6054acc..f7ba271c 100644 --- a/docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md +++ b/docs/api/namespaces/ProtoUtils/functions/encodeNextParams.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/ProtoUtils.ts:50](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/ProtoUtils.ts#L50) +[src/utils/ProtoUtils.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/ProtoUtils.ts#L51) diff --git a/docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md b/docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md index f976aed1..2e0ff47e 100644 --- a/docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md +++ b/docs/api/namespaces/ProtoUtils/functions/encodeVisitorData.md @@ -16,4 +16,4 @@ ## Defined in -[src/utils/ProtoUtils.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/ProtoUtils.ts#L4) +[src/utils/ProtoUtils.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 new file mode 100644 index 00000000..21e97d29 --- /dev/null +++ b/docs/api/namespaces/ProtoUtils/type-aliases/CommentActionParamsArgs.md @@ -0,0 +1,27 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/ProtoUtils.ts#L4) diff --git a/docs/api/namespaces/Types/README.md b/docs/api/namespaces/Types/README.md index 305e9203..22376339 100644 --- a/docs/api/namespaces/Types/README.md +++ b/docs/api/namespaces/Types/README.md @@ -8,75 +8,24 @@ - [DownloadOptions](interfaces/DownloadOptions.md) - [FormatOptions](interfaces/FormatOptions.md) -- [IAccountListRequest](interfaces/IAccountListRequest.md) - [ICache](interfaces/ICache.md) - [ICacheConstructor](interfaces/ICacheConstructor.md) -- [IChannelEditDescriptionRequest](interfaces/IChannelEditDescriptionRequest.md) -- [IChannelEditNameRequest](interfaces/IChannelEditNameRequest.md) -- [IModifyChannelPreferenceRequest](interfaces/IModifyChannelPreferenceRequest.md) -- [IMusicGetSearchSuggestionsRequest](interfaces/IMusicGetSearchSuggestionsRequest.md) -- [IPerformCommentActionRequest](interfaces/IPerformCommentActionRequest.md) -- [IPlayerRequest](interfaces/IPlayerRequest.md) -- [IReelItemWatchRequest](interfaces/IReelItemWatchRequest.md) -- [IReelWatchSequenceRequest](interfaces/IReelWatchSequenceRequest.md) -- [IResolveURLRequest](interfaces/IResolveURLRequest.md) -- [ISearchRequest](interfaces/ISearchRequest.md) - [PlatformShim](interfaces/PlatformShim.md) ### Type Aliases -- [BlocklistPickerRequestEndpointOptions](type-aliases/BlocklistPickerRequestEndpointOptions.md) -- [BrowseEndpointOptions](type-aliases/BrowseEndpointOptions.md) -- [ChannelEditDescriptionEndpointOptions](type-aliases/ChannelEditDescriptionEndpointOptions.md) -- [ChannelEditNameEndpointOptions](type-aliases/ChannelEditNameEndpointOptions.md) -- [CreateCommentEndpointOptions](type-aliases/CreateCommentEndpointOptions.md) -- [CreatePlaylistEndpointOptions](type-aliases/CreatePlaylistEndpointOptions.md) -- [CreateVideoEndpointOptions](type-aliases/CreateVideoEndpointOptions.md) -- [DeletePlaylistEndpointOptions](type-aliases/DeletePlaylistEndpointOptions.md) -- [DislikeEndpointOptions](type-aliases/DislikeEndpointOptions.md) - [Duration](type-aliases/Duration.md) -- [EditPlaylistEndpointOptions](type-aliases/EditPlaylistEndpointOptions.md) - [Feature](type-aliases/Feature.md) - [FetchFunction](type-aliases/FetchFunction.md) - [FormatFilter](type-aliases/FormatFilter.md) -- [GetNotificationMenuEndpointOptions](type-aliases/GetNotificationMenuEndpointOptions.md) -- [IBlocklistPickerRequest](type-aliases/IBlocklistPickerRequest.md) -- [IBrowseRequest](type-aliases/IBrowseRequest.md) -- [ICreateCommentRequest](type-aliases/ICreateCommentRequest.md) -- [ICreatePlaylistRequest](type-aliases/ICreatePlaylistRequest.md) -- [ICreateVideoRequest](type-aliases/ICreateVideoRequest.md) -- [IDeletePlaylistRequest](type-aliases/IDeletePlaylistRequest.md) -- [IDislikeRequest](type-aliases/IDislikeRequest.md) -- [IEditPlaylistRequest](type-aliases/IEditPlaylistRequest.md) -- [IGetNotificationMenuRequest](type-aliases/IGetNotificationMenuRequest.md) -- [ILikeRequest](type-aliases/ILikeRequest.md) -- [INextRequest](type-aliases/INextRequest.md) - [InnerTubeClient](type-aliases/InnerTubeClient.md) - [InnerTubeConfig](type-aliases/InnerTubeConfig.md) -- [IRemoveLikeRequest](type-aliases/IRemoveLikeRequest.md) -- [ISubscribeRequest](type-aliases/ISubscribeRequest.md) -- [IUnsubscribeRequest](type-aliases/IUnsubscribeRequest.md) -- [LikeEndpointOptions](type-aliases/LikeEndpointOptions.md) -- [ModifyChannelPreferenceEndpointOptions](type-aliases/ModifyChannelPreferenceEndpointOptions.md) -- [MusicGetSearchSuggestionsEndpointOptions](type-aliases/MusicGetSearchSuggestionsEndpointOptions.md) - [MusicSearchFilters](type-aliases/MusicSearchFilters.md) - [MusicSearchType](type-aliases/MusicSearchType.md) -- [NextEndpointOptions](type-aliases/NextEndpointOptions.md) -- [ObjectSnakeToCamel](type-aliases/ObjectSnakeToCamel.md) -- [PerformCommentActionEndpointOptions](type-aliases/PerformCommentActionEndpointOptions.md) -- [PlayerEndpointOptions](type-aliases/PlayerEndpointOptions.md) -- [ReelItemWatchEndpointOptions](type-aliases/ReelItemWatchEndpointOptions.md) -- [ReelWatchSequenceEndpointOptions](type-aliases/ReelWatchSequenceEndpointOptions.md) -- [RemoveLikeEndpointOptions](type-aliases/RemoveLikeEndpointOptions.md) -- [ResolveURLEndpointOptions](type-aliases/ResolveURLEndpointOptions.md) - [Runtime](type-aliases/Runtime.md) -- [SearchEndpointOptions](type-aliases/SearchEndpointOptions.md) - [SearchFilters](type-aliases/SearchFilters.md) - [SearchType](type-aliases/SearchType.md) -- [SnakeToCamel](type-aliases/SnakeToCamel.md) - [SortBy](type-aliases/SortBy.md) -- [SubscribeEndpointOptions](type-aliases/SubscribeEndpointOptions.md) -- [UnsubscribeEndpointOptions](type-aliases/UnsubscribeEndpointOptions.md) - [UpdateVideoMetadataOptions](type-aliases/UpdateVideoMetadataOptions.md) - [UploadDate](type-aliases/UploadDate.md) - [UploadedVideoMetadataOptions](type-aliases/UploadedVideoMetadataOptions.md) diff --git a/docs/api/namespaces/Types/interfaces/DownloadOptions.md b/docs/api/namespaces/Types/interfaces/DownloadOptions.md index ff15f1b9..5493076f 100644 --- a/docs/api/namespaces/Types/interfaces/DownloadOptions.md +++ b/docs/api/namespaces/Types/interfaces/DownloadOptions.md @@ -20,7 +20,7 @@ InnerTube client. #### Defined in -[src/types/FormatUtils.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L27) +[src/types/FormatUtils.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L27) *** @@ -36,7 +36,7 @@ File format, use 'any' to download any format #### Defined in -[src/types/FormatUtils.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L23) +[src/types/FormatUtils.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L23) *** @@ -52,7 +52,7 @@ Language code, defaults to 'original'. #### Defined in -[src/types/FormatUtils.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L19) +[src/types/FormatUtils.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L19) *** @@ -68,7 +68,7 @@ Video quality; 360p, 720p, 1080p, etc... also accepts 'best' and 'bestefficiency #### Defined in -[src/types/FormatUtils.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L11) +[src/types/FormatUtils.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L11) *** @@ -88,7 +88,7 @@ Download range, indicates which bytes should be downloaded. #### Defined in -[src/types/FormatUtils.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L34) +[src/types/FormatUtils.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L34) *** @@ -104,4 +104,4 @@ Download type, can be: video, audio or video+audio #### Defined in -[src/types/FormatUtils.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L15) +[src/types/FormatUtils.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L15) diff --git a/docs/api/namespaces/Types/interfaces/FormatOptions.md b/docs/api/namespaces/Types/interfaces/FormatOptions.md index 312e8dff..d864d92d 100644 --- a/docs/api/namespaces/Types/interfaces/FormatOptions.md +++ b/docs/api/namespaces/Types/interfaces/FormatOptions.md @@ -16,7 +16,7 @@ InnerTube client. #### Defined in -[src/types/FormatUtils.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L27) +[src/types/FormatUtils.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L27) *** @@ -28,7 +28,7 @@ File format, use 'any' to download any format #### Defined in -[src/types/FormatUtils.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L23) +[src/types/FormatUtils.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L23) *** @@ -40,7 +40,7 @@ Language code, defaults to 'original'. #### Defined in -[src/types/FormatUtils.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L19) +[src/types/FormatUtils.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L19) *** @@ -52,7 +52,7 @@ Video quality; 360p, 720p, 1080p, etc... also accepts 'best' and 'bestefficiency #### Defined in -[src/types/FormatUtils.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L11) +[src/types/FormatUtils.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L11) *** @@ -64,4 +64,4 @@ Download type, can be: video, audio or video+audio #### Defined in -[src/types/FormatUtils.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L15) +[src/types/FormatUtils.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L15) diff --git a/docs/api/namespaces/Types/interfaces/IAccountListRequest.md b/docs/api/namespaces/Types/interfaces/IAccountListRequest.md deleted file mode 100644 index 371d8c87..00000000 --- a/docs/api/namespaces/Types/interfaces/IAccountListRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IAccountListRequest - -# Interface: IAccountListRequest - -## Properties - -### callCircumstance - -> **callCircumstance**: `number` - -#### Defined in - -[src/types/Endpoints.ts:188](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L188) - -*** - -### client - -> **client**: `"TV"` - -#### Defined in - -[src/types/Endpoints.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L187) diff --git a/docs/api/namespaces/Types/interfaces/ICache.md b/docs/api/namespaces/Types/interfaces/ICache.md index bed55505..8616867c 100644 --- a/docs/api/namespaces/Types/interfaces/ICache.md +++ b/docs/api/namespaces/Types/interfaces/ICache.md @@ -10,7 +10,7 @@ #### Defined in -[src/types/Cache.ts:2](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Cache.ts#L2) +[src/types/Cache.ts:2](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Cache.ts#L2) ## Methods @@ -28,7 +28,7 @@ #### Defined in -[src/types/Cache.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Cache.ts#L3) +[src/types/Cache.ts:3](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Cache.ts#L3) *** @@ -46,7 +46,7 @@ #### Defined in -[src/types/Cache.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Cache.ts#L5) +[src/types/Cache.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Cache.ts#L5) *** @@ -66,4 +66,4 @@ #### Defined in -[src/types/Cache.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Cache.ts#L4) +[src/types/Cache.ts:4](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Cache.ts#L4) diff --git a/docs/api/namespaces/Types/interfaces/ICacheConstructor.md b/docs/api/namespaces/Types/interfaces/ICacheConstructor.md index 6c9bbcdb..30ed3a00 100644 --- a/docs/api/namespaces/Types/interfaces/ICacheConstructor.md +++ b/docs/api/namespaces/Types/interfaces/ICacheConstructor.md @@ -20,4 +20,4 @@ #### Defined in -[src/types/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Cache.ts#L9) +[src/types/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Cache.ts#L9) diff --git a/docs/api/namespaces/Types/interfaces/IChannelEditDescriptionRequest.md b/docs/api/namespaces/Types/interfaces/IChannelEditDescriptionRequest.md deleted file mode 100644 index 2b790c70..00000000 --- a/docs/api/namespaces/Types/interfaces/IChannelEditDescriptionRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IChannelEditDescriptionRequest - -# Interface: IChannelEditDescriptionRequest - -## Extends - -- [`ObjectSnakeToCamel`](../type-aliases/ObjectSnakeToCamel.md)\<[`ChannelEditDescriptionEndpointOptions`](../type-aliases/ChannelEditDescriptionEndpointOptions.md)\> - -## Properties - -### client - -> **client**: `"ANDROID"` - -#### Defined in - -[src/types/Endpoints.ts:183](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L183) - -*** - -### givenDescription - -> **givenDescription**: `string` - -#### Inherited from - -`ObjectSnakeToCamel.givenDescription` diff --git a/docs/api/namespaces/Types/interfaces/IChannelEditNameRequest.md b/docs/api/namespaces/Types/interfaces/IChannelEditNameRequest.md deleted file mode 100644 index 83612398..00000000 --- a/docs/api/namespaces/Types/interfaces/IChannelEditNameRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IChannelEditNameRequest - -# Interface: IChannelEditNameRequest - -## Extends - -- [`ObjectSnakeToCamel`](../type-aliases/ObjectSnakeToCamel.md)\<[`ChannelEditNameEndpointOptions`](../type-aliases/ChannelEditNameEndpointOptions.md)\> - -## Properties - -### client - -> **client**: `"ANDROID"` - -#### Defined in - -[src/types/Endpoints.ts:172](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L172) - -*** - -### givenName - -> **givenName**: `string` - -#### Inherited from - -`ObjectSnakeToCamel.givenName` diff --git a/docs/api/namespaces/Types/interfaces/IModifyChannelPreferenceRequest.md b/docs/api/namespaces/Types/interfaces/IModifyChannelPreferenceRequest.md deleted file mode 100644 index dc934ebe..00000000 --- a/docs/api/namespaces/Types/interfaces/IModifyChannelPreferenceRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IModifyChannelPreferenceRequest - -# Interface: IModifyChannelPreferenceRequest - -## Properties - -### client? - -> `optional` **client**: [`InnerTubeClient`](../type-aliases/InnerTubeClient.md) - -The client to use. - -#### Defined in - -[src/types/Endpoints.ts:270](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L270) - -*** - -### params - -> **params**: `string` - -Protobuf-encoded parameters. - -#### Defined in - -[src/types/Endpoints.ts:266](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L266) diff --git a/docs/api/namespaces/Types/interfaces/IMusicGetSearchSuggestionsRequest.md b/docs/api/namespaces/Types/interfaces/IMusicGetSearchSuggestionsRequest.md deleted file mode 100644 index 9a53cfcc..00000000 --- a/docs/api/namespaces/Types/interfaces/IMusicGetSearchSuggestionsRequest.md +++ /dev/null @@ -1,33 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IMusicGetSearchSuggestionsRequest - -# Interface: IMusicGetSearchSuggestionsRequest - -## Extends - -- [`MusicGetSearchSuggestionsEndpointOptions`](../type-aliases/MusicGetSearchSuggestionsEndpointOptions.md) - -## Properties - -### client - -> **client**: `"YTMUSIC"` - -#### Defined in - -[src/types/Endpoints.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L161) - -*** - -### input - -> **input**: `string` - -The query to search for. - -#### Inherited from - -`MusicGetSearchSuggestionsEndpointOptions.input` - -#### Defined in - -[src/types/Endpoints.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L157) diff --git a/docs/api/namespaces/Types/interfaces/IPerformCommentActionRequest.md b/docs/api/namespaces/Types/interfaces/IPerformCommentActionRequest.md deleted file mode 100644 index 7bff5fcf..00000000 --- a/docs/api/namespaces/Types/interfaces/IPerformCommentActionRequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IPerformCommentActionRequest - -# Interface: IPerformCommentActionRequest - -## Properties - -### actions - -> **actions**: `string`[] - -An array of protobuf-encoded actions. - -#### Defined in - -[src/types/Endpoints.ts:236](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L236) - -*** - -### client? - -> `optional` **client**: [`InnerTubeClient`](../type-aliases/InnerTubeClient.md) - -The client to use. - -#### Defined in - -[src/types/Endpoints.ts:240](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L240) diff --git a/docs/api/namespaces/Types/interfaces/IPlayerRequest.md b/docs/api/namespaces/Types/interfaces/IPlayerRequest.md deleted file mode 100644 index c23022e1..00000000 --- a/docs/api/namespaces/Types/interfaces/IPlayerRequest.md +++ /dev/null @@ -1,141 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IPlayerRequest - -# Interface: IPlayerRequest - -## Properties - -### attestationRequest - -> **attestationRequest**: `object` - -#### omitBotguardData - -> **omitBotguardData**: `boolean` - -#### Defined in - -[src/types/Endpoints.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L23) - -*** - -### client? - -> `optional` **client**: [`InnerTubeClient`](../type-aliases/InnerTubeClient.md) - -#### Defined in - -[src/types/Endpoints.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L31) - -*** - -### contentCheckOk - -> **contentCheckOk**: `boolean` - -#### Defined in - -[src/types/Endpoints.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L28) - -*** - -### params? - -> `optional` **params**: `string` - -#### Defined in - -[src/types/Endpoints.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L30) - -*** - -### playbackContext - -> **playbackContext**: `object` - -#### contentPlaybackContext - -> **contentPlaybackContext**: `object` - -#### contentPlaybackContext.autoCaptionsDefaultOn - -> **autoCaptionsDefaultOn**: `boolean` - -#### contentPlaybackContext.autonavState - -> **autonavState**: `string` - -#### contentPlaybackContext.currentUrl - -> **currentUrl**: `string` - -#### contentPlaybackContext.html5Preference - -> **html5Preference**: `string` - -#### contentPlaybackContext.lactMilliseconds - -> **lactMilliseconds**: `string` - -#### contentPlaybackContext.referer - -> **referer**: `string` - -#### contentPlaybackContext.signatureTimestamp? - -> `optional` **signatureTimestamp**: `number` - -#### contentPlaybackContext.splay - -> **splay**: `boolean` - -#### contentPlaybackContext.vis - -> **vis**: `number` - -#### Defined in - -[src/types/Endpoints.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L10) - -*** - -### playlistId? - -> `optional` **playlistId**: `string` - -#### Defined in - -[src/types/Endpoints.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L29) - -*** - -### racyCheckOk - -> **racyCheckOk**: `boolean` - -#### Defined in - -[src/types/Endpoints.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L27) - -*** - -### serviceIntegrityDimensions? - -> `optional` **serviceIntegrityDimensions**: `object` - -#### poToken - -> **poToken**: `string` - -#### Defined in - -[src/types/Endpoints.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L32) - -*** - -### videoId - -> **videoId**: `string` - -#### Defined in - -[src/types/Endpoints.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L26) diff --git a/docs/api/namespaces/Types/interfaces/IReelItemWatchRequest.md b/docs/api/namespaces/Types/interfaces/IReelItemWatchRequest.md deleted file mode 100644 index 6f3e790e..00000000 --- a/docs/api/namespaces/Types/interfaces/IReelItemWatchRequest.md +++ /dev/null @@ -1,51 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IReelItemWatchRequest - -# Interface: IReelItemWatchRequest - -## Properties - -### client? - -> `optional` **client**: [`InnerTubeClient`](../type-aliases/InnerTubeClient.md) - -#### Defined in - -[src/types/Endpoints.ts:373](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L373) - -*** - -### disablePlayerResponse - -> **disablePlayerResponse**: `boolean` - -#### Defined in - -[src/types/Endpoints.ts:367](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L367) - -*** - -### params? - -> `optional` **params**: `string` - -#### Defined in - -[src/types/Endpoints.ts:372](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L372) - -*** - -### playerRequest - -> **playerRequest**: `object` - -#### params - -> **params**: `string` - -#### videoId - -> **videoId**: `string` - -#### Defined in - -[src/types/Endpoints.ts:368](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L368) diff --git a/docs/api/namespaces/Types/interfaces/IReelWatchSequenceRequest.md b/docs/api/namespaces/Types/interfaces/IReelWatchSequenceRequest.md deleted file mode 100644 index 046d1331..00000000 --- a/docs/api/namespaces/Types/interfaces/IReelWatchSequenceRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IReelWatchSequenceRequest - -# Interface: IReelWatchSequenceRequest - -## Properties - -### sequenceParams - -> **sequenceParams**: `string` - -#### Defined in - -[src/types/Endpoints.ts:392](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L392) diff --git a/docs/api/namespaces/Types/interfaces/IResolveURLRequest.md b/docs/api/namespaces/Types/interfaces/IResolveURLRequest.md deleted file mode 100644 index d0465e02..00000000 --- a/docs/api/namespaces/Types/interfaces/IResolveURLRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IResolveURLRequest - -# Interface: IResolveURLRequest - -## Properties - -### url - -> **url**: `string` - -The URL to resolve. - -#### Defined in - -[src/types/Endpoints.ts:139](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L139) diff --git a/docs/api/namespaces/Types/interfaces/ISearchRequest.md b/docs/api/namespaces/Types/interfaces/ISearchRequest.md deleted file mode 100644 index 571d3a3b..00000000 --- a/docs/api/namespaces/Types/interfaces/ISearchRequest.md +++ /dev/null @@ -1,51 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ISearchRequest - -# Interface: ISearchRequest - -## Properties - -### client? - -> `optional` **client**: [`InnerTubeClient`](../type-aliases/InnerTubeClient.md) - -The client to use. - -#### Defined in - -[src/types/Endpoints.ts:130](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L130) - -*** - -### continuation? - -> `optional` **continuation**: `string` - -The continuation token. Mostly sed for pagination. - -#### Defined in - -[src/types/Endpoints.ts:126](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L126) - -*** - -### params? - -> `optional` **params**: `string` - -Additional protobuf parameters. - -#### Defined in - -[src/types/Endpoints.ts:122](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L122) - -*** - -### query? - -> `optional` **query**: `string` - -The query to search for. - -#### Defined in - -[src/types/Endpoints.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L118) diff --git a/docs/api/namespaces/Types/interfaces/PlatformShim.md b/docs/api/namespaces/Types/interfaces/PlatformShim.md index ca8247ac..0c83f4c0 100644 --- a/docs/api/namespaces/Types/interfaces/PlatformShim.md +++ b/docs/api/namespaces/Types/interfaces/PlatformShim.md @@ -10,7 +10,7 @@ #### Defined in -[src/types/PlatformShim.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L17) +[src/types/PlatformShim.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L17) *** @@ -34,7 +34,7 @@ #### Defined in -[src/types/PlatformShim.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L28) +[src/types/PlatformShim.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L28) *** @@ -56,7 +56,7 @@ #### Defined in -[src/types/PlatformShim.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L21) +[src/types/PlatformShim.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L21) *** @@ -82,7 +82,7 @@ #### Defined in -[src/types/PlatformShim.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L26) +[src/types/PlatformShim.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L26) *** @@ -106,7 +106,7 @@ #### Defined in -[src/types/PlatformShim.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L25) +[src/types/PlatformShim.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L25) *** @@ -128,7 +128,7 @@ #### Defined in -[src/types/PlatformShim.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L24) +[src/types/PlatformShim.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L24) *** @@ -150,7 +150,7 @@ #### Defined in -[src/types/PlatformShim.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L11) +[src/types/PlatformShim.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L11) *** @@ -196,7 +196,7 @@ #### Defined in -[src/types/PlatformShim.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L27) +[src/types/PlatformShim.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L27) *** @@ -220,7 +220,7 @@ #### Defined in -[src/types/PlatformShim.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L22) +[src/types/PlatformShim.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L22) *** @@ -280,7 +280,7 @@ #### Defined in -[src/types/PlatformShim.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L23) +[src/types/PlatformShim.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L23) *** @@ -290,7 +290,7 @@ #### Defined in -[src/types/PlatformShim.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L10) +[src/types/PlatformShim.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L10) *** @@ -300,7 +300,7 @@ #### Defined in -[src/types/PlatformShim.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L16) +[src/types/PlatformShim.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L16) ## Methods @@ -320,7 +320,7 @@ #### Defined in -[src/types/PlatformShim.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L20) +[src/types/PlatformShim.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L20) *** @@ -338,7 +338,7 @@ #### Defined in -[src/types/PlatformShim.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L18) +[src/types/PlatformShim.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L18) *** @@ -352,4 +352,4 @@ #### Defined in -[src/types/PlatformShim.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L19) +[src/types/PlatformShim.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L19) diff --git a/docs/api/namespaces/Types/type-aliases/BlocklistPickerRequestEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/BlocklistPickerRequestEndpointOptions.md deleted file mode 100644 index e54f9186..00000000 --- a/docs/api/namespaces/Types/type-aliases/BlocklistPickerRequestEndpointOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / BlocklistPickerRequestEndpointOptions - -# Type Alias: BlocklistPickerRequestEndpointOptions - -> **BlocklistPickerRequestEndpointOptions**: `object` - -## Type declaration - -### channel\_id - -> **channel\_id**: `string` - -## Defined in - -[src/types/Endpoints.ts:356](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L356) diff --git a/docs/api/namespaces/Types/type-aliases/BrowseEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/BrowseEndpointOptions.md deleted file mode 100644 index 1edd377a..00000000 --- a/docs/api/namespaces/Types/type-aliases/BrowseEndpointOptions.md +++ /dev/null @@ -1,35 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / BrowseEndpointOptions - -# Type Alias: BrowseEndpointOptions - -> **BrowseEndpointOptions**: `object` - -## Type declaration - -### browse\_id? - -> `optional` **browse\_id**: `string` - -The browse ID. - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### continuation? - -> `optional` **continuation**: `string` - -The continuation token. Mostly used for pagination. - -### params? - -> `optional` **params**: `string` - -Additional protobuf parameters. - -## Defined in - -[src/types/Endpoints.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L93) diff --git a/docs/api/namespaces/Types/type-aliases/ChannelEditDescriptionEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/ChannelEditDescriptionEndpointOptions.md deleted file mode 100644 index 5c6b54e9..00000000 --- a/docs/api/namespaces/Types/type-aliases/ChannelEditDescriptionEndpointOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ChannelEditDescriptionEndpointOptions - -# Type Alias: ChannelEditDescriptionEndpointOptions - -> **ChannelEditDescriptionEndpointOptions**: `object` - -## Type declaration - -### given\_description - -> **given\_description**: `string` - -The new channel description. - -## Defined in - -[src/types/Endpoints.ts:175](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L175) diff --git a/docs/api/namespaces/Types/type-aliases/ChannelEditNameEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/ChannelEditNameEndpointOptions.md deleted file mode 100644 index ff36c2cf..00000000 --- a/docs/api/namespaces/Types/type-aliases/ChannelEditNameEndpointOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ChannelEditNameEndpointOptions - -# Type Alias: ChannelEditNameEndpointOptions - -> **ChannelEditNameEndpointOptions**: `object` - -## Type declaration - -### given\_name - -> **given\_name**: `string` - -The new channel name. - -## Defined in - -[src/types/Endpoints.ts:164](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L164) diff --git a/docs/api/namespaces/Types/type-aliases/CreateCommentEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/CreateCommentEndpointOptions.md deleted file mode 100644 index 48f83414..00000000 --- a/docs/api/namespaces/Types/type-aliases/CreateCommentEndpointOptions.md +++ /dev/null @@ -1,29 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / CreateCommentEndpointOptions - -# Type Alias: CreateCommentEndpointOptions - -> **CreateCommentEndpointOptions**: `object` - -## Type declaration - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### comment\_text - -> **comment\_text**: `string` - -The comment text. - -### create\_comment\_params - -> **create\_comment\_params**: `string` - -Additional protobuf parameters. - -## Defined in - -[src/types/Endpoints.ts:245](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L245) diff --git a/docs/api/namespaces/Types/type-aliases/CreatePlaylistEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/CreatePlaylistEndpointOptions.md deleted file mode 100644 index 23c05a69..00000000 --- a/docs/api/namespaces/Types/type-aliases/CreatePlaylistEndpointOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / CreatePlaylistEndpointOptions - -# Type Alias: CreatePlaylistEndpointOptions - -> **CreatePlaylistEndpointOptions**: `object` - -## Type declaration - -### ids - -> **ids**: `string`[] - -The video IDs to add to the playlist. - -### title - -> **title**: `string` - -The playlist title. - -## Defined in - -[src/types/Endpoints.ts:314](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L314) diff --git a/docs/api/namespaces/Types/type-aliases/CreateVideoEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/CreateVideoEndpointOptions.md deleted file mode 100644 index 7753d6ea..00000000 --- a/docs/api/namespaces/Types/type-aliases/CreateVideoEndpointOptions.md +++ /dev/null @@ -1,79 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / CreateVideoEndpointOptions - -# Type Alias: CreateVideoEndpointOptions - -> **CreateVideoEndpointOptions**: `object` - -## Type declaration - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### frontend\_upload\_id - -> **frontend\_upload\_id**: `string` - -The id of the frontend. - -### initial\_metadata - -> **initial\_metadata**: `object` - -The metadata to set after the video is uploaded. - -### initial\_metadata.description - -> **description**: `object` - -### initial\_metadata.description.new\_description - -> **new\_description**: `string` - -### initial\_metadata.description.should\_segment - -> **should\_segment**: `boolean` - -### initial\_metadata.draft\_state - -> **draft\_state**: `object` - -### initial\_metadata.draft\_state.is\_draft? - -> `optional` **is\_draft**: `boolean` - -### initial\_metadata.privacy - -> **privacy**: `object` - -### initial\_metadata.privacy.new\_privacy - -> **new\_privacy**: `string` - -### initial\_metadata.title - -> **title**: `object` - -### initial\_metadata.title.new\_title - -> **new\_title**: `string` - -### resource\_id - -> **resource\_id**: `object` - -The id of the uploaded resource. - -### resource\_id.scotty\_resource\_id - -> **scotty\_resource\_id**: `object` - -### resource\_id.scotty\_resource\_id.id - -> **id**: `string` - -## Defined in - -[src/types/Endpoints.ts:275](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L275) diff --git a/docs/api/namespaces/Types/type-aliases/DeletePlaylistEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/DeletePlaylistEndpointOptions.md deleted file mode 100644 index 288cd2b2..00000000 --- a/docs/api/namespaces/Types/type-aliases/DeletePlaylistEndpointOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / DeletePlaylistEndpointOptions - -# Type Alias: DeletePlaylistEndpointOptions - -> **DeletePlaylistEndpointOptions**: `object` - -## Type declaration - -### playlist\_id - -> **playlist\_id**: `string` - -The ID of the playlist to delete. - -## Defined in - -[src/types/Endpoints.ts:327](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L327) diff --git a/docs/api/namespaces/Types/type-aliases/DislikeEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/DislikeEndpointOptions.md deleted file mode 100644 index 1e449003..00000000 --- a/docs/api/namespaces/Types/type-aliases/DislikeEndpointOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / DislikeEndpointOptions - -# Type Alias: DislikeEndpointOptions - -> **DislikeEndpointOptions**: [`LikeEndpointOptions`](LikeEndpointOptions.md) - -## Defined in - -[src/types/Endpoints.ts:207](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L207) diff --git a/docs/api/namespaces/Types/type-aliases/Duration.md b/docs/api/namespaces/Types/type-aliases/Duration.md index 9cf155d8..8935d12a 100644 --- a/docs/api/namespaces/Types/type-aliases/Duration.md +++ b/docs/api/namespaces/Types/type-aliases/Duration.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L8) +[src/types/Misc.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L8) diff --git a/docs/api/namespaces/Types/type-aliases/EditPlaylistEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/EditPlaylistEndpointOptions.md deleted file mode 100644 index edea7977..00000000 --- a/docs/api/namespaces/Types/type-aliases/EditPlaylistEndpointOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / EditPlaylistEndpointOptions - -# Type Alias: EditPlaylistEndpointOptions - -> **EditPlaylistEndpointOptions**: `object` - -## Type declaration - -### actions - -> **actions**: `object`[] - -The changes to make to the playlist. - -### playlist\_id - -> **playlist\_id**: `string` - -The ID of the playlist to edit. - -## Defined in - -[src/types/Endpoints.ts:336](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L336) diff --git a/docs/api/namespaces/Types/type-aliases/Feature.md b/docs/api/namespaces/Types/type-aliases/Feature.md index 6259c8b4..70b04ed1 100644 --- a/docs/api/namespaces/Types/type-aliases/Feature.md +++ b/docs/api/namespaces/Types/type-aliases/Feature.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L10) +[src/types/Misc.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L10) diff --git a/docs/api/namespaces/Types/type-aliases/FetchFunction.md b/docs/api/namespaces/Types/type-aliases/FetchFunction.md index 1773c47f..f770ecac 100644 --- a/docs/api/namespaces/Types/type-aliases/FetchFunction.md +++ b/docs/api/namespaces/Types/type-aliases/FetchFunction.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/PlatformShim.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L5) +[src/types/PlatformShim.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L5) diff --git a/docs/api/namespaces/Types/type-aliases/FormatFilter.md b/docs/api/namespaces/Types/type-aliases/FormatFilter.md index 450f98de..375bf86d 100644 --- a/docs/api/namespaces/Types/type-aliases/FormatFilter.md +++ b/docs/api/namespaces/Types/type-aliases/FormatFilter.md @@ -14,4 +14,4 @@ ## Defined in -[src/types/FormatUtils.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L5) +[src/types/FormatUtils.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L5) diff --git a/docs/api/namespaces/Types/type-aliases/GetNotificationMenuEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/GetNotificationMenuEndpointOptions.md deleted file mode 100644 index ddecfe42..00000000 --- a/docs/api/namespaces/Types/type-aliases/GetNotificationMenuEndpointOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / GetNotificationMenuEndpointOptions - -# Type Alias: GetNotificationMenuEndpointOptions - -> **GetNotificationMenuEndpointOptions**: `object` - -## Type declaration - -### notifications\_menu\_request\_type - -> **notifications\_menu\_request\_type**: `"NOTIFICATIONS_MENU_REQUEST_TYPE_INBOX"` \| `"NOTIFICATIONS_MENU_REQUEST_TYPE_COMMENTS"` - -The type of notifications to request. - -## Defined in - -[src/types/Endpoints.ts:144](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L144) diff --git a/docs/api/namespaces/Types/type-aliases/IBlocklistPickerRequest.md b/docs/api/namespaces/Types/type-aliases/IBlocklistPickerRequest.md deleted file mode 100644 index 66b6eef9..00000000 --- a/docs/api/namespaces/Types/type-aliases/IBlocklistPickerRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IBlocklistPickerRequest - -# Type Alias: IBlocklistPickerRequest - -> **IBlocklistPickerRequest**: `object` - -## Type declaration - -### blockedForKidsContent - -> **blockedForKidsContent**: `object` - -### blockedForKidsContent.external\_channel\_id - -> **external\_channel\_id**: `string` - -## Defined in - -[src/types/Endpoints.ts:360](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L360) diff --git a/docs/api/namespaces/Types/type-aliases/IBrowseRequest.md b/docs/api/namespaces/Types/type-aliases/IBrowseRequest.md deleted file mode 100644 index 7ad306f9..00000000 --- a/docs/api/namespaces/Types/type-aliases/IBrowseRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IBrowseRequest - -# Type Alias: IBrowseRequest - -> **IBrowseRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`BrowseEndpointOptions`](BrowseEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:112](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L112) diff --git a/docs/api/namespaces/Types/type-aliases/ICreateCommentRequest.md b/docs/api/namespaces/Types/type-aliases/ICreateCommentRequest.md deleted file mode 100644 index 1a170bb1..00000000 --- a/docs/api/namespaces/Types/type-aliases/ICreateCommentRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ICreateCommentRequest - -# Type Alias: ICreateCommentRequest - -> **ICreateCommentRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`CreateCommentEndpointOptions`](CreateCommentEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:260](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L260) diff --git a/docs/api/namespaces/Types/type-aliases/ICreatePlaylistRequest.md b/docs/api/namespaces/Types/type-aliases/ICreatePlaylistRequest.md deleted file mode 100644 index 1e5ab60b..00000000 --- a/docs/api/namespaces/Types/type-aliases/ICreatePlaylistRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ICreatePlaylistRequest - -# Type Alias: ICreatePlaylistRequest - -> **ICreatePlaylistRequest**: [`CreatePlaylistEndpointOptions`](CreatePlaylistEndpointOptions.md) - -## Defined in - -[src/types/Endpoints.ts:325](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L325) diff --git a/docs/api/namespaces/Types/type-aliases/ICreateVideoRequest.md b/docs/api/namespaces/Types/type-aliases/ICreateVideoRequest.md deleted file mode 100644 index 8a740d00..00000000 --- a/docs/api/namespaces/Types/type-aliases/ICreateVideoRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ICreateVideoRequest - -# Type Alias: ICreateVideoRequest - -> **ICreateVideoRequest**: `Omit`\<[`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`CreateVideoEndpointOptions`](CreateVideoEndpointOptions.md)\>, `"client"`\> - -## Defined in - -[src/types/Endpoints.ts:312](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L312) diff --git a/docs/api/namespaces/Types/type-aliases/IDeletePlaylistRequest.md b/docs/api/namespaces/Types/type-aliases/IDeletePlaylistRequest.md deleted file mode 100644 index 8bf55d17..00000000 --- a/docs/api/namespaces/Types/type-aliases/IDeletePlaylistRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IDeletePlaylistRequest - -# Type Alias: IDeletePlaylistRequest - -> **IDeletePlaylistRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`DeletePlaylistEndpointOptions`](DeletePlaylistEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:334](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L334) diff --git a/docs/api/namespaces/Types/type-aliases/IDislikeRequest.md b/docs/api/namespaces/Types/type-aliases/IDislikeRequest.md deleted file mode 100644 index a81ae05b..00000000 --- a/docs/api/namespaces/Types/type-aliases/IDislikeRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IDislikeRequest - -# Type Alias: IDislikeRequest - -> **IDislikeRequest**: [`ILikeRequest`](ILikeRequest.md) - -## Defined in - -[src/types/Endpoints.ts:206](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L206) diff --git a/docs/api/namespaces/Types/type-aliases/IEditPlaylistRequest.md b/docs/api/namespaces/Types/type-aliases/IEditPlaylistRequest.md deleted file mode 100644 index 358c356c..00000000 --- a/docs/api/namespaces/Types/type-aliases/IEditPlaylistRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IEditPlaylistRequest - -# Type Alias: IEditPlaylistRequest - -> **IEditPlaylistRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`EditPlaylistEndpointOptions`](EditPlaylistEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:354](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L354) diff --git a/docs/api/namespaces/Types/type-aliases/IGetNotificationMenuRequest.md b/docs/api/namespaces/Types/type-aliases/IGetNotificationMenuRequest.md deleted file mode 100644 index 3f682aa7..00000000 --- a/docs/api/namespaces/Types/type-aliases/IGetNotificationMenuRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IGetNotificationMenuRequest - -# Type Alias: IGetNotificationMenuRequest - -> **IGetNotificationMenuRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`GetNotificationMenuEndpointOptions`](GetNotificationMenuEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:151](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L151) diff --git a/docs/api/namespaces/Types/type-aliases/ILikeRequest.md b/docs/api/namespaces/Types/type-aliases/ILikeRequest.md deleted file mode 100644 index 2fb0e1af..00000000 --- a/docs/api/namespaces/Types/type-aliases/ILikeRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ILikeRequest - -# Type Alias: ILikeRequest - -> **ILikeRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`LikeEndpointOptions`](LikeEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:204](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L204) diff --git a/docs/api/namespaces/Types/type-aliases/INextRequest.md b/docs/api/namespaces/Types/type-aliases/INextRequest.md deleted file mode 100644 index c3c94c93..00000000 --- a/docs/api/namespaces/Types/type-aliases/INextRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / INextRequest - -# Type Alias: INextRequest - -> **INextRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`NextEndpointOptions`](NextEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L91) diff --git a/docs/api/namespaces/Types/type-aliases/IRemoveLikeRequest.md b/docs/api/namespaces/Types/type-aliases/IRemoveLikeRequest.md deleted file mode 100644 index cbba4d8e..00000000 --- a/docs/api/namespaces/Types/type-aliases/IRemoveLikeRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IRemoveLikeRequest - -# Type Alias: IRemoveLikeRequest - -> **IRemoveLikeRequest**: [`ILikeRequest`](ILikeRequest.md) - -## Defined in - -[src/types/Endpoints.ts:209](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L209) diff --git a/docs/api/namespaces/Types/type-aliases/ISubscribeRequest.md b/docs/api/namespaces/Types/type-aliases/ISubscribeRequest.md deleted file mode 100644 index 82aacb07..00000000 --- a/docs/api/namespaces/Types/type-aliases/ISubscribeRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ISubscribeRequest - -# Type Alias: ISubscribeRequest - -> **ISubscribeRequest**: [`ObjectSnakeToCamel`](ObjectSnakeToCamel.md)\<[`SubscribeEndpointOptions`](SubscribeEndpointOptions.md)\> - -## Defined in - -[src/types/Endpoints.ts:227](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L227) diff --git a/docs/api/namespaces/Types/type-aliases/IUnsubscribeRequest.md b/docs/api/namespaces/Types/type-aliases/IUnsubscribeRequest.md deleted file mode 100644 index 16a48d6a..00000000 --- a/docs/api/namespaces/Types/type-aliases/IUnsubscribeRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / IUnsubscribeRequest - -# Type Alias: IUnsubscribeRequest - -> **IUnsubscribeRequest**: [`ISubscribeRequest`](ISubscribeRequest.md) - -## Defined in - -[src/types/Endpoints.ts:229](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L229) diff --git a/docs/api/namespaces/Types/type-aliases/InnerTubeClient.md b/docs/api/namespaces/Types/type-aliases/InnerTubeClient.md index beeea291..00f36fd3 100644 --- a/docs/api/namespaces/Types/type-aliases/InnerTubeClient.md +++ b/docs/api/namespaces/Types/type-aliases/InnerTubeClient.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L4) +[src/types/Misc.ts:4](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index b25d95ab..69b3cfd5 100644 --- a/docs/api/namespaces/Types/type-aliases/InnerTubeConfig.md +++ b/docs/api/namespaces/Types/type-aliases/InnerTubeConfig.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L3) +[src/types/Misc.ts:3](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L3) diff --git a/docs/api/namespaces/Types/type-aliases/LikeEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/LikeEndpointOptions.md deleted file mode 100644 index 3ac8f63f..00000000 --- a/docs/api/namespaces/Types/type-aliases/LikeEndpointOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / LikeEndpointOptions - -# Type Alias: LikeEndpointOptions - -> **LikeEndpointOptions**: `object` - -## Type declaration - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### target - -> **target**: `object` - -The target video. - -### target.video\_id - -> **video\_id**: `string` - -## Defined in - -[src/types/Endpoints.ts:191](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L191) diff --git a/docs/api/namespaces/Types/type-aliases/ModifyChannelPreferenceEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/ModifyChannelPreferenceEndpointOptions.md deleted file mode 100644 index 69542fa7..00000000 --- a/docs/api/namespaces/Types/type-aliases/ModifyChannelPreferenceEndpointOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ModifyChannelPreferenceEndpointOptions - -# Type Alias: ModifyChannelPreferenceEndpointOptions - -> **ModifyChannelPreferenceEndpointOptions**: [`IModifyChannelPreferenceRequest`](../interfaces/IModifyChannelPreferenceRequest.md) - -## Defined in - -[src/types/Endpoints.ts:273](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L273) diff --git a/docs/api/namespaces/Types/type-aliases/MusicGetSearchSuggestionsEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/MusicGetSearchSuggestionsEndpointOptions.md deleted file mode 100644 index 8d8a20c9..00000000 --- a/docs/api/namespaces/Types/type-aliases/MusicGetSearchSuggestionsEndpointOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / MusicGetSearchSuggestionsEndpointOptions - -# Type Alias: MusicGetSearchSuggestionsEndpointOptions - -> **MusicGetSearchSuggestionsEndpointOptions**: `object` - -## Type declaration - -### input - -> **input**: `string` - -The query to search for. - -## Defined in - -[src/types/Endpoints.ts:153](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L153) diff --git a/docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md b/docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md index 0c9d9ca4..973ba876 100644 --- a/docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md +++ b/docs/api/namespaces/Types/type-aliases/MusicSearchFilters.md @@ -12,4 +12,4 @@ ## Defined in -[src/types/Misc.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L41) +[src/types/Misc.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L41) diff --git a/docs/api/namespaces/Types/type-aliases/MusicSearchType.md b/docs/api/namespaces/Types/type-aliases/MusicSearchType.md index 0b11293d..5e5b105f 100644 --- a/docs/api/namespaces/Types/type-aliases/MusicSearchType.md +++ b/docs/api/namespaces/Types/type-aliases/MusicSearchType.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L39) +[src/types/Misc.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L39) diff --git a/docs/api/namespaces/Types/type-aliases/NextEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/NextEndpointOptions.md deleted file mode 100644 index e3ec116e..00000000 --- a/docs/api/namespaces/Types/type-aliases/NextEndpointOptions.md +++ /dev/null @@ -1,47 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / NextEndpointOptions - -# Type Alias: NextEndpointOptions - -> **NextEndpointOptions**: `object` - -## Type declaration - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### continuation? - -> `optional` **continuation**: `string` - -The continuation token. Mostly used for pagination. - -### params? - -> `optional` **params**: `string` - -Protobuf parameters. - -### playlist\_id? - -> `optional` **playlist\_id**: `string` - -The playlist associated with the video. - -### playlist\_index? - -> `optional` **playlist\_index**: `number` - -The playlist index. - -### video\_id? - -> `optional` **video\_id**: `string` - -The video ID. - -## Defined in - -[src/types/Endpoints.ts:64](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L64) diff --git a/docs/api/namespaces/Types/type-aliases/ObjectSnakeToCamel.md b/docs/api/namespaces/Types/type-aliases/ObjectSnakeToCamel.md deleted file mode 100644 index 68a64802..00000000 --- a/docs/api/namespaces/Types/type-aliases/ObjectSnakeToCamel.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ObjectSnakeToCamel - -# Type Alias: ObjectSnakeToCamel\ - -> **ObjectSnakeToCamel**\<`T`\>: `{ [K in keyof T as SnakeToCamel]: T[K] extends object ? ObjectSnakeToCamel : T[K] }` - -## Type Parameters - -• **T** - -## Defined in - -[src/types/Endpoints.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L5) diff --git a/docs/api/namespaces/Types/type-aliases/PerformCommentActionEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/PerformCommentActionEndpointOptions.md deleted file mode 100644 index 6ef30e72..00000000 --- a/docs/api/namespaces/Types/type-aliases/PerformCommentActionEndpointOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / PerformCommentActionEndpointOptions - -# Type Alias: PerformCommentActionEndpointOptions - -> **PerformCommentActionEndpointOptions**: [`IPerformCommentActionRequest`](../interfaces/IPerformCommentActionRequest.md) - -## Defined in - -[src/types/Endpoints.ts:243](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L243) diff --git a/docs/api/namespaces/Types/type-aliases/PlayerEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/PlayerEndpointOptions.md deleted file mode 100644 index d54b543a..00000000 --- a/docs/api/namespaces/Types/type-aliases/PlayerEndpointOptions.md +++ /dev/null @@ -1,47 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / PlayerEndpointOptions - -# Type Alias: PlayerEndpointOptions - -> **PlayerEndpointOptions**: `object` - -## Type declaration - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### params? - -> `optional` **params**: `string` - -Additional protobuf parameters. - -### playlist\_id? - -> `optional` **playlist\_id**: `string` - -The playlist ID. - -### po\_token? - -> `optional` **po\_token**: `string` - -Token for serviceIntegrityDimensions - -### sts? - -> `optional` **sts**: `number` - -The player's signature timestamp. - -### video\_id - -> **video\_id**: `string` - -The video ID. - -## Defined in - -[src/types/Endpoints.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L37) diff --git a/docs/api/namespaces/Types/type-aliases/ReelItemWatchEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/ReelItemWatchEndpointOptions.md deleted file mode 100644 index 35079e11..00000000 --- a/docs/api/namespaces/Types/type-aliases/ReelItemWatchEndpointOptions.md +++ /dev/null @@ -1,29 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ReelItemWatchEndpointOptions - -# Type Alias: ReelItemWatchEndpointOptions - -> **ReelItemWatchEndpointOptions**: `object` - -## Type declaration - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### params? - -> `optional` **params**: `string` - -Additional protobuf parameters. - -### video\_id - -> **video\_id**: `string` - -The shorts ID. - -## Defined in - -[src/types/Endpoints.ts:376](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L376) diff --git a/docs/api/namespaces/Types/type-aliases/ReelWatchSequenceEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/ReelWatchSequenceEndpointOptions.md deleted file mode 100644 index a3d7e926..00000000 --- a/docs/api/namespaces/Types/type-aliases/ReelWatchSequenceEndpointOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ReelWatchSequenceEndpointOptions - -# Type Alias: ReelWatchSequenceEndpointOptions - -> **ReelWatchSequenceEndpointOptions**: `object` - -## Type declaration - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### sequence\_params - -> **sequence\_params**: `string` - -The protobuf parameters. - -## Defined in - -[src/types/Endpoints.ts:395](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L395) diff --git a/docs/api/namespaces/Types/type-aliases/RemoveLikeEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/RemoveLikeEndpointOptions.md deleted file mode 100644 index b2bfb891..00000000 --- a/docs/api/namespaces/Types/type-aliases/RemoveLikeEndpointOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / RemoveLikeEndpointOptions - -# Type Alias: RemoveLikeEndpointOptions - -> **RemoveLikeEndpointOptions**: [`LikeEndpointOptions`](LikeEndpointOptions.md) - -## Defined in - -[src/types/Endpoints.ts:210](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L210) diff --git a/docs/api/namespaces/Types/type-aliases/ResolveURLEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/ResolveURLEndpointOptions.md deleted file mode 100644 index 9b78babd..00000000 --- a/docs/api/namespaces/Types/type-aliases/ResolveURLEndpointOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / ResolveURLEndpointOptions - -# Type Alias: ResolveURLEndpointOptions - -> **ResolveURLEndpointOptions**: [`IResolveURLRequest`](../interfaces/IResolveURLRequest.md) - -## Defined in - -[src/types/Endpoints.ts:142](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L142) diff --git a/docs/api/namespaces/Types/type-aliases/Runtime.md b/docs/api/namespaces/Types/type-aliases/Runtime.md index 2575bba5..ba345113 100644 --- a/docs/api/namespaces/Types/type-aliases/Runtime.md +++ b/docs/api/namespaces/Types/type-aliases/Runtime.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/PlatformShim.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L3) +[src/types/PlatformShim.ts:3](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L3) diff --git a/docs/api/namespaces/Types/type-aliases/SearchEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/SearchEndpointOptions.md deleted file mode 100644 index 93391c6f..00000000 --- a/docs/api/namespaces/Types/type-aliases/SearchEndpointOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SearchEndpointOptions - -# Type Alias: SearchEndpointOptions - -> **SearchEndpointOptions**: [`ISearchRequest`](../interfaces/ISearchRequest.md) - -## Defined in - -[src/types/Endpoints.ts:133](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L133) diff --git a/docs/api/namespaces/Types/type-aliases/SearchFilters.md b/docs/api/namespaces/Types/type-aliases/SearchFilters.md index 84e6639e..1d071165 100644 --- a/docs/api/namespaces/Types/type-aliases/SearchFilters.md +++ b/docs/api/namespaces/Types/type-aliases/SearchFilters.md @@ -28,4 +28,4 @@ ## Defined in -[src/types/Misc.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L12) +[src/types/Misc.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L12) diff --git a/docs/api/namespaces/Types/type-aliases/SearchType.md b/docs/api/namespaces/Types/type-aliases/SearchType.md index 2de14fc8..fc78a534 100644 --- a/docs/api/namespaces/Types/type-aliases/SearchType.md +++ b/docs/api/namespaces/Types/type-aliases/SearchType.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L7) +[src/types/Misc.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L7) diff --git a/docs/api/namespaces/Types/type-aliases/SnakeToCamel.md b/docs/api/namespaces/Types/type-aliases/SnakeToCamel.md deleted file mode 100644 index f3ae299e..00000000 --- a/docs/api/namespaces/Types/type-aliases/SnakeToCamel.md +++ /dev/null @@ -1,13 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SnakeToCamel - -# Type Alias: SnakeToCamel\ - -> **SnakeToCamel**\<`S`\>: `S` *extends* \`$\{infer T\}\_$\{infer U\}\` ? \`$\{Lowercase\\}$\{Capitalize\\>\}\` : `S` - -## Type Parameters - -• **S** *extends* `string` - -## Defined in - -[src/types/Endpoints.ts:3](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L3) diff --git a/docs/api/namespaces/Types/type-aliases/SortBy.md b/docs/api/namespaces/Types/type-aliases/SortBy.md index 71a40ea3..d33fe1e9 100644 --- a/docs/api/namespaces/Types/type-aliases/SortBy.md +++ b/docs/api/namespaces/Types/type-aliases/SortBy.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L9) +[src/types/Misc.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L9) diff --git a/docs/api/namespaces/Types/type-aliases/SubscribeEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/SubscribeEndpointOptions.md deleted file mode 100644 index d776a4f2..00000000 --- a/docs/api/namespaces/Types/type-aliases/SubscribeEndpointOptions.md +++ /dev/null @@ -1,29 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / SubscribeEndpointOptions - -# Type Alias: SubscribeEndpointOptions - -> **SubscribeEndpointOptions**: `object` - -## Type declaration - -### channel\_ids - -> **channel\_ids**: `string`[] - -The channel IDs to subscribe to/unsubscribe from. - -### client? - -> `optional` **client**: [`InnerTubeClient`](InnerTubeClient.md) - -The client to use. - -### params? - -> `optional` **params**: `string` - -Additional protobuf parameters. - -## Defined in - -[src/types/Endpoints.ts:212](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L212) diff --git a/docs/api/namespaces/Types/type-aliases/URLTransformer.md b/docs/api/namespaces/Types/type-aliases/URLTransformer.md index 9dd5c75b..a8b84f7b 100644 --- a/docs/api/namespaces/Types/type-aliases/URLTransformer.md +++ b/docs/api/namespaces/Types/type-aliases/URLTransformer.md @@ -14,4 +14,4 @@ ## Defined in -[src/types/FormatUtils.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/FormatUtils.ts#L4) +[src/types/FormatUtils.ts:4](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/FormatUtils.ts#L4) diff --git a/docs/api/namespaces/Types/type-aliases/UnsubscribeEndpointOptions.md b/docs/api/namespaces/Types/type-aliases/UnsubscribeEndpointOptions.md deleted file mode 100644 index 7696c7d0..00000000 --- a/docs/api/namespaces/Types/type-aliases/UnsubscribeEndpointOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[youtubei.js](../../../README.md) / [Types](../README.md) / UnsubscribeEndpointOptions - -# Type Alias: UnsubscribeEndpointOptions - -> **UnsubscribeEndpointOptions**: [`SubscribeEndpointOptions`](SubscribeEndpointOptions.md) - -## Defined in - -[src/types/Endpoints.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Endpoints.ts#L230) diff --git a/docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md b/docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md index 0d091ca6..0fafc826 100644 --- a/docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md +++ b/docs/api/namespaces/Types/type-aliases/UpdateVideoMetadataOptions.md @@ -44,4 +44,4 @@ ## Defined in -[src/types/Misc.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L20) +[src/types/Misc.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L20) diff --git a/docs/api/namespaces/Types/type-aliases/UploadDate.md b/docs/api/namespaces/Types/type-aliases/UploadDate.md index 13adfc5e..0e8e6e9a 100644 --- a/docs/api/namespaces/Types/type-aliases/UploadDate.md +++ b/docs/api/namespaces/Types/type-aliases/UploadDate.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/Misc.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L6) +[src/types/Misc.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L6) diff --git a/docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md b/docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md index 68254b00..1e65760b 100644 --- a/docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md +++ b/docs/api/namespaces/Types/type-aliases/UploadedVideoMetadataOptions.md @@ -24,4 +24,4 @@ ## Defined in -[src/types/Misc.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/Misc.ts#L32) +[src/types/Misc.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/Misc.ts#L32) diff --git a/docs/api/namespaces/Types/type-aliases/VMPrimative.md b/docs/api/namespaces/Types/type-aliases/VMPrimative.md index 5f7f6a04..9a2a0d8f 100644 --- a/docs/api/namespaces/Types/type-aliases/VMPrimative.md +++ b/docs/api/namespaces/Types/type-aliases/VMPrimative.md @@ -6,4 +6,4 @@ ## Defined in -[src/types/PlatformShim.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/types/PlatformShim.ts#L7) +[src/types/PlatformShim.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/types/PlatformShim.ts#L7) diff --git a/docs/api/namespaces/Utils/classes/ChannelError.md b/docs/api/namespaces/Utils/classes/ChannelError.md index 89ccfe22..ca4d6944 100644 --- a/docs/api/namespaces/Utils/classes/ChannelError.md +++ b/docs/api/namespaces/Utils/classes/ChannelError.md @@ -26,7 +26,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1082 +node\_modules/typescript/lib/lib.es5.d.ts:1082 ### new ChannelError() @@ -48,7 +48,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1082 +node\_modules/typescript/lib/lib.es5.d.ts:1082 ## Properties @@ -62,7 +62,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 +node\_modules/typescript/lib/lib.es2022.error.d.ts:24 *** @@ -76,7 +76,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 +node\_modules/typescript/lib/lib.es5.d.ts:1077 *** @@ -90,7 +90,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 +node\_modules/typescript/lib/lib.es5.d.ts:1076 *** @@ -104,7 +104,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 +node\_modules/typescript/lib/lib.es5.d.ts:1078 *** @@ -134,7 +134,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:11 +node\_modules/@types/node/globals.d.ts:11 *** @@ -148,7 +148,7 @@ node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:1 #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:13 +node\_modules/@types/node/globals.d.ts:13 ## Methods @@ -174,4 +174,4 @@ Create .stack property on a target object #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:4 +node\_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/namespaces/Utils/classes/InnertubeError.md b/docs/api/namespaces/Utils/classes/InnertubeError.md index cd837890..96211859 100644 --- a/docs/api/namespaces/Utils/classes/InnertubeError.md +++ b/docs/api/namespaces/Utils/classes/InnertubeError.md @@ -34,7 +34,7 @@ #### Defined in -[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L31) +[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L31) ## Properties @@ -48,7 +48,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 +node\_modules/typescript/lib/lib.es2022.error.d.ts:24 *** @@ -58,7 +58,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L27) +[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L27) *** @@ -68,7 +68,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L29) +[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L29) *** @@ -82,7 +82,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 +node\_modules/typescript/lib/lib.es5.d.ts:1077 *** @@ -96,7 +96,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 +node\_modules/typescript/lib/lib.es5.d.ts:1076 *** @@ -110,7 +110,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 +node\_modules/typescript/lib/lib.es5.d.ts:1078 *** @@ -120,7 +120,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L28) +[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L28) *** @@ -150,7 +150,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:11 +node\_modules/@types/node/globals.d.ts:11 *** @@ -164,7 +164,7 @@ node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:1 #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:13 +node\_modules/@types/node/globals.d.ts:13 ## Methods @@ -190,4 +190,4 @@ Create .stack property on a target object #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:4 +node\_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/namespaces/Utils/classes/MissingParamError.md b/docs/api/namespaces/Utils/classes/MissingParamError.md index 5b112980..cd7b3446 100644 --- a/docs/api/namespaces/Utils/classes/MissingParamError.md +++ b/docs/api/namespaces/Utils/classes/MissingParamError.md @@ -28,7 +28,7 @@ #### Defined in -[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L31) +[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L31) ## Properties @@ -42,7 +42,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 +node\_modules/typescript/lib/lib.es2022.error.d.ts:24 *** @@ -56,7 +56,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L27) +[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L27) *** @@ -70,7 +70,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L29) +[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L29) *** @@ -84,7 +84,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 +node\_modules/typescript/lib/lib.es5.d.ts:1077 *** @@ -98,7 +98,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 +node\_modules/typescript/lib/lib.es5.d.ts:1076 *** @@ -112,7 +112,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 +node\_modules/typescript/lib/lib.es5.d.ts:1078 *** @@ -126,7 +126,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L28) +[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L28) *** @@ -156,7 +156,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:11 +node\_modules/@types/node/globals.d.ts:11 *** @@ -170,7 +170,7 @@ node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:1 #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:13 +node\_modules/@types/node/globals.d.ts:13 ## Methods @@ -196,4 +196,4 @@ Create .stack property on a target object #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:4 +node\_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/namespaces/Utils/classes/OAuth2Error.md b/docs/api/namespaces/Utils/classes/OAuth2Error.md index e5ac79b8..62a76fc0 100644 --- a/docs/api/namespaces/Utils/classes/OAuth2Error.md +++ b/docs/api/namespaces/Utils/classes/OAuth2Error.md @@ -28,7 +28,7 @@ #### Defined in -[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L31) +[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L31) ## Properties @@ -42,7 +42,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 +node\_modules/typescript/lib/lib.es2022.error.d.ts:24 *** @@ -56,7 +56,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L27) +[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L27) *** @@ -70,7 +70,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L29) +[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L29) *** @@ -84,7 +84,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 +node\_modules/typescript/lib/lib.es5.d.ts:1077 *** @@ -98,7 +98,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 +node\_modules/typescript/lib/lib.es5.d.ts:1076 *** @@ -112,7 +112,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 +node\_modules/typescript/lib/lib.es5.d.ts:1078 *** @@ -126,7 +126,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L28) +[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L28) *** @@ -156,7 +156,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:11 +node\_modules/@types/node/globals.d.ts:11 *** @@ -170,7 +170,7 @@ node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:1 #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:13 +node\_modules/@types/node/globals.d.ts:13 ## Methods @@ -196,4 +196,4 @@ Create .stack property on a target object #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:4 +node\_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/namespaces/Utils/classes/ParsingError.md b/docs/api/namespaces/Utils/classes/ParsingError.md index c4bb3c32..2cb7f989 100644 --- a/docs/api/namespaces/Utils/classes/ParsingError.md +++ b/docs/api/namespaces/Utils/classes/ParsingError.md @@ -28,7 +28,7 @@ #### Defined in -[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L31) +[src/utils/Utils.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L31) ## Properties @@ -42,7 +42,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 +node\_modules/typescript/lib/lib.es2022.error.d.ts:24 *** @@ -56,7 +56,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L27) +[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L27) *** @@ -70,7 +70,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L29) +[src/utils/Utils.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L29) *** @@ -84,7 +84,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 +node\_modules/typescript/lib/lib.es5.d.ts:1077 *** @@ -98,7 +98,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 +node\_modules/typescript/lib/lib.es5.d.ts:1076 *** @@ -112,7 +112,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 +node\_modules/typescript/lib/lib.es5.d.ts:1078 *** @@ -126,7 +126,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L28) +[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L28) *** @@ -156,7 +156,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:11 +node\_modules/@types/node/globals.d.ts:11 *** @@ -170,7 +170,7 @@ node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:1 #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:13 +node\_modules/@types/node/globals.d.ts:13 ## Methods @@ -196,4 +196,4 @@ Create .stack property on a target object #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:4 +node\_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/namespaces/Utils/classes/PlayerError.md b/docs/api/namespaces/Utils/classes/PlayerError.md index 336e5445..ff8e3452 100644 --- a/docs/api/namespaces/Utils/classes/PlayerError.md +++ b/docs/api/namespaces/Utils/classes/PlayerError.md @@ -26,7 +26,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1082 +node\_modules/typescript/lib/lib.es5.d.ts:1082 ### new PlayerError() @@ -48,7 +48,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1082 +node\_modules/typescript/lib/lib.es5.d.ts:1082 ## Properties @@ -62,7 +62,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 +node\_modules/typescript/lib/lib.es2022.error.d.ts:24 *** @@ -76,7 +76,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 +node\_modules/typescript/lib/lib.es5.d.ts:1077 *** @@ -90,7 +90,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 +node\_modules/typescript/lib/lib.es5.d.ts:1076 *** @@ -104,7 +104,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 +node\_modules/typescript/lib/lib.es5.d.ts:1078 *** @@ -134,7 +134,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:11 +node\_modules/@types/node/globals.d.ts:11 *** @@ -148,7 +148,7 @@ node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:1 #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:13 +node\_modules/@types/node/globals.d.ts:13 ## Methods @@ -174,4 +174,4 @@ Create .stack property on a target object #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:4 +node\_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/namespaces/Utils/classes/SessionError.md b/docs/api/namespaces/Utils/classes/SessionError.md index 42df049d..6e82be45 100644 --- a/docs/api/namespaces/Utils/classes/SessionError.md +++ b/docs/api/namespaces/Utils/classes/SessionError.md @@ -26,7 +26,7 @@ #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1082 +node\_modules/typescript/lib/lib.es5.d.ts:1082 ### new SessionError() @@ -48,7 +48,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1082 +node\_modules/typescript/lib/lib.es5.d.ts:1082 ## Properties @@ -62,7 +62,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 +node\_modules/typescript/lib/lib.es2022.error.d.ts:24 *** @@ -76,7 +76,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 +node\_modules/typescript/lib/lib.es5.d.ts:1077 *** @@ -90,7 +90,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 +node\_modules/typescript/lib/lib.es5.d.ts:1076 *** @@ -104,7 +104,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 +node\_modules/typescript/lib/lib.es5.d.ts:1078 *** @@ -134,7 +134,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:11 +node\_modules/@types/node/globals.d.ts:11 *** @@ -148,7 +148,7 @@ node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:1 #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:13 +node\_modules/@types/node/globals.d.ts:13 ## Methods @@ -174,4 +174,4 @@ Create .stack property on a target object #### Defined in -node\_modules/.deno/@types+node@17.0.45/node\_modules/@types/node/globals.d.ts:4 +node\_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/namespaces/Utils/functions/base64ToU8.md b/docs/api/namespaces/Utils/functions/base64ToU8.md index 0303621e..e6441358 100644 --- a/docs/api/namespaces/Utils/functions/base64ToU8.md +++ b/docs/api/namespaces/Utils/functions/base64ToU8.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/Utils.ts:237](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L237) +[src/utils/Utils.ts:237](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L237) diff --git a/docs/api/namespaces/Utils/functions/concatMemos.md b/docs/api/namespaces/Utils/functions/concatMemos.md index eeb4d99e..7d6c8bba 100644 --- a/docs/api/namespaces/Utils/functions/concatMemos.md +++ b/docs/api/namespaces/Utils/functions/concatMemos.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/Utils.ts:141](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L141) +[src/utils/Utils.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L141) diff --git a/docs/api/namespaces/Utils/functions/debugFetch.md b/docs/api/namespaces/Utils/functions/debugFetch.md index e36aed28..661243e9 100644 --- a/docs/api/namespaces/Utils/functions/debugFetch.md +++ b/docs/api/namespaces/Utils/functions/debugFetch.md @@ -18,4 +18,4 @@ ## Defined in -[src/utils/Utils.ts:192](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L192) +[src/utils/Utils.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L192) diff --git a/docs/api/namespaces/Utils/functions/deepCompare.md b/docs/api/namespaces/Utils/functions/deepCompare.md index ee36ea87..e70acee8 100644 --- a/docs/api/namespaces/Utils/functions/deepCompare.md +++ b/docs/api/namespaces/Utils/functions/deepCompare.md @@ -19,4 +19,4 @@ objects with methods. ## Defined in -[src/utils/Utils.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L54) +[src/utils/Utils.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L54) diff --git a/docs/api/namespaces/Utils/functions/escapeStringRegexp.md b/docs/api/namespaces/Utils/functions/escapeStringRegexp.md index 2d367264..85db665e 100644 --- a/docs/api/namespaces/Utils/functions/escapeStringRegexp.md +++ b/docs/api/namespaces/Utils/functions/escapeStringRegexp.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/Utils.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L77) +[src/utils/Utils.ts:77](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L77) diff --git a/docs/api/namespaces/Utils/functions/findFunction.md b/docs/api/namespaces/Utils/functions/findFunction.md index 5ca1899d..d451b242 100644 --- a/docs/api/namespaces/Utils/functions/findFunction.md +++ b/docs/api/namespaces/Utils/functions/findFunction.md @@ -27,4 +27,4 @@ console.log(result); ## Defined in -[src/utils/Utils.ts:289](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L289) +[src/utils/Utils.ts:289](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L289) diff --git a/docs/api/namespaces/Utils/functions/generateRandomString.md b/docs/api/namespaces/Utils/functions/generateRandomString.md index dd1cb073..cde2e77b 100644 --- a/docs/api/namespaces/Utils/functions/generateRandomString.md +++ b/docs/api/namespaces/Utils/functions/generateRandomString.md @@ -16,4 +16,4 @@ Generates a random string with the given length. ## Defined in -[src/utils/Utils.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L111) +[src/utils/Utils.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L111) diff --git a/docs/api/namespaces/Utils/functions/generateSidAuth.md b/docs/api/namespaces/Utils/functions/generateSidAuth.md index 448f6579..6eef0391 100644 --- a/docs/api/namespaces/Utils/functions/generateSidAuth.md +++ b/docs/api/namespaces/Utils/functions/generateSidAuth.md @@ -18,4 +18,4 @@ Sid extracted from cookies ## Defined in -[src/utils/Utils.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L97) +[src/utils/Utils.ts:97](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L97) diff --git a/docs/api/namespaces/Utils/functions/getCookie.md b/docs/api/namespaces/Utils/functions/getCookie.md index 73a37cc0..ca8e4ad2 100644 --- a/docs/api/namespaces/Utils/functions/getCookie.md +++ b/docs/api/namespaces/Utils/functions/getCookie.md @@ -18,4 +18,4 @@ ## Defined in -[src/utils/Utils.ts:247](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L247) +[src/utils/Utils.ts:247](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L247) diff --git a/docs/api/namespaces/Utils/functions/getRandomUserAgent.md b/docs/api/namespaces/Utils/functions/getRandomUserAgent.md index 6a6ba97c..4f827c6e 100644 --- a/docs/api/namespaces/Utils/functions/getRandomUserAgent.md +++ b/docs/api/namespaces/Utils/functions/getRandomUserAgent.md @@ -18,4 +18,4 @@ mobile | desktop ## Defined in -[src/utils/Utils.ts:87](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L87) +[src/utils/Utils.ts:87](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L87) diff --git a/docs/api/namespaces/Utils/functions/getStringBetweenStrings.md b/docs/api/namespaces/Utils/functions/getStringBetweenStrings.md index 11090454..8f0aea8b 100644 --- a/docs/api/namespaces/Utils/functions/getStringBetweenStrings.md +++ b/docs/api/namespaces/Utils/functions/getStringBetweenStrings.md @@ -26,4 +26,4 @@ end string. ## Defined in -[src/utils/Utils.ts:71](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L71) +[src/utils/Utils.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L71) diff --git a/docs/api/namespaces/Utils/functions/hasKeys.md b/docs/api/namespaces/Utils/functions/hasKeys.md index 0dfdde31..949624fa 100644 --- a/docs/api/namespaces/Utils/functions/hasKeys.md +++ b/docs/api/namespaces/Utils/functions/hasKeys.md @@ -22,4 +22,4 @@ ## Defined in -[src/utils/Utils.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L168) +[src/utils/Utils.ts:168](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L168) diff --git a/docs/api/namespaces/Utils/functions/isTextRun.md b/docs/api/namespaces/Utils/functions/isTextRun.md index e9c29fd4..1fdc28fd 100644 --- a/docs/api/namespaces/Utils/functions/isTextRun.md +++ b/docs/api/namespaces/Utils/functions/isTextRun.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/Utils.ts:243](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L243) +[src/utils/Utils.ts:243](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L243) diff --git a/docs/api/namespaces/Utils/functions/streamToIterable.md b/docs/api/namespaces/Utils/functions/streamToIterable.md index a86e29d5..e31ab83b 100644 --- a/docs/api/namespaces/Utils/functions/streamToIterable.md +++ b/docs/api/namespaces/Utils/functions/streamToIterable.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/Utils.ts:176](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L176) +[src/utils/Utils.ts:176](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L176) diff --git a/docs/api/namespaces/Utils/functions/throwIfMissing.md b/docs/api/namespaces/Utils/functions/throwIfMissing.md index c090b8a3..23f7b124 100644 --- a/docs/api/namespaces/Utils/functions/throwIfMissing.md +++ b/docs/api/namespaces/Utils/functions/throwIfMissing.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/Utils.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L161) +[src/utils/Utils.ts:161](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L161) diff --git a/docs/api/namespaces/Utils/functions/timeToSeconds.md b/docs/api/namespaces/Utils/functions/timeToSeconds.md index f012b385..635e9c3b 100644 --- a/docs/api/namespaces/Utils/functions/timeToSeconds.md +++ b/docs/api/namespaces/Utils/functions/timeToSeconds.md @@ -18,4 +18,4 @@ seconds ## Defined in -[src/utils/Utils.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L127) +[src/utils/Utils.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L127) diff --git a/docs/api/namespaces/Utils/functions/u8ToBase64.md b/docs/api/namespaces/Utils/functions/u8ToBase64.md index db70cdb8..2f6dd158 100644 --- a/docs/api/namespaces/Utils/functions/u8ToBase64.md +++ b/docs/api/namespaces/Utils/functions/u8ToBase64.md @@ -14,4 +14,4 @@ ## Defined in -[src/utils/Utils.ts:233](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L233) +[src/utils/Utils.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L233) diff --git a/docs/api/namespaces/Utils/type-aliases/DeviceCategory.md b/docs/api/namespaces/Utils/type-aliases/DeviceCategory.md index 1156699c..78208a20 100644 --- a/docs/api/namespaces/Utils/type-aliases/DeviceCategory.md +++ b/docs/api/namespaces/Utils/type-aliases/DeviceCategory.md @@ -6,4 +6,4 @@ ## Defined in -[src/utils/Utils.ts:81](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L81) +[src/utils/Utils.ts:81](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L81) diff --git a/docs/api/namespaces/Utils/type-aliases/FindFunctionArgs.md b/docs/api/namespaces/Utils/type-aliases/FindFunctionArgs.md index ec669bda..5a29b180 100644 --- a/docs/api/namespaces/Utils/type-aliases/FindFunctionArgs.md +++ b/docs/api/namespaces/Utils/type-aliases/FindFunctionArgs.md @@ -26,4 +26,4 @@ A regular expression that the function's code must match. ## Defined in -[src/utils/Utils.ts:253](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L253) +[src/utils/Utils.ts:253](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L253) diff --git a/docs/api/namespaces/Utils/type-aliases/FindFunctionResult.md b/docs/api/namespaces/Utils/type-aliases/FindFunctionResult.md index 05a52dd6..2bf89a7e 100644 --- a/docs/api/namespaces/Utils/type-aliases/FindFunctionResult.md +++ b/docs/api/namespaces/Utils/type-aliases/FindFunctionResult.md @@ -28,4 +28,4 @@ ## Defined in -[src/utils/Utils.ts:270](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/Utils.ts#L270) +[src/utils/Utils.ts:270](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/Utils.ts#L270) diff --git a/docs/api/namespaces/YT/classes/AccountInfo.md b/docs/api/namespaces/YT/classes/AccountInfo.md index fcaf8443..319b8b7c 100644 --- a/docs/api/namespaces/YT/classes/AccountInfo.md +++ b/docs/api/namespaces/YT/classes/AccountInfo.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/youtube/AccountInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/AccountInfo.ts#L14) +[src/parser/youtube/AccountInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/AccountInfo.ts#L14) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/youtube/AccountInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/AccountInfo.ts#L12) +[src/parser/youtube/AccountInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/AccountInfo.ts#L12) ## Accessors @@ -42,4 +42,4 @@ #### Defined in -[src/parser/youtube/AccountInfo.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/AccountInfo.ts#L28) +[src/parser/youtube/AccountInfo.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/AccountInfo.ts#L28) diff --git a/docs/api/namespaces/YT/classes/Analytics.md b/docs/api/namespaces/YT/classes/Analytics.md index 516402b3..16b7cbf8 100644 --- a/docs/api/namespaces/YT/classes/Analytics.md +++ b/docs/api/namespaces/YT/classes/Analytics.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/youtube/Analytics.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Analytics.ts#L10) +[src/parser/youtube/Analytics.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Analytics.ts#L10) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/youtube/Analytics.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Analytics.ts#L8) +[src/parser/youtube/Analytics.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Analytics.ts#L8) ## Accessors @@ -42,4 +42,4 @@ #### Defined in -[src/parser/youtube/Analytics.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Analytics.ts#L15) +[src/parser/youtube/Analytics.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Analytics.ts#L15) diff --git a/docs/api/namespaces/YT/classes/Channel.md b/docs/api/namespaces/YT/classes/Channel.md index 2d550dd9..c9cd49f9 100644 --- a/docs/api/namespaces/YT/classes/Channel.md +++ b/docs/api/namespaces/YT/classes/Channel.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L36) +[src/parser/youtube/Channel.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L36) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L34) +[src/parser/youtube/Channel.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L34) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L31) +[src/parser/youtube/Channel.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L31) *** @@ -196,7 +196,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L32) +[src/parser/youtube/Channel.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L32) *** @@ -206,7 +206,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L33) +[src/parser/youtube/Channel.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L33) ## Accessors @@ -224,7 +224,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -244,7 +244,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -258,7 +258,7 @@ Get all the channels in the feed #### Defined in -[src/parser/youtube/Channel.ts:144](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L144) +[src/parser/youtube/Channel.ts:144](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L144) *** @@ -272,7 +272,7 @@ Get all the channels in the feed #### Defined in -[src/parser/youtube/Channel.ts:135](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L135) +[src/parser/youtube/Channel.ts:135](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L135) *** @@ -286,7 +286,7 @@ Get all the channels in the feed #### Defined in -[src/parser/youtube/Channel.ts:273](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L273) +[src/parser/youtube/Channel.ts:273](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L273) *** @@ -300,7 +300,7 @@ Get all the channels in the feed #### Defined in -[src/parser/youtube/Channel.ts:269](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L269) +[src/parser/youtube/Channel.ts:269](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L269) *** @@ -320,7 +320,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -334,7 +334,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:241](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L241) +[src/parser/youtube/Channel.ts:241](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L241) *** @@ -348,7 +348,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:253](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L253) +[src/parser/youtube/Channel.ts:253](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L253) *** @@ -362,7 +362,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:265](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L265) +[src/parser/youtube/Channel.ts:265](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L265) *** @@ -376,7 +376,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:261](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L261) +[src/parser/youtube/Channel.ts:261](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L261) *** @@ -390,7 +390,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:257](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L257) +[src/parser/youtube/Channel.ts:257](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L257) *** @@ -404,7 +404,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:280](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L280) +[src/parser/youtube/Channel.ts:280](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L280) *** @@ -418,7 +418,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:249](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L249) +[src/parser/youtube/Channel.ts:249](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L249) *** @@ -432,7 +432,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Channel.ts:245](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L245) +[src/parser/youtube/Channel.ts:245](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L245) *** @@ -450,7 +450,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -470,19 +470,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -490,7 +490,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -510,19 +510,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -530,7 +530,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -550,7 +550,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -570,7 +570,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -584,7 +584,7 @@ Returns all segments/sections from the page. #### Defined in -[src/parser/youtube/Channel.ts:139](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L139) +[src/parser/youtube/Channel.ts:139](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L139) *** @@ -602,7 +602,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/TabbedFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L19) +[src/core/mixins/TabbedFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L19) *** @@ -620,7 +620,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/TabbedFeed.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L55) +[src/core/mixins/TabbedFeed.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L55) *** @@ -640,7 +640,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -662,7 +662,7 @@ The content type filter to apply #### Defined in -[src/parser/youtube/Channel.ts:116](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L116) +[src/parser/youtube/Channel.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L116) *** @@ -684,7 +684,7 @@ The filter to apply #### Defined in -[src/parser/youtube/Channel.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L65) +[src/parser/youtube/Channel.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L65) *** @@ -706,7 +706,7 @@ The sort filter to apply #### Defined in -[src/parser/youtube/Channel.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L93) +[src/parser/youtube/Channel.ts:93](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L93) *** @@ -723,7 +723,7 @@ Note that this does not return a new [Channel](Channel.md) object. #### Defined in -[src/parser/youtube/Channel.ts:193](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L193) +[src/parser/youtube/Channel.ts:193](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L193) *** @@ -737,7 +737,7 @@ Note that this does not return a new [Channel](Channel.md) object. #### Defined in -[src/parser/youtube/Channel.ts:184](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L184) +[src/parser/youtube/Channel.ts:184](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L184) *** @@ -757,7 +757,7 @@ Retrives list continuation. #### Defined in -[src/parser/youtube/Channel.ts:287](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L287) +[src/parser/youtube/Channel.ts:287](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L287) *** @@ -777,7 +777,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -791,7 +791,7 @@ Retrieves continuation data as it is. #### Defined in -[src/parser/youtube/Channel.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L149) +[src/parser/youtube/Channel.ts:149](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L149) *** @@ -805,7 +805,7 @@ Retrieves continuation data as it is. #### Defined in -[src/parser/youtube/Channel.ts:164](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L164) +[src/parser/youtube/Channel.ts:164](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L164) *** @@ -819,7 +819,7 @@ Retrieves continuation data as it is. #### Defined in -[src/parser/youtube/Channel.ts:179](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L179) +[src/parser/youtube/Channel.ts:179](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L179) *** @@ -833,7 +833,7 @@ Retrieves continuation data as it is. #### Defined in -[src/parser/youtube/Channel.ts:174](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L174) +[src/parser/youtube/Channel.ts:174](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L174) *** @@ -847,7 +847,7 @@ Retrieves continuation data as it is. #### Defined in -[src/parser/youtube/Channel.ts:169](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L169) +[src/parser/youtube/Channel.ts:169](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L169) *** @@ -871,7 +871,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -885,7 +885,7 @@ Finds shelf by title. #### Defined in -[src/parser/youtube/Channel.ts:159](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L159) +[src/parser/youtube/Channel.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L159) *** @@ -907,7 +907,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/TabbedFeed.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L23) +[src/core/mixins/TabbedFeed.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L23) *** @@ -929,7 +929,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/TabbedFeed.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L37) +[src/core/mixins/TabbedFeed.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L37) *** @@ -943,7 +943,7 @@ Finds shelf by title. #### Defined in -[src/parser/youtube/Channel.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L154) +[src/parser/youtube/Channel.ts:154](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L154) *** @@ -965,7 +965,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/TabbedFeed.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/TabbedFeed.ts#L51) +[src/core/mixins/TabbedFeed.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/TabbedFeed.ts#L51) *** @@ -985,7 +985,7 @@ Searches within the channel. #### Defined in -[src/parser/youtube/Channel.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L230) +[src/parser/youtube/Channel.ts:230](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L230) *** @@ -1009,7 +1009,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -1033,4 +1033,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/ChannelListContinuation.md b/docs/api/namespaces/YT/classes/ChannelListContinuation.md index 2723548c..adbf9c7c 100644 --- a/docs/api/namespaces/YT/classes/ChannelListContinuation.md +++ b/docs/api/namespaces/YT/classes/ChannelListContinuation.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:298](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L298) +[src/parser/youtube/Channel.ts:298](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L298) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:296](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L296) +[src/parser/youtube/Channel.ts:296](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L296) ## Accessors @@ -58,7 +58,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -78,7 +78,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -98,7 +98,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -116,7 +116,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -136,19 +136,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -156,7 +156,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -176,19 +176,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -196,7 +196,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -216,7 +216,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -236,7 +236,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -256,7 +256,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -276,7 +276,7 @@ Retrieves list continuation. #### Defined in -[src/parser/youtube/Channel.ts:308](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L308) +[src/parser/youtube/Channel.ts:308](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L308) *** @@ -296,7 +296,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -320,7 +320,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -344,7 +344,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -368,4 +368,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/Comments.md b/docs/api/namespaces/YT/classes/Comments.md index 24b2372f..b40e447c 100644 --- a/docs/api/namespaces/YT/classes/Comments.md +++ b/docs/api/namespaces/YT/classes/Comments.md @@ -22,7 +22,7 @@ #### Defined in -[src/parser/youtube/Comments.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L22) +[src/parser/youtube/Comments.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L22) ## Properties @@ -32,7 +32,7 @@ #### Defined in -[src/parser/youtube/Comments.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L20) +[src/parser/youtube/Comments.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L20) *** @@ -42,7 +42,7 @@ #### Defined in -[src/parser/youtube/Comments.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L19) +[src/parser/youtube/Comments.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L19) ## Accessors @@ -56,7 +56,7 @@ #### Defined in -[src/parser/youtube/Comments.ts:117](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L117) +[src/parser/youtube/Comments.ts:117](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L117) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/youtube/Comments.ts:121](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L121) +[src/parser/youtube/Comments.ts:121](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L121) ## Methods @@ -92,7 +92,7 @@ Sort type. #### Defined in -[src/parser/youtube/Comments.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L51) +[src/parser/youtube/Comments.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L51) *** @@ -114,7 +114,7 @@ Comment text. #### Defined in -[src/parser/youtube/Comments.ts:78](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L78) +[src/parser/youtube/Comments.ts:78](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L78) *** @@ -130,4 +130,4 @@ Retrieves next batch of comments. #### Defined in -[src/parser/youtube/Comments.ts:98](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Comments.ts#L98) +[src/parser/youtube/Comments.ts:98](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Comments.ts#L98) diff --git a/docs/api/namespaces/YT/classes/FilteredChannelList.md b/docs/api/namespaces/YT/classes/FilteredChannelList.md index 40390c2b..8ce38eba 100644 --- a/docs/api/namespaces/YT/classes/FilteredChannelList.md +++ b/docs/api/namespaces/YT/classes/FilteredChannelList.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:320](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L320) +[src/parser/youtube/Channel.ts:320](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L320) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:317](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L317) +[src/parser/youtube/Channel.ts:317](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L317) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/youtube/Channel.ts:318](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L318) +[src/parser/youtube/Channel.ts:318](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L318) ## Accessors @@ -68,7 +68,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -88,7 +88,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -108,7 +108,7 @@ Returns the filter chips. #### Defined in -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L20) +[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L20) *** @@ -128,7 +128,7 @@ Returns available filters. #### Defined in -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L38) +[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L38) *** @@ -148,7 +148,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -166,7 +166,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -186,19 +186,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -206,7 +206,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -226,19 +226,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -246,7 +246,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -266,7 +266,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -286,7 +286,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -306,7 +306,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -328,7 +328,7 @@ The filter to apply #### Defined in -[src/parser/youtube/Channel.ts:340](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L340) +[src/parser/youtube/Channel.ts:340](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L340) *** @@ -348,7 +348,7 @@ Retrieves list continuation. #### Defined in -[src/parser/youtube/Channel.ts:348](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Channel.ts#L348) +[src/parser/youtube/Channel.ts:348](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Channel.ts#L348) *** @@ -368,7 +368,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -392,7 +392,7 @@ Applies given filter and returns a new [Feed](../../Mixins/classes/Feed.md) obje #### Defined in -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L45) +[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L45) *** @@ -416,7 +416,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -440,7 +440,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -464,4 +464,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/Guide.md b/docs/api/namespaces/YT/classes/Guide.md index 948e00f1..9228da8d 100644 --- a/docs/api/namespaces/YT/classes/Guide.md +++ b/docs/api/namespaces/YT/classes/Guide.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/youtube/Guide.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Guide.ts#L13) +[src/parser/youtube/Guide.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Guide.ts#L13) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/youtube/Guide.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Guide.ts#L11) +[src/parser/youtube/Guide.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Guide.ts#L11) ## Accessors @@ -42,4 +42,4 @@ #### Defined in -[src/parser/youtube/Guide.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Guide.ts#L19) +[src/parser/youtube/Guide.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Guide.ts#L19) diff --git a/docs/api/namespaces/YT/classes/HashtagFeed.md b/docs/api/namespaces/YT/classes/HashtagFeed.md index f73e70cc..11baa897 100644 --- a/docs/api/namespaces/YT/classes/HashtagFeed.md +++ b/docs/api/namespaces/YT/classes/HashtagFeed.md @@ -28,7 +28,7 @@ #### Defined in -[src/parser/youtube/HashtagFeed.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HashtagFeed.ts#L16) +[src/parser/youtube/HashtagFeed.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HashtagFeed.ts#L16) ## Properties @@ -38,7 +38,7 @@ #### Defined in -[src/parser/youtube/HashtagFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HashtagFeed.ts#L14) +[src/parser/youtube/HashtagFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HashtagFeed.ts#L14) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/youtube/HashtagFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HashtagFeed.ts#L13) +[src/parser/youtube/HashtagFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HashtagFeed.ts#L13) ## Accessors @@ -66,7 +66,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -86,7 +86,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -106,7 +106,7 @@ Returns the filter chips. #### Defined in -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L20) +[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L20) *** @@ -126,7 +126,7 @@ Returns available filters. #### Defined in -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L38) +[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L38) *** @@ -146,7 +146,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -164,7 +164,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -184,19 +184,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -204,7 +204,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -224,19 +224,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -244,7 +244,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -264,7 +264,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -284,7 +284,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -304,7 +304,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -326,7 +326,7 @@ Filter to apply. #### Defined in -[src/parser/youtube/HashtagFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HashtagFeed.ts#L38) +[src/parser/youtube/HashtagFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HashtagFeed.ts#L38) *** @@ -346,7 +346,7 @@ Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/F #### Defined in -[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L220) +[src/core/mixins/Feed.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L216) *** @@ -366,7 +366,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -390,7 +390,7 @@ Applies given filter and returns a new [Feed](../../Mixins/classes/Feed.md) obje #### Defined in -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L45) +[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L45) *** @@ -414,7 +414,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -438,7 +438,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -462,4 +462,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/History.md b/docs/api/namespaces/YT/classes/History.md index a5a932fc..33522384 100644 --- a/docs/api/namespaces/YT/classes/History.md +++ b/docs/api/namespaces/YT/classes/History.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/History.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/History.ts#L13) +[src/parser/youtube/History.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/History.ts#L15) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/History.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/History.ts#L11) +[src/parser/youtube/History.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/History.ts#L13) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/youtube/History.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/History.ts#L10) +[src/parser/youtube/History.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/History.ts#L12) ## Accessors @@ -68,7 +68,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -88,7 +88,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -108,7 +108,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -126,7 +126,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -146,19 +146,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -166,7 +166,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -186,19 +186,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -206,7 +206,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -226,7 +226,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -246,7 +246,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -266,7 +266,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -286,7 +286,7 @@ Retrieves next batch of contents. #### Defined in -[src/parser/youtube/History.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/History.ts#L22) +[src/parser/youtube/History.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/History.ts#L24) *** @@ -306,7 +306,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -330,7 +330,27 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) + +*** + +### 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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/History.ts#L34) *** @@ -354,7 +374,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -378,4 +398,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/HomeFeed.md b/docs/api/namespaces/YT/classes/HomeFeed.md index 8ab7ea10..f3f88e0d 100644 --- a/docs/api/namespaces/YT/classes/HomeFeed.md +++ b/docs/api/namespaces/YT/classes/HomeFeed.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/HomeFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HomeFeed.ts#L14) +[src/parser/youtube/HomeFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HomeFeed.ts#L14) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/HomeFeed.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HomeFeed.ts#L11) +[src/parser/youtube/HomeFeed.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HomeFeed.ts#L11) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/youtube/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HomeFeed.ts#L12) +[src/parser/youtube/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HomeFeed.ts#L12) ## Accessors @@ -68,7 +68,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -88,7 +88,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -108,7 +108,7 @@ Returns the filter chips. #### Defined in -[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L20) +[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L20) *** @@ -128,7 +128,7 @@ Returns available filters. #### Defined in -[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L38) +[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L38) *** @@ -148,7 +148,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -166,7 +166,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -186,19 +186,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -206,7 +206,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -226,19 +226,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -246,7 +246,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -266,7 +266,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -286,7 +286,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -306,7 +306,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -328,7 +328,7 @@ Filter to apply. #### Defined in -[src/parser/youtube/HomeFeed.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HomeFeed.ts#L24) +[src/parser/youtube/HomeFeed.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HomeFeed.ts#L24) *** @@ -348,7 +348,7 @@ Retrieves next batch of contents. #### Defined in -[src/parser/youtube/HomeFeed.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/HomeFeed.ts#L32) +[src/parser/youtube/HomeFeed.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/HomeFeed.ts#L32) *** @@ -368,7 +368,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -392,7 +392,7 @@ Applies given filter and returns a new [Feed](../../Mixins/classes/Feed.md) obje #### Defined in -[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/FilterableFeed.ts#L45) +[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/FilterableFeed.ts#L45) *** @@ -416,7 +416,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -440,7 +440,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -464,4 +464,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/ItemMenu.md b/docs/api/namespaces/YT/classes/ItemMenu.md index 3e1f6b4c..82336389 100644 --- a/docs/api/namespaces/YT/classes/ItemMenu.md +++ b/docs/api/namespaces/YT/classes/ItemMenu.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/youtube/ItemMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/ItemMenu.ts#L16) +[src/parser/youtube/ItemMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/ItemMenu.ts#L16) ## Methods @@ -34,7 +34,7 @@ #### Defined in -[src/parser/youtube/ItemMenu.ts:61](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/ItemMenu.ts#L61) +[src/parser/youtube/ItemMenu.ts:61](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/ItemMenu.ts#L61) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/youtube/ItemMenu.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/ItemMenu.ts#L65) +[src/parser/youtube/ItemMenu.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/ItemMenu.ts#L65) *** @@ -68,7 +68,7 @@ ##### Defined in -[src/parser/youtube/ItemMenu.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/ItemMenu.ts#L28) +[src/parser/youtube/ItemMenu.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/ItemMenu.ts#L28) #### selectItem(button) @@ -84,4 +84,4 @@ ##### Defined in -[src/parser/youtube/ItemMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/ItemMenu.ts#L29) +[src/parser/youtube/ItemMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/ItemMenu.ts#L29) diff --git a/docs/api/namespaces/YT/classes/Library.md b/docs/api/namespaces/YT/classes/Library.md index 2a829cd2..7db5ff91 100644 --- a/docs/api/namespaces/YT/classes/Library.md +++ b/docs/api/namespaces/YT/classes/Library.md @@ -28,7 +28,7 @@ #### Defined in -[src/parser/youtube/Library.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L17) +[src/parser/youtube/Library.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L17) ## Properties @@ -38,7 +38,7 @@ #### Defined in -[src/parser/youtube/Library.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L14) +[src/parser/youtube/Library.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L14) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/youtube/Library.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L15) +[src/parser/youtube/Library.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L15) ## Accessors @@ -66,7 +66,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -86,7 +86,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -100,7 +100,7 @@ Get all the channels in the feed #### Defined in -[src/parser/youtube/Library.ts:75](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L75) +[src/parser/youtube/Library.ts:76](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L76) *** @@ -120,7 +120,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -134,7 +134,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Library.ts:59](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L59) +[src/parser/youtube/Library.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L60) *** @@ -148,7 +148,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Library.ts:67](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L67) +[src/parser/youtube/Library.ts:68](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L68) *** @@ -166,7 +166,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -186,19 +186,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -206,7 +206,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -226,7 +226,7 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** @@ -240,19 +240,19 @@ Get all playlists in the feed #### Defined in -[src/parser/youtube/Library.ts:71](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L71) +[src/parser/youtube/Library.ts:72](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L72) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -260,7 +260,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -280,7 +280,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -300,7 +300,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -320,7 +320,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) *** @@ -334,7 +334,7 @@ Get all the videos in the feed #### Defined in -[src/parser/youtube/Library.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Library.ts#L63) +[src/parser/youtube/Library.ts:64](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Library.ts#L64) ## Methods @@ -354,7 +354,7 @@ Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/F #### Defined in -[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L220) +[src/core/mixins/Feed.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L216) *** @@ -374,7 +374,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -398,7 +398,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -422,7 +422,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -446,4 +446,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/LiveChat.md b/docs/api/namespaces/YT/classes/LiveChat.md index dd97f658..df6533a6 100644 --- a/docs/api/namespaces/YT/classes/LiveChat.md +++ b/docs/api/namespaces/YT/classes/LiveChat.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/youtube/LiveChat.ts:71](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L71) +[src/parser/youtube/LiveChat.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L71) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/youtube/LiveChat.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L65) +[src/parser/youtube/LiveChat.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L65) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/youtube/LiveChat.ts:69](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L69) +[src/parser/youtube/LiveChat.ts:69](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L69) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/youtube/LiveChat.ts:66](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L66) +[src/parser/youtube/LiveChat.ts:66](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L66) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/youtube/LiveChat.ts:68](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L68) +[src/parser/youtube/LiveChat.ts:68](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L68) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/youtube/LiveChat.ts:56](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L56) +[src/parser/youtube/LiveChat.ts:56](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L56) ## Methods @@ -118,7 +118,7 @@ The event listener is appended to target's event listener list and is not append #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8303 +node\_modules/typescript/lib/lib.dom.d.ts:8256 *** @@ -140,7 +140,7 @@ Filter to apply. #### Defined in -[src/parser/youtube/LiveChat.ts:285](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L285) +[src/parser/youtube/LiveChat.ts:285](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L285) *** @@ -166,7 +166,7 @@ Dispatches a synthetic event event to target and returns true if either event's #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8309 +node\_modules/typescript/lib/lib.dom.d.ts:8262 *** @@ -190,7 +190,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8 #### Defined in -[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L10) +[src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L10) *** @@ -210,7 +210,7 @@ Retrieves given chat item's menu. #### Defined in -[src/parser/youtube/LiveChat.ts:303](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L303) +[src/parser/youtube/LiveChat.ts:303](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L303) *** @@ -234,7 +234,7 @@ Retrieves given chat item's menu. #### Defined in -[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/utils/EventEmitterLike.ts#L40) +[src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/utils/EventEmitterLike.ts#L40) *** @@ -260,7 +260,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:106](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L106) +[src/parser/youtube/LiveChat.ts:106](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L106) #### on(type, listener) @@ -282,7 +282,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:107](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L107) +[src/parser/youtube/LiveChat.ts:107](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L107) #### on(type, listener) @@ -304,7 +304,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:108](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L108) +[src/parser/youtube/LiveChat.ts:108](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L108) #### on(type, listener) @@ -326,7 +326,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:109](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L109) +[src/parser/youtube/LiveChat.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L109) #### on(type, listener) @@ -348,7 +348,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:110](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L110) +[src/parser/youtube/LiveChat.ts:110](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L110) *** @@ -374,7 +374,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L115) +[src/parser/youtube/LiveChat.ts:115](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L115) #### once(type, listener) @@ -396,7 +396,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:116](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L116) +[src/parser/youtube/LiveChat.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L116) #### once(type, listener) @@ -418,7 +418,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:117](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L117) +[src/parser/youtube/LiveChat.ts:117](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L117) #### once(type, listener) @@ -440,7 +440,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L118) +[src/parser/youtube/LiveChat.ts:118](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L118) #### once(type, listener) @@ -462,7 +462,7 @@ Retrieves given chat item's menu. ##### Defined in -[src/parser/youtube/LiveChat.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L119) +[src/parser/youtube/LiveChat.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L119) *** @@ -492,7 +492,7 @@ Removes the event listener in target's event listener list with the same type, c #### Defined in -node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.dom.d.ts:8315 +node\_modules/typescript/lib/lib.dom.d.ts:8268 *** @@ -512,7 +512,7 @@ Equivalent to "clicking" a button. #### Defined in -[src/parser/youtube/LiveChat.ts:318](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L318) +[src/parser/youtube/LiveChat.ts:318](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L318) *** @@ -534,7 +534,7 @@ Text to send. #### Defined in -[src/parser/youtube/LiveChat.ts:253](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L253) +[src/parser/youtube/LiveChat.ts:253](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L253) *** @@ -548,7 +548,7 @@ Text to send. #### Defined in -[src/parser/youtube/LiveChat.ts:124](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L124) +[src/parser/youtube/LiveChat.ts:124](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L124) *** @@ -562,4 +562,4 @@ Text to send. #### Defined in -[src/parser/youtube/LiveChat.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/LiveChat.ts#L132) +[src/parser/youtube/LiveChat.ts:132](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/LiveChat.ts#L132) diff --git a/docs/api/namespaces/YT/classes/NotificationsMenu.md b/docs/api/namespaces/YT/classes/NotificationsMenu.md index f0d5bbb3..921c570c 100644 --- a/docs/api/namespaces/YT/classes/NotificationsMenu.md +++ b/docs/api/namespaces/YT/classes/NotificationsMenu.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/youtube/NotificationsMenu.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/NotificationsMenu.ts#L18) +[src/parser/youtube/NotificationsMenu.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/NotificationsMenu.ts#L18) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/NotificationsMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/NotificationsMenu.ts#L16) +[src/parser/youtube/NotificationsMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/NotificationsMenu.ts#L16) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/NotificationsMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/NotificationsMenu.ts#L15) +[src/parser/youtube/NotificationsMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/NotificationsMenu.ts#L15) ## Accessors @@ -54,7 +54,7 @@ #### Defined in -[src/parser/youtube/NotificationsMenu.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/NotificationsMenu.ts#L40) +[src/parser/youtube/NotificationsMenu.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/NotificationsMenu.ts#L40) ## Methods @@ -68,4 +68,4 @@ #### Defined in -[src/parser/youtube/NotificationsMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/NotificationsMenu.ts#L29) +[src/parser/youtube/NotificationsMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/NotificationsMenu.ts#L29) diff --git a/docs/api/namespaces/YT/classes/Playlist.md b/docs/api/namespaces/YT/classes/Playlist.md index 9ff217e1..042bf815 100644 --- a/docs/api/namespaces/YT/classes/Playlist.md +++ b/docs/api/namespaces/YT/classes/Playlist.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/Playlist.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L31) +[src/parser/youtube/Playlist.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L31) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/Playlist.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L28) +[src/parser/youtube/Playlist.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L28) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/youtube/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L26) +[src/parser/youtube/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L26) *** @@ -112,7 +112,7 @@ #### Defined in -[src/parser/youtube/Playlist.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L27) +[src/parser/youtube/Playlist.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L27) *** @@ -122,7 +122,7 @@ #### Defined in -[src/parser/youtube/Playlist.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L29) +[src/parser/youtube/Playlist.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L29) ## Accessors @@ -140,7 +140,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -160,7 +160,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -180,7 +180,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Playlist.ts:75](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L75) +[src/parser/youtube/Playlist.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L75) *** @@ -194,7 +194,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/youtube/Playlist.ts:71](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L71) +[src/parser/youtube/Playlist.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L71) *** @@ -212,7 +212,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -232,19 +232,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -252,7 +252,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -272,19 +272,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -292,7 +292,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -312,7 +312,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -332,7 +332,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -352,7 +352,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -372,7 +372,7 @@ Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/F #### Defined in -[src/parser/youtube/Playlist.ts:105](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L105) +[src/parser/youtube/Playlist.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L105) *** @@ -392,7 +392,7 @@ Retrieves continuation data as it is. #### Defined in -[src/parser/youtube/Playlist.ts:84](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Playlist.ts#L84) +[src/parser/youtube/Playlist.ts:84](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Playlist.ts#L84) *** @@ -416,7 +416,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -440,7 +440,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -464,4 +464,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/Search.md b/docs/api/namespaces/YT/classes/Search.md index ce28c2d2..fb8a9811 100644 --- a/docs/api/namespaces/YT/classes/Search.md +++ b/docs/api/namespaces/YT/classes/Search.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L26) +[src/parser/youtube/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L26) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/Search.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L21) +[src/parser/youtube/Search.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L21) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/youtube/Search.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L18) +[src/parser/youtube/Search.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L18) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/youtube/Search.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L24) +[src/parser/youtube/Search.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L24) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/youtube/Search.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L20) +[src/parser/youtube/Search.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L20) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/youtube/Search.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L19) +[src/parser/youtube/Search.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L19) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/youtube/Search.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L22) +[src/parser/youtube/Search.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L22) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/youtube/Search.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L23) +[src/parser/youtube/Search.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L23) ## Accessors @@ -118,7 +118,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -138,7 +138,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -158,7 +158,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -176,7 +176,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -196,19 +196,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -216,7 +216,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -236,19 +236,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -256,7 +256,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -272,7 +272,7 @@ Returns a list of refinement card queries. #### Defined in -[src/parser/youtube/Search.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L77) +[src/parser/youtube/Search.ts:77](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L77) *** @@ -292,7 +292,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -312,7 +312,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -332,7 +332,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -352,7 +352,7 @@ Retrieves next batch of results. #### Defined in -[src/parser/youtube/Search.ts:84](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L84) +[src/parser/youtube/Search.ts:84](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L84) *** @@ -372,7 +372,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -396,7 +396,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -416,7 +416,7 @@ Applies given refinement card and returns a new [Search](Search.md) object. Use #### Defined in -[src/parser/youtube/Search.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Search.ts#L55) +[src/parser/youtube/Search.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Search.ts#L55) *** @@ -440,7 +440,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -464,4 +464,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YT/classes/Settings.md b/docs/api/namespaces/YT/classes/Settings.md index f9de9f9f..fdd925d4 100644 --- a/docs/api/namespaces/YT/classes/Settings.md +++ b/docs/api/namespaces/YT/classes/Settings.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/youtube/Settings.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L28) +[src/parser/youtube/Settings.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L28) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/Settings.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L25) +[src/parser/youtube/Settings.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L25) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/youtube/Settings.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L26) +[src/parser/youtube/Settings.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L26) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/youtube/Settings.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L24) +[src/parser/youtube/Settings.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L24) ## Accessors @@ -64,7 +64,7 @@ #### Defined in -[src/parser/youtube/Settings.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L132) +[src/parser/youtube/Settings.ts:132](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L132) *** @@ -80,7 +80,7 @@ Returns settings available in the page. #### Defined in -[src/parser/youtube/Settings.ts:105](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L105) +[src/parser/youtube/Settings.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L105) *** @@ -96,7 +96,7 @@ Returns options available in the sidebar. #### Defined in -[src/parser/youtube/Settings.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L125) +[src/parser/youtube/Settings.ts:125](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L125) ## Methods @@ -116,7 +116,7 @@ Finds a setting by name and returns it. Use [setting_options](Settings.md#settin #### Defined in -[src/parser/youtube/Settings.ts:79](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L79) +[src/parser/youtube/Settings.ts:79](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L79) *** @@ -136,4 +136,4 @@ Selects an item from the sidebar menu. Use [sidebar_items](Settings.md#sidebar_i #### Defined in -[src/parser/youtube/Settings.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/Settings.ts#L55) +[src/parser/youtube/Settings.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/Settings.ts#L55) diff --git a/docs/api/namespaces/YT/classes/SmoothedQueue.md b/docs/api/namespaces/YT/classes/SmoothedQueue.md index 8ad34075..d961312c 100644 --- a/docs/api/namespaces/YT/classes/SmoothedQueue.md +++ b/docs/api/namespaces/YT/classes/SmoothedQueue.md @@ -14,7 +14,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:54](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L54) +[src/parser/youtube/SmoothedQueue.ts:54](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L54) ## Accessors @@ -28,7 +28,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:140](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L140) +[src/parser/youtube/SmoothedQueue.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L140) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L136) +[src/parser/youtube/SmoothedQueue.ts:136](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L136) *** @@ -62,7 +62,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:144](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L144) +[src/parser/youtube/SmoothedQueue.ts:144](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L144) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:148](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L148) +[src/parser/youtube/SmoothedQueue.ts:148](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L148) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:152](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L152) +[src/parser/youtube/SmoothedQueue.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L152) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:156](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L156) +[src/parser/youtube/SmoothedQueue.ts:156](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L156) ## Methods @@ -118,7 +118,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:124](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L124) +[src/parser/youtube/SmoothedQueue.ts:124](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L124) *** @@ -132,7 +132,7 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L91) +[src/parser/youtube/SmoothedQueue.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L91) *** @@ -150,4 +150,4 @@ #### Defined in -[src/parser/youtube/SmoothedQueue.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/SmoothedQueue.ts#L63) +[src/parser/youtube/SmoothedQueue.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/SmoothedQueue.ts#L63) diff --git a/docs/api/namespaces/YT/classes/TimeWatched.md b/docs/api/namespaces/YT/classes/TimeWatched.md index 7948d2ba..b8d55067 100644 --- a/docs/api/namespaces/YT/classes/TimeWatched.md +++ b/docs/api/namespaces/YT/classes/TimeWatched.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/youtube/TimeWatched.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TimeWatched.ts#L15) +[src/parser/youtube/TimeWatched.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TimeWatched.ts#L15) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/youtube/TimeWatched.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TimeWatched.ts#L13) +[src/parser/youtube/TimeWatched.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TimeWatched.ts#L13) ## Accessors @@ -42,4 +42,4 @@ #### Defined in -[src/parser/youtube/TimeWatched.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TimeWatched.ts#L29) +[src/parser/youtube/TimeWatched.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TimeWatched.ts#L29) diff --git a/docs/api/namespaces/YT/classes/TranscriptInfo.md b/docs/api/namespaces/YT/classes/TranscriptInfo.md index bed53079..946f2aa9 100644 --- a/docs/api/namespaces/YT/classes/TranscriptInfo.md +++ b/docs/api/namespaces/YT/classes/TranscriptInfo.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/youtube/TranscriptInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TranscriptInfo.ts#L12) +[src/parser/youtube/TranscriptInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TranscriptInfo.ts#L12) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/youtube/TranscriptInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TranscriptInfo.ts#L10) +[src/parser/youtube/TranscriptInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TranscriptInfo.ts#L10) ## Accessors @@ -46,7 +46,7 @@ Returns available languages. #### Defined in -[src/parser/youtube/TranscriptInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TranscriptInfo.ts#L45) +[src/parser/youtube/TranscriptInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TranscriptInfo.ts#L45) *** @@ -60,7 +60,7 @@ Returns available languages. #### Defined in -[src/parser/youtube/TranscriptInfo.ts:56](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TranscriptInfo.ts#L56) +[src/parser/youtube/TranscriptInfo.ts:56](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TranscriptInfo.ts#L56) *** @@ -76,7 +76,7 @@ Returns the currently selected language. #### Defined in -[src/parser/youtube/TranscriptInfo.ts:52](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TranscriptInfo.ts#L52) +[src/parser/youtube/TranscriptInfo.ts:52](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TranscriptInfo.ts#L52) ## Methods @@ -98,4 +98,4 @@ Language to select. #### Defined in -[src/parser/youtube/TranscriptInfo.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/TranscriptInfo.ts#L26) +[src/parser/youtube/TranscriptInfo.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/TranscriptInfo.ts#L26) diff --git a/docs/api/namespaces/YT/classes/VideoInfo.md b/docs/api/namespaces/YT/classes/VideoInfo.md index e2123bc0..545fcd70 100644 --- a/docs/api/namespaces/YT/classes/VideoInfo.md +++ b/docs/api/namespaces/YT/classes/VideoInfo.md @@ -36,7 +36,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:51](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L51) +[src/parser/youtube/VideoInfo.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L51) ## Properties @@ -50,7 +50,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L31) +[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L39) *** @@ -72,7 +72,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L44) +[src/parser/youtube/VideoInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L44) *** @@ -218,7 +218,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L30) +[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L38) *** @@ -232,7 +232,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L34) +[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L42) *** @@ -246,7 +246,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L35) +[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L43) *** @@ -256,7 +256,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L42) +[src/parser/youtube/VideoInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L42) *** @@ -270,7 +270,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L33) +[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L41) *** @@ -288,7 +288,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L37) +[src/parser/youtube/VideoInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L37) *** @@ -298,7 +298,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L43) +[src/parser/youtube/VideoInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L43) *** @@ -308,7 +308,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L38) +[src/parser/youtube/VideoInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L38) *** @@ -322,7 +322,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L37) +[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L45) *** @@ -336,7 +336,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L38) +[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L46) *** @@ -346,7 +346,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L41) +[src/parser/youtube/VideoInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L41) *** @@ -384,7 +384,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L36) +[src/parser/youtube/VideoInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L36) *** @@ -394,7 +394,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L34) +[src/parser/youtube/VideoInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L34) *** @@ -404,7 +404,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L39) +[src/parser/youtube/VideoInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L39) *** @@ -414,13 +414,13 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L35) +[src/parser/youtube/VideoInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L35) *** ### storyboards? -> `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) +> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) #### Inherited from @@ -428,7 +428,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L32) +[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L40) *** @@ -442,7 +442,7 @@ Client Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L36) +[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L44) *** @@ -452,7 +452,7 @@ Client Playback Nonce. #### Defined in -[src/parser/youtube/VideoInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L40) +[src/parser/youtube/VideoInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L40) ## Accessors @@ -460,8 +460,6 @@ Client Playback Nonce. > `get` **actions**(): [`Actions`](../../../classes/Actions.md) -Actions instance. - #### Returns [`Actions`](../../../classes/Actions.md) @@ -472,7 +470,7 @@ Actions instance. #### Defined in -[src/core/mixins/MediaInfo.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L223) +[src/core/mixins/MediaInfo.ts:226](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L226) *** @@ -488,7 +486,7 @@ Gets the endpoint of the autoplay video #### Defined in -[src/parser/youtube/VideoInfo.ts:379](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L379) +[src/parser/youtube/VideoInfo.ts:379](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L379) *** @@ -508,7 +506,7 @@ Content Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L230) +[src/core/mixins/MediaInfo.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L233) *** @@ -524,7 +522,7 @@ Watch next feed filters. #### Defined in -[src/parser/youtube/VideoInfo.ts:365](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L365) +[src/parser/youtube/VideoInfo.ts:365](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L365) *** @@ -540,7 +538,7 @@ Checks if trailer is available. #### Defined in -[src/parser/youtube/VideoInfo.ts:386](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L386) +[src/parser/youtube/VideoInfo.ts:386](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L386) *** @@ -556,7 +554,7 @@ Get songs used in the video. #### Defined in -[src/parser/youtube/VideoInfo.ts:393](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L393) +[src/parser/youtube/VideoInfo.ts:393](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L393) *** @@ -564,7 +562,7 @@ Get songs used in the video. > `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] -Original parsed InnerTube response. +Parsed InnerTube response. #### Returns @@ -576,7 +574,7 @@ Original parsed InnerTube response. #### Defined in -[src/core/mixins/MediaInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L237) +[src/core/mixins/MediaInfo.ts:240](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L240) *** @@ -592,7 +590,7 @@ Checks if continuation is available for the watch next feed. #### Defined in -[src/parser/youtube/VideoInfo.ts:372](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L372) +[src/parser/youtube/VideoInfo.ts:372](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L372) ## Methods @@ -612,7 +610,7 @@ Adds video to the watch history. #### Defined in -[src/parser/youtube/VideoInfo.ts:174](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L174) +[src/parser/youtube/VideoInfo.ts:174](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L174) *** @@ -638,7 +636,7 @@ Options #### Defined in -[src/core/mixins/MediaInfo.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L149) +[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L157) *** @@ -654,7 +652,7 @@ Dislikes the video. #### Defined in -[src/parser/youtube/VideoInfo.ts:245](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L245) +[src/parser/youtube/VideoInfo.ts:245](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L245) *** @@ -680,7 +678,7 @@ Download options. #### Defined in -[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L157) +[src/core/mixins/MediaInfo.ts:165](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L165) *** @@ -696,7 +694,7 @@ Retrieves Live Chat if available. #### Defined in -[src/parser/youtube/VideoInfo.ts:342](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L342) +[src/parser/youtube/VideoInfo.ts:342](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L342) *** @@ -722,7 +720,7 @@ Get a cleaned up representation of the adaptive_formats #### Defined in -[src/core/mixins/MediaInfo.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L132) +[src/core/mixins/MediaInfo.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L140) *** @@ -740,7 +738,7 @@ Retrieves trailer info if available (typically for non-purchased movies or films #### Defined in -[src/parser/youtube/VideoInfo.ts:352](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L352) +[src/parser/youtube/VideoInfo.ts:352](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L352) *** @@ -760,7 +758,7 @@ Retrieves the video's transcript. #### Defined in -[src/core/mixins/MediaInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L170) +[src/core/mixins/MediaInfo.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L178) *** @@ -776,7 +774,7 @@ Retrieves watch next feed continuation. #### Defined in -[src/parser/youtube/VideoInfo.ts:181](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L181) +[src/parser/youtube/VideoInfo.ts:181](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L181) *** @@ -792,7 +790,7 @@ Likes the video. #### Defined in -[src/parser/youtube/VideoInfo.ts:204](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L204) +[src/parser/youtube/VideoInfo.ts:204](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L204) *** @@ -808,7 +806,7 @@ Removes like/dislike. #### Defined in -[src/parser/youtube/VideoInfo.ts:286](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L286) +[src/parser/youtube/VideoInfo.ts:286](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L286) *** @@ -830,7 +828,7 @@ Filter to apply. #### Defined in -[src/parser/youtube/VideoInfo.ts:142](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/youtube/VideoInfo.ts#L142) +[src/parser/youtube/VideoInfo.ts:142](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/youtube/VideoInfo.ts#L142) *** @@ -866,4 +864,4 @@ DASH manifest #### Defined in -[src/core/mixins/MediaInfo.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L97) +[src/core/mixins/MediaInfo.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L105) diff --git a/docs/api/namespaces/YTKids/classes/Channel.md b/docs/api/namespaces/YTKids/classes/Channel.md index 25f8d379..280c35b2 100644 --- a/docs/api/namespaces/YTKids/classes/Channel.md +++ b/docs/api/namespaces/YTKids/classes/Channel.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytkids/Channel.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Channel.ts#L13) +[src/parser/ytkids/Channel.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Channel.ts#L13) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/ytkids/Channel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Channel.ts#L11) +[src/parser/ytkids/Channel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Channel.ts#L11) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/ytkids/Channel.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Channel.ts#L10) +[src/parser/ytkids/Channel.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Channel.ts#L10) ## Accessors @@ -68,7 +68,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -88,7 +88,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -108,7 +108,7 @@ Checks if the feed has continuation. #### Defined in -[src/parser/ytkids/Channel.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Channel.ts#L31) +[src/parser/ytkids/Channel.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Channel.ts#L31) *** @@ -126,7 +126,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -146,19 +146,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -166,7 +166,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -186,19 +186,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -206,7 +206,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -226,7 +226,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -246,7 +246,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -266,7 +266,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -286,7 +286,7 @@ Retrieves next batch of videos. #### Defined in -[src/parser/ytkids/Channel.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Channel.ts#L22) +[src/parser/ytkids/Channel.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Channel.ts#L22) *** @@ -306,7 +306,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -330,7 +330,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -354,7 +354,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -378,4 +378,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YTKids/classes/HomeFeed.md b/docs/api/namespaces/YTKids/classes/HomeFeed.md index ffb2744b..37fa13e7 100644 --- a/docs/api/namespaces/YTKids/classes/HomeFeed.md +++ b/docs/api/namespaces/YTKids/classes/HomeFeed.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytkids/HomeFeed.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/HomeFeed.ts#L15) +[src/parser/ytkids/HomeFeed.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/HomeFeed.ts#L15) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/ytkids/HomeFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/HomeFeed.ts#L13) +[src/parser/ytkids/HomeFeed.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/HomeFeed.ts#L13) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/ytkids/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/HomeFeed.ts#L12) +[src/parser/ytkids/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/HomeFeed.ts#L12) ## Accessors @@ -68,7 +68,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/ytkids/HomeFeed.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/HomeFeed.ts#L46) +[src/parser/ytkids/HomeFeed.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/HomeFeed.ts#L46) *** @@ -102,7 +102,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -122,7 +122,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -140,7 +140,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -160,19 +160,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -180,7 +180,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -200,19 +200,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -220,7 +220,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -240,7 +240,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -260,7 +260,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -280,7 +280,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -300,7 +300,7 @@ Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/F #### Defined in -[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L220) +[src/core/mixins/Feed.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L216) *** @@ -320,7 +320,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -344,7 +344,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -366,7 +366,7 @@ The tab to select #### Defined in -[src/parser/ytkids/HomeFeed.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/HomeFeed.ts#L25) +[src/parser/ytkids/HomeFeed.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/HomeFeed.ts#L25) *** @@ -390,7 +390,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -414,4 +414,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YTKids/classes/Search.md b/docs/api/namespaces/YTKids/classes/Search.md index 4635aa80..00f9d320 100644 --- a/docs/api/namespaces/YTKids/classes/Search.md +++ b/docs/api/namespaces/YTKids/classes/Search.md @@ -28,7 +28,7 @@ #### Defined in -[src/parser/ytkids/Search.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Search.ts#L13) +[src/parser/ytkids/Search.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Search.ts#L13) ## Properties @@ -38,7 +38,7 @@ #### Defined in -[src/parser/ytkids/Search.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Search.ts#L11) +[src/parser/ytkids/Search.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Search.ts#L11) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/ytkids/Search.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/Search.ts#L10) +[src/parser/ytkids/Search.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/Search.ts#L10) ## Accessors @@ -66,7 +66,7 @@ #### Defined in -[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L180) +[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L178) *** @@ -86,7 +86,7 @@ Get all the channels in the feed #### Defined in -[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L125) +[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L123) *** @@ -106,7 +106,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L194) +[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L192) *** @@ -124,7 +124,7 @@ Checks if the feed has continuation. #### Defined in -[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L136) +[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L134) *** @@ -144,19 +144,19 @@ Get the original page data #### Defined in -[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L187) +[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L185) *** ### page\_contents -> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +> `get` **page\_contents**(): [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) Returns contents from the page. #### Returns -[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) +[`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) #### Inherited from @@ -164,7 +164,7 @@ Returns contents from the page. #### Defined in -[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L143) +[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L141) *** @@ -184,19 +184,19 @@ Get all playlists in the feed #### Defined in -[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L132) +[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L130) *** ### posts -> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +> `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) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\> +[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\> #### Inherited from @@ -204,7 +204,7 @@ Get all the community posts in the feed #### Defined in -[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L118) +[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L116) *** @@ -224,7 +224,7 @@ Returns secondary contents from the page. #### Defined in -[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L168) +[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L166) *** @@ -244,7 +244,7 @@ Returns all segments/sections from the page. #### Defined in -[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L154) +[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L152) *** @@ -264,7 +264,7 @@ Get all the videos in the feed #### Defined in -[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L111) +[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L109) ## Methods @@ -284,7 +284,7 @@ Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/F #### Defined in -[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L220) +[src/core/mixins/Feed.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L216) *** @@ -304,7 +304,7 @@ Retrieves continuation data as it is. #### Defined in -[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L201) +[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L199) *** @@ -328,7 +328,7 @@ Finds shelf by title. #### Defined in -[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L161) +[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L159) *** @@ -352,7 +352,7 @@ Get all playlists on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L93) +[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L91) *** @@ -376,4 +376,4 @@ Get all videos on a given page via memo #### Defined in -[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/Feed.ts#L77) +[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/Feed.ts#L75) diff --git a/docs/api/namespaces/YTKids/classes/VideoInfo.md b/docs/api/namespaces/YTKids/classes/VideoInfo.md index 10a36825..6ae1aa2a 100644 --- a/docs/api/namespaces/YTKids/classes/VideoInfo.md +++ b/docs/api/namespaces/YTKids/classes/VideoInfo.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytkids/VideoInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/VideoInfo.ts#L17) +[src/parser/ytkids/VideoInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/VideoInfo.ts#L17) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L31) +[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L39) *** @@ -190,7 +190,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L30) +[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L38) *** @@ -204,7 +204,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L34) +[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L42) *** @@ -218,7 +218,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L35) +[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L43) *** @@ -228,7 +228,7 @@ #### Defined in -[src/parser/ytkids/VideoInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/VideoInfo.ts#L14) +[src/parser/ytkids/VideoInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/VideoInfo.ts#L14) *** @@ -242,7 +242,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L33) +[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L41) *** @@ -256,7 +256,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L37) +[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L45) *** @@ -270,7 +270,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L38) +[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L46) *** @@ -280,7 +280,7 @@ #### Defined in -[src/parser/ytkids/VideoInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/VideoInfo.ts#L15) +[src/parser/ytkids/VideoInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/VideoInfo.ts#L15) *** @@ -290,13 +290,13 @@ #### Defined in -[src/parser/ytkids/VideoInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/VideoInfo.ts#L12) +[src/parser/ytkids/VideoInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/VideoInfo.ts#L12) *** ### storyboards? -> `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) +> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) #### Inherited from @@ -304,7 +304,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L32) +[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L40) *** @@ -318,7 +318,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L36) +[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L44) *** @@ -328,7 +328,7 @@ #### Defined in -[src/parser/ytkids/VideoInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytkids/VideoInfo.ts#L13) +[src/parser/ytkids/VideoInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytkids/VideoInfo.ts#L13) ## Accessors @@ -336,8 +336,6 @@ > `get` **actions**(): [`Actions`](../../../classes/Actions.md) -Actions instance. - #### Returns [`Actions`](../../../classes/Actions.md) @@ -348,7 +346,7 @@ Actions instance. #### Defined in -[src/core/mixins/MediaInfo.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L223) +[src/core/mixins/MediaInfo.ts:226](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L226) *** @@ -368,7 +366,7 @@ Content Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L230) +[src/core/mixins/MediaInfo.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L233) *** @@ -376,7 +374,7 @@ Content Playback Nonce. > `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] -Original parsed InnerTube response. +Parsed InnerTube response. #### Returns @@ -388,7 +386,7 @@ Original parsed InnerTube response. #### Defined in -[src/core/mixins/MediaInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L237) +[src/core/mixins/MediaInfo.ts:240](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L240) ## Methods @@ -416,7 +414,7 @@ Adds video to the watch history. #### Defined in -[src/core/mixins/MediaInfo.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L199) +[src/core/mixins/MediaInfo.ts:207](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L207) *** @@ -442,7 +440,7 @@ Options #### Defined in -[src/core/mixins/MediaInfo.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L149) +[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L157) *** @@ -468,7 +466,7 @@ Download options. #### Defined in -[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L157) +[src/core/mixins/MediaInfo.ts:165](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L165) *** @@ -494,7 +492,7 @@ Get a cleaned up representation of the adaptive_formats #### Defined in -[src/core/mixins/MediaInfo.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L132) +[src/core/mixins/MediaInfo.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L140) *** @@ -514,7 +512,7 @@ Retrieves the video's transcript. #### Defined in -[src/core/mixins/MediaInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L170) +[src/core/mixins/MediaInfo.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L178) *** @@ -550,4 +548,4 @@ DASH manifest #### Defined in -[src/core/mixins/MediaInfo.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L97) +[src/core/mixins/MediaInfo.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L105) diff --git a/docs/api/namespaces/YTMusic/classes/Album.md b/docs/api/namespaces/YTMusic/classes/Album.md index d9931791..43d1a5b6 100644 --- a/docs/api/namespaces/YTMusic/classes/Album.md +++ b/docs/api/namespaces/YTMusic/classes/Album.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/ytmusic/Album.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Album.ts#L24) +[src/parser/ytmusic/Album.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Album.ts#L24) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/ytmusic/Album.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Album.ts#L21) +[src/parser/ytmusic/Album.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Album.ts#L21) *** @@ -38,7 +38,7 @@ #### Defined in -[src/parser/ytmusic/Album.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Album.ts#L19) +[src/parser/ytmusic/Album.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Album.ts#L19) *** @@ -48,7 +48,7 @@ #### Defined in -[src/parser/ytmusic/Album.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Album.ts#L18) +[src/parser/ytmusic/Album.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Album.ts#L18) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/ytmusic/Album.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Album.ts#L20) +[src/parser/ytmusic/Album.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Album.ts#L20) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/ytmusic/Album.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Album.ts#L22) +[src/parser/ytmusic/Album.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Album.ts#L22) ## Accessors @@ -82,4 +82,4 @@ #### Defined in -[src/parser/ytmusic/Album.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Album.ts#L37) +[src/parser/ytmusic/Album.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Album.ts#L37) diff --git a/docs/api/namespaces/YTMusic/classes/Artist.md b/docs/api/namespaces/YTMusic/classes/Artist.md index 5b2a5091..6c05831c 100644 --- a/docs/api/namespaces/YTMusic/classes/Artist.md +++ b/docs/api/namespaces/YTMusic/classes/Artist.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/ytmusic/Artist.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Artist.ts#L23) +[src/parser/ytmusic/Artist.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Artist.ts#L23) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytmusic/Artist.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Artist.ts#L20) +[src/parser/ytmusic/Artist.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Artist.ts#L20) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/ytmusic/Artist.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Artist.ts#L21) +[src/parser/ytmusic/Artist.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Artist.ts#L21) ## Accessors @@ -54,7 +54,7 @@ #### Defined in -[src/parser/ytmusic/Artist.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Artist.ts#L55) +[src/parser/ytmusic/Artist.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Artist.ts#L55) ## Methods @@ -68,4 +68,4 @@ #### Defined in -[src/parser/ytmusic/Artist.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Artist.ts#L35) +[src/parser/ytmusic/Artist.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Artist.ts#L35) diff --git a/docs/api/namespaces/YTMusic/classes/Explore.md b/docs/api/namespaces/YTMusic/classes/Explore.md index 3902cd02..2e7f81d3 100644 --- a/docs/api/namespaces/YTMusic/classes/Explore.md +++ b/docs/api/namespaces/YTMusic/classes/Explore.md @@ -18,7 +18,7 @@ #### Defined in -[src/parser/ytmusic/Explore.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Explore.ts#L20) +[src/parser/ytmusic/Explore.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Explore.ts#L20) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[src/parser/ytmusic/Explore.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Explore.ts#L18) +[src/parser/ytmusic/Explore.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Explore.ts#L18) *** @@ -38,7 +38,7 @@ #### Defined in -[src/parser/ytmusic/Explore.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Explore.ts#L17) +[src/parser/ytmusic/Explore.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Explore.ts#L17) ## Accessors @@ -52,4 +52,4 @@ #### Defined in -[src/parser/ytmusic/Explore.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Explore.ts#L37) +[src/parser/ytmusic/Explore.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Explore.ts#L37) diff --git a/docs/api/namespaces/YTMusic/classes/HomeFeed.md b/docs/api/namespaces/YTMusic/classes/HomeFeed.md index a6c36daa..2152e474 100644 --- a/docs/api/namespaces/YTMusic/classes/HomeFeed.md +++ b/docs/api/namespaces/YTMusic/classes/HomeFeed.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/ytmusic/HomeFeed.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L22) +[src/parser/ytmusic/HomeFeed.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L22) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytmusic/HomeFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L20) +[src/parser/ytmusic/HomeFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L20) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/ytmusic/HomeFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L19) +[src/parser/ytmusic/HomeFeed.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L19) ## Accessors @@ -54,7 +54,7 @@ #### Defined in -[src/parser/ytmusic/HomeFeed.ts:84](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L84) +[src/parser/ytmusic/HomeFeed.ts:84](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L84) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/ytmusic/HomeFeed.ts:88](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L88) +[src/parser/ytmusic/HomeFeed.ts:88](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L88) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/ytmusic/HomeFeed.ts:92](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L92) +[src/parser/ytmusic/HomeFeed.ts:92](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L92) ## Methods @@ -100,7 +100,7 @@ #### Defined in -[src/parser/ytmusic/HomeFeed.ts:61](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L61) +[src/parser/ytmusic/HomeFeed.ts:61](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L61) *** @@ -116,4 +116,4 @@ Retrieves home feed continuation. #### Defined in -[src/parser/ytmusic/HomeFeed.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/HomeFeed.ts#L49) +[src/parser/ytmusic/HomeFeed.ts:49](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/HomeFeed.ts#L49) diff --git a/docs/api/namespaces/YTMusic/classes/Library.md b/docs/api/namespaces/YTMusic/classes/Library.md index ee1a6366..21c57c0b 100644 --- a/docs/api/namespaces/YTMusic/classes/Library.md +++ b/docs/api/namespaces/YTMusic/classes/Library.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L28) +[src/parser/ytmusic/Library.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L28) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L26) +[src/parser/ytmusic/Library.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L26) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L25) +[src/parser/ytmusic/Library.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L25) ## Accessors @@ -54,7 +54,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:141](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L141) +[src/parser/ytmusic/Library.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L141) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:131](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L131) +[src/parser/ytmusic/Library.ts:131](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L131) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:145](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L145) +[src/parser/ytmusic/Library.ts:145](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L145) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:135](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L135) +[src/parser/ytmusic/Library.ts:135](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L135) ## Methods @@ -116,7 +116,7 @@ Applies given filter to the library. #### Defined in -[src/parser/ytmusic/Library.ts:93](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L93) +[src/parser/ytmusic/Library.ts:93](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L93) *** @@ -136,7 +136,7 @@ Applies given sort option to the library items. #### Defined in -[src/parser/ytmusic/Library.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L43) +[src/parser/ytmusic/Library.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L43) *** @@ -152,4 +152,4 @@ Retrieves continuation of the library items. #### Defined in -[src/parser/ytmusic/Library.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L119) +[src/parser/ytmusic/Library.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L119) diff --git a/docs/api/namespaces/YTMusic/classes/LibraryContinuation.md b/docs/api/namespaces/YTMusic/classes/LibraryContinuation.md index 30a102a4..4c14c3a1 100644 --- a/docs/api/namespaces/YTMusic/classes/LibraryContinuation.md +++ b/docs/api/namespaces/YTMusic/classes/LibraryContinuation.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L157) +[src/parser/ytmusic/Library.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L157) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:155](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L155) +[src/parser/ytmusic/Library.ts:155](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L155) ## Accessors @@ -44,7 +44,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:181](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L181) +[src/parser/ytmusic/Library.ts:181](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L181) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/ytmusic/Library.ts:185](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L185) +[src/parser/ytmusic/Library.ts:185](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L185) ## Methods @@ -72,4 +72,4 @@ #### Defined in -[src/parser/ytmusic/Library.ts:169](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Library.ts#L169) +[src/parser/ytmusic/Library.ts:169](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Library.ts#L169) diff --git a/docs/api/namespaces/YTMusic/classes/Playlist.md b/docs/api/namespaces/YTMusic/classes/Playlist.md index c37b9e69..d987bcf9 100644 --- a/docs/api/namespaces/YTMusic/classes/Playlist.md +++ b/docs/api/namespaces/YTMusic/classes/Playlist.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/ytmusic/Playlist.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L29) +[src/parser/ytmusic/Playlist.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L29) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytmusic/Playlist.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L27) +[src/parser/ytmusic/Playlist.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L27) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/ytmusic/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L26) +[src/parser/ytmusic/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L26) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/ytmusic/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L25) +[src/parser/ytmusic/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L25) ## Accessors @@ -64,7 +64,7 @@ #### Defined in -[src/parser/ytmusic/Playlist.ts:148](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L148) +[src/parser/ytmusic/Playlist.ts:148](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L148) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/ytmusic/Playlist.ts:144](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L144) +[src/parser/ytmusic/Playlist.ts:144](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L144) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/ytmusic/Playlist.ts:140](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L140) +[src/parser/ytmusic/Playlist.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L140) ## Methods @@ -108,7 +108,7 @@ Retrieves playlist items continuation. #### Defined in -[src/parser/ytmusic/Playlist.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L55) +[src/parser/ytmusic/Playlist.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L55) *** @@ -124,7 +124,7 @@ Retrieves related playlists #### Defined in -[src/parser/ytmusic/Playlist.ts:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L70) +[src/parser/ytmusic/Playlist.ts:70](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L70) *** @@ -142,4 +142,4 @@ Retrieves related playlists #### Defined in -[src/parser/ytmusic/Playlist.ts:99](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Playlist.ts#L99) +[src/parser/ytmusic/Playlist.ts:99](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Playlist.ts#L99) diff --git a/docs/api/namespaces/YTMusic/classes/Recap.md b/docs/api/namespaces/YTMusic/classes/Recap.md index 6e91ae6a..afe39170 100644 --- a/docs/api/namespaces/YTMusic/classes/Recap.md +++ b/docs/api/namespaces/YTMusic/classes/Recap.md @@ -20,7 +20,7 @@ #### Defined in -[src/parser/ytmusic/Recap.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Recap.ts#L26) +[src/parser/ytmusic/Recap.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Recap.ts#L26) ## Properties @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytmusic/Recap.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Recap.ts#L23) +[src/parser/ytmusic/Recap.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Recap.ts#L23) *** @@ -40,7 +40,7 @@ #### Defined in -[src/parser/ytmusic/Recap.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Recap.ts#L24) +[src/parser/ytmusic/Recap.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Recap.ts#L24) ## Accessors @@ -54,7 +54,7 @@ #### Defined in -[src/parser/ytmusic/Recap.ts:60](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Recap.ts#L60) +[src/parser/ytmusic/Recap.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Recap.ts#L60) ## Methods @@ -70,4 +70,4 @@ Retrieves recap playlist. #### Defined in -[src/parser/ytmusic/Recap.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Recap.ts#L47) +[src/parser/ytmusic/Recap.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Recap.ts#L47) diff --git a/docs/api/namespaces/YTMusic/classes/Search.md b/docs/api/namespaces/YTMusic/classes/Search.md index 86aa0ce0..f5b3e544 100644 --- a/docs/api/namespaces/YTMusic/classes/Search.md +++ b/docs/api/namespaces/YTMusic/classes/Search.md @@ -22,7 +22,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L29) +[src/parser/ytmusic/Search.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L28) ## Properties @@ -32,7 +32,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L27) +[src/parser/ytmusic/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L26) *** @@ -42,7 +42,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L26) +[src/parser/ytmusic/Search.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L25) ## Accessors @@ -56,7 +56,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:138](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L138) +[src/parser/ytmusic/Search.ts:137](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L137) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:142](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L142) +[src/parser/ytmusic/Search.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L141) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:118](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L118) +[src/parser/ytmusic/Search.ts:117](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L117) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:110](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L110) +[src/parser/ytmusic/Search.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L109) *** @@ -112,7 +112,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:114](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L114) +[src/parser/ytmusic/Search.ts:113](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L113) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:126](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L126) +[src/parser/ytmusic/Search.ts:125](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L125) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:164](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L164) +[src/parser/ytmusic/Search.ts:149](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L149) *** @@ -154,43 +154,7 @@ #### Defined in -[src/parser/ytmusic/Search.ts:146](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L146) - -*** - -### results - -> `get` **results**(): `undefined` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\> - -#### Deprecated - -Use [Search.contents](Search.md#contents) instead. - -#### Returns - -`undefined` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md)\> - -#### Defined in - -[src/parser/ytmusic/Search.ts:153](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L153) - -*** - -### sections - -> `get` **sections**(): `undefined` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicShelf`](../../YTNodes/classes/MusicShelf.md)\> - -#### Deprecated - -Use [Search.contents](Search.md#contents) instead. - -#### Returns - -`undefined` \| [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicShelf`](../../YTNodes/classes/MusicShelf.md)\> - -#### Defined in - -[src/parser/ytmusic/Search.ts:160](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L160) +[src/parser/ytmusic/Search.ts:145](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L145) *** @@ -204,7 +168,7 @@ Use [Search.contents](Search.md#contents) instead. #### Defined in -[src/parser/ytmusic/Search.ts:122](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L122) +[src/parser/ytmusic/Search.ts:121](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L121) *** @@ -218,7 +182,7 @@ Use [Search.contents](Search.md#contents) instead. #### Defined in -[src/parser/ytmusic/Search.ts:130](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L130) +[src/parser/ytmusic/Search.ts:129](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L129) *** @@ -232,7 +196,7 @@ Use [Search.contents](Search.md#contents) instead. #### Defined in -[src/parser/ytmusic/Search.ts:134](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L134) +[src/parser/ytmusic/Search.ts:133](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L133) ## Methods @@ -252,7 +216,7 @@ Applies given filter to the search. #### Defined in -[src/parser/ytmusic/Search.ts:87](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L87) +[src/parser/ytmusic/Search.ts:86](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L86) *** @@ -268,7 +232,7 @@ Retrieves search continuation. Only available for filtered searches and shelf co #### Defined in -[src/parser/ytmusic/Search.ts:72](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L72) +[src/parser/ytmusic/Search.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L71) *** @@ -288,4 +252,4 @@ Loads more items for the given shelf. #### Defined in -[src/parser/ytmusic/Search.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/Search.ts#L57) +[src/parser/ytmusic/Search.ts:56](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/Search.ts#L56) diff --git a/docs/api/namespaces/YTMusic/classes/TrackInfo.md b/docs/api/namespaces/YTMusic/classes/TrackInfo.md index 1ee8e816..6e583599 100644 --- a/docs/api/namespaces/YTMusic/classes/TrackInfo.md +++ b/docs/api/namespaces/YTMusic/classes/TrackInfo.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/ytmusic/TrackInfo.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L26) +[src/parser/ytmusic/TrackInfo.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L26) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L31) +[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L39) *** @@ -190,7 +190,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L30) +[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L38) *** @@ -204,7 +204,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L34) +[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L42) *** @@ -218,7 +218,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L35) +[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L43) *** @@ -228,7 +228,7 @@ #### Defined in -[src/parser/ytmusic/TrackInfo.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L23) +[src/parser/ytmusic/TrackInfo.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L23) *** @@ -242,7 +242,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L33) +[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L41) *** @@ -256,7 +256,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L37) +[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L45) *** @@ -270,7 +270,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L38) +[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L46) *** @@ -280,13 +280,13 @@ #### Defined in -[src/parser/ytmusic/TrackInfo.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L24) +[src/parser/ytmusic/TrackInfo.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L24) *** ### storyboards? -> `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) +> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) #### Inherited from @@ -294,7 +294,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L32) +[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L40) *** @@ -308,7 +308,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L36) +[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L44) *** @@ -318,7 +318,7 @@ #### Defined in -[src/parser/ytmusic/TrackInfo.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L22) +[src/parser/ytmusic/TrackInfo.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L22) ## Accessors @@ -326,8 +326,6 @@ > `get` **actions**(): [`Actions`](../../../classes/Actions.md) -Actions instance. - #### Returns [`Actions`](../../../classes/Actions.md) @@ -338,7 +336,7 @@ Actions instance. #### Defined in -[src/core/mixins/MediaInfo.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L223) +[src/core/mixins/MediaInfo.ts:226](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L226) *** @@ -352,7 +350,7 @@ Actions instance. #### Defined in -[src/parser/ytmusic/TrackInfo.ts:126](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L126) +[src/parser/ytmusic/TrackInfo.ts:126](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L126) *** @@ -372,7 +370,7 @@ Content Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L230) +[src/core/mixins/MediaInfo.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L233) *** @@ -380,7 +378,7 @@ Content Playback Nonce. > `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] -Original parsed InnerTube response. +Parsed InnerTube response. #### Returns @@ -392,7 +390,7 @@ Original parsed InnerTube response. #### Defined in -[src/core/mixins/MediaInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L237) +[src/core/mixins/MediaInfo.ts:240](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L240) ## Methods @@ -412,7 +410,7 @@ Adds the song to the watch history. #### Defined in -[src/parser/ytmusic/TrackInfo.ts:122](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L122) +[src/parser/ytmusic/TrackInfo.ts:122](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L122) *** @@ -438,7 +436,7 @@ Options #### Defined in -[src/core/mixins/MediaInfo.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L149) +[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L157) *** @@ -464,7 +462,7 @@ Download options. #### Defined in -[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L157) +[src/core/mixins/MediaInfo.ts:165](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L165) *** @@ -480,7 +478,7 @@ Retrieves lyrics. #### Defined in -[src/parser/ytmusic/TrackInfo.ts:114](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L114) +[src/parser/ytmusic/TrackInfo.ts:114](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L114) *** @@ -496,7 +494,7 @@ Retrieves related content. #### Defined in -[src/parser/ytmusic/TrackInfo.ts:106](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L106) +[src/parser/ytmusic/TrackInfo.ts:106](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L106) *** @@ -522,7 +520,7 @@ Get a cleaned up representation of the adaptive_formats #### Defined in -[src/core/mixins/MediaInfo.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L132) +[src/core/mixins/MediaInfo.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L140) *** @@ -542,7 +540,7 @@ Retrieves contents of the given tab. #### Defined in -[src/parser/ytmusic/TrackInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L45) +[src/parser/ytmusic/TrackInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L45) *** @@ -562,7 +560,7 @@ Retrieves the video's transcript. #### Defined in -[src/core/mixins/MediaInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L170) +[src/core/mixins/MediaInfo.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L178) *** @@ -582,7 +580,7 @@ Retrieves up next. #### Defined in -[src/parser/ytmusic/TrackInfo.ts:74](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytmusic/TrackInfo.ts#L74) +[src/parser/ytmusic/TrackInfo.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytmusic/TrackInfo.ts#L74) *** @@ -618,4 +616,4 @@ DASH manifest #### Defined in -[src/core/mixins/MediaInfo.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L97) +[src/core/mixins/MediaInfo.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L105) diff --git a/docs/api/namespaces/YTNodes/README.md b/docs/api/namespaces/YTNodes/README.md index 3977657a..67163508 100644 --- a/docs/api/namespaces/YTNodes/README.md +++ b/docs/api/namespaces/YTNodes/README.md @@ -16,6 +16,10 @@ - [AddBannerToLiveChatCommand](classes/AddBannerToLiveChatCommand.md) - [AddChatItemAction](classes/AddChatItemAction.md) - [AddLiveChatTickerItemAction](classes/AddLiveChatTickerItemAction.md) +- [AddToPlaylist](classes/AddToPlaylist.md) +- [AddToPlaylistCommand](classes/AddToPlaylistCommand.md) +- [AddToPlaylistEndpoint](classes/AddToPlaylistEndpoint.md) +- [AddToPlaylistServiceEndpoint](classes/AddToPlaylistServiceEndpoint.md) - [Alert](classes/Alert.md) - [AlertWithButton](classes/AlertWithButton.md) - [AnalyticsMainAppKeyMetrics](classes/AnalyticsMainAppKeyMetrics.md) @@ -34,6 +38,7 @@ - [BackstagePost](classes/BackstagePost.md) - [BackstagePostThread](classes/BackstagePostThread.md) - [BadgeView](classes/BadgeView.md) +- [BrowseEndpoint](classes/BrowseEndpoint.md) - [BrowseFeedActions](classes/BrowseFeedActions.md) - [BrowserMediaSession](classes/BrowserMediaSession.md) - [Button](classes/Button.md) @@ -74,6 +79,7 @@ - [CollaboratorInfoCardContent](classes/CollaboratorInfoCardContent.md) - [CollageHeroImage](classes/CollageHeroImage.md) - [CollectionThumbnailView](classes/CollectionThumbnailView.md) +- [CommandExecutorCommand](classes/CommandExecutorCommand.md) - [Comment](classes/Comment.md) - [CommentActionButtons](classes/CommentActionButtons.md) - [CommentDialog](classes/CommentDialog.md) @@ -96,23 +102,31 @@ - [ConfirmDialog](classes/ConfirmDialog.md) - [ContentMetadataView](classes/ContentMetadataView.md) - [ContentPreviewImageView](classes/ContentPreviewImageView.md) +- [ContinuationCommand](classes/ContinuationCommand.md) - [ContinuationItem](classes/ContinuationItem.md) - [ConversationBar](classes/ConversationBar.md) - [CopyLink](classes/CopyLink.md) +- [CreateCommentEndpoint](classes/CreateCommentEndpoint.md) - [CreatePlaylistDialog](classes/CreatePlaylistDialog.md) +- [CreatePlaylistDialogFormView](classes/CreatePlaylistDialogFormView.md) +- [CreatePlaylistServiceEndpoint](classes/CreatePlaylistServiceEndpoint.md) - [CreatorHeart](classes/CreatorHeart.md) - [CtaGoToCreatorStudio](classes/CtaGoToCreatorStudio.md) - [DataModelSection](classes/DataModelSection.md) - [DecoratedAvatarView](classes/DecoratedAvatarView.md) - [DecoratedPlayerBar](classes/DecoratedPlayerBar.md) - [DefaultPromoPanel](classes/DefaultPromoPanel.md) +- [DeletePlaylistEndpoint](classes/DeletePlaylistEndpoint.md) - [DescriptionPreviewView](classes/DescriptionPreviewView.md) +- [DialogHeaderView](classes/DialogHeaderView.md) +- [DialogView](classes/DialogView.md) - [DidYouMean](classes/DidYouMean.md) - [DimChatItemAction](classes/DimChatItemAction.md) - [DislikeButtonView](classes/DislikeButtonView.md) - [DownloadButton](classes/DownloadButton.md) - [Dropdown](classes/Dropdown.md) - [DropdownItem](classes/DropdownItem.md) +- [DropdownView](classes/DropdownView.md) - [DynamicTextView](classes/DynamicTextView.md) - [Element](classes/Element.md) - [EmergencyOnebox](classes/EmergencyOnebox.md) @@ -133,12 +147,16 @@ - [ExpandedShelfContents](classes/ExpandedShelfContents.md) - [Factoid](classes/Factoid.md) - [FancyDismissibleDialog](classes/FancyDismissibleDialog.md) +- [FeedbackEndpoint](classes/FeedbackEndpoint.md) - [FeedFilterChipBar](classes/FeedFilterChipBar.md) - [FeedNudge](classes/FeedNudge.md) - [FeedTabbedHeader](classes/FeedTabbedHeader.md) - [FlexibleActionsView](classes/FlexibleActionsView.md) +- [FormFooterView](classes/FormFooterView.md) - [GameCard](classes/GameCard.md) - [GameDetails](classes/GameDetails.md) +- [GetAccountsListInnertubeEndpoint](classes/GetAccountsListInnertubeEndpoint.md) +- [GetKidsBlocklistPickerCommand](classes/GetKidsBlocklistPickerCommand.md) - [GetMultiPageMenuAction](classes/GetMultiPageMenuAction.md) - [Grid](classes/Grid.md) - [GridChannel](classes/GridChannel.md) @@ -182,18 +200,23 @@ - [KidsHomeScreen](classes/KidsHomeScreen.md) - [LikeButton](classes/LikeButton.md) - [LikeButtonView](classes/LikeButtonView.md) +- [LikeEndpoint](classes/LikeEndpoint.md) - [LiveChat](classes/LiveChat.md) - [LiveChatActionPanel](classes/LiveChatActionPanel.md) - [LiveChatAuthorBadge](classes/LiveChatAuthorBadge.md) - [LiveChatAutoModMessage](classes/LiveChatAutoModMessage.md) - [LiveChatBanner](classes/LiveChatBanner.md) +- [LiveChatBannerChatSummary](classes/LiveChatBannerChatSummary.md) - [LiveChatBannerHeader](classes/LiveChatBannerHeader.md) - [LiveChatBannerPoll](classes/LiveChatBannerPoll.md) +- [LiveChatBannerRedirect](classes/LiveChatBannerRedirect.md) - [LiveChatDialog](classes/LiveChatDialog.md) - [LiveChatHeader](classes/LiveChatHeader.md) +- [LiveChatItemContextMenuEndpoint](classes/LiveChatItemContextMenuEndpoint.md) - [LiveChatItemList](classes/LiveChatItemList.md) - [LiveChatMembershipItem](classes/LiveChatMembershipItem.md) - [LiveChatMessageInput](classes/LiveChatMessageInput.md) +- [LiveChatModeChangeMessage](classes/LiveChatModeChangeMessage.md) - [LiveChatPaidMessage](classes/LiveChatPaidMessage.md) - [LiveChatPaidSticker](classes/LiveChatPaidSticker.md) - [LiveChatParticipant](classes/LiveChatParticipant.md) @@ -201,6 +224,9 @@ - [LiveChatPlaceholderItem](classes/LiveChatPlaceholderItem.md) - [LiveChatProductItem](classes/LiveChatProductItem.md) - [LiveChatRestrictedParticipation](classes/LiveChatRestrictedParticipation.md) +- [LiveChatSponsorshipsGiftPurchaseAnnouncement](classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md) +- [LiveChatSponsorshipsGiftRedemptionAnnouncement](classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md) +- [LiveChatSponsorshipsHeader](classes/LiveChatSponsorshipsHeader.md) - [LiveChatTextMessage](classes/LiveChatTextMessage.md) - [LiveChatTickerPaidMessageItem](classes/LiveChatTickerPaidMessageItem.md) - [LiveChatTickerPaidStickerItem](classes/LiveChatTickerPaidStickerItem.md) @@ -214,10 +240,12 @@ - [MarkChatItemAsDeletedAction](classes/MarkChatItemAsDeletedAction.md) - [MarkChatItemsByAuthorAsDeletedAction](classes/MarkChatItemsByAuthorAsDeletedAction.md) - [Menu](classes/Menu.md) +- [MenuFlexibleItem](classes/MenuFlexibleItem.md) - [MenuNavigationItem](classes/MenuNavigationItem.md) - [MenuPopup](classes/MenuPopup.md) - [MenuServiceItem](classes/MenuServiceItem.md) - [MenuServiceItemDownload](classes/MenuServiceItemDownload.md) +- [MenuTitle](classes/MenuTitle.md) - [MerchandiseItem](classes/MerchandiseItem.md) - [MerchandiseShelf](classes/MerchandiseShelf.md) - [Message](classes/Message.md) @@ -229,6 +257,7 @@ - [MicroformatData](classes/MicroformatData.md) - [Mix](classes/Mix.md) - [ModalWithTitleAndButton](classes/ModalWithTitleAndButton.md) +- [ModifyChannelNotificationPreferenceEndpoint](classes/ModifyChannelNotificationPreferenceEndpoint.md) - [Movie](classes/Movie.md) - [MovingThumbnail](classes/MovingThumbnail.md) - [MultiMarkersPlayerBar](classes/MultiMarkersPlayerBar.md) @@ -271,11 +300,14 @@ - [MusicVisualHeader](classes/MusicVisualHeader.md) - [NavigationEndpoint](classes/NavigationEndpoint.md) - [Notification](classes/Notification.md) +- [NotificationAction](classes/NotificationAction.md) - [OpenPopupAction](classes/OpenPopupAction.md) - [PageHeader](classes/PageHeader.md) - [PageHeaderView](classes/PageHeaderView.md) - [PageIntroduction](classes/PageIntroduction.md) +- [PanelFooterView](classes/PanelFooterView.md) - [PdgCommentChip](classes/PdgCommentChip.md) +- [PerformCommentActionEndpoint](classes/PerformCommentActionEndpoint.md) - [PivotButton](classes/PivotButton.md) - [PlayerAnnotationsExpanded](classes/PlayerAnnotationsExpanded.md) - [PlayerCaptionsTracklist](classes/PlayerCaptionsTracklist.md) @@ -288,9 +320,12 @@ - [PlayerOverflow](classes/PlayerOverflow.md) - [PlayerOverlay](classes/PlayerOverlay.md) - [PlayerOverlayAutoplay](classes/PlayerOverlayAutoplay.md) +- [PlayerOverlayVideoDetails](classes/PlayerOverlayVideoDetails.md) - [PlayerStoryboardSpec](classes/PlayerStoryboardSpec.md) - [Playlist](classes/Playlist.md) +- [PlaylistAddToOption](classes/PlaylistAddToOption.md) - [PlaylistCustomThumbnail](classes/PlaylistCustomThumbnail.md) +- [PlaylistEditEndpoint](classes/PlaylistEditEndpoint.md) - [PlaylistHeader](classes/PlaylistHeader.md) - [PlaylistInfoCardContent](classes/PlaylistInfoCardContent.md) - [PlaylistMetadata](classes/PlaylistMetadata.md) @@ -307,6 +342,8 @@ - [PollHeader](classes/PollHeader.md) - [Post](classes/Post.md) - [PostMultiImage](classes/PostMultiImage.md) +- [PrefetchWatchCommand](classes/PrefetchWatchCommand.md) +- [PremiereTrailerBadge](classes/PremiereTrailerBadge.md) - [ProductList](classes/ProductList.md) - [ProductListHeader](classes/ProductListHeader.md) - [ProductListItem](classes/ProductListItem.md) @@ -320,6 +357,7 @@ - [ReelPlayerHeader](classes/ReelPlayerHeader.md) - [ReelPlayerOverlay](classes/ReelPlayerOverlay.md) - [ReelShelf](classes/ReelShelf.md) +- [ReelWatchEndpoint](classes/ReelWatchEndpoint.md) - [RelatedChipCloud](classes/RelatedChipCloud.md) - [RemoveBannerForLiveChatCommand](classes/RemoveBannerForLiveChatCommand.md) - [RemoveChatItemAction](classes/RemoveChatItemAction.md) @@ -334,6 +372,7 @@ - [RichSection](classes/RichSection.md) - [RichShelf](classes/RichShelf.md) - [SearchBox](classes/SearchBox.md) +- [SearchEndpoint](classes/SearchEndpoint.md) - [SearchFilter](classes/SearchFilter.md) - [SearchFilterGroup](classes/SearchFilterGroup.md) - [SearchFilterOptionsDialog](classes/SearchFilterOptionsDialog.md) @@ -346,19 +385,29 @@ - [SectionList](classes/SectionList.md) - [SegmentedLikeDislikeButton](classes/SegmentedLikeDislikeButton.md) - [SegmentedLikeDislikeButtonView](classes/SegmentedLikeDislikeButtonView.md) +- [SendFeedbackAction](classes/SendFeedbackAction.md) - [SettingBoolean](classes/SettingBoolean.md) - [SettingsCheckbox](classes/SettingsCheckbox.md) - [SettingsOptions](classes/SettingsOptions.md) - [SettingsSidebar](classes/SettingsSidebar.md) - [SettingsSwitch](classes/SettingsSwitch.md) - [SharedPost](classes/SharedPost.md) +- [ShareEndpoint](classes/ShareEndpoint.md) +- [ShareEntityEndpoint](classes/ShareEntityEndpoint.md) +- [ShareEntityServiceEndpoint](classes/ShareEntityServiceEndpoint.md) +- [SharePanelHeader](classes/SharePanelHeader.md) +- [SharePanelTitleV15](classes/SharePanelTitleV15.md) +- [ShareTarget](classes/ShareTarget.md) - [Shelf](classes/Shelf.md) - [ShortsLockupView](classes/ShortsLockupView.md) - [ShowCustomThumbnail](classes/ShowCustomThumbnail.md) +- [ShowDialogCommand](classes/ShowDialogCommand.md) - [ShowingResultsFor](classes/ShowingResultsFor.md) - [ShowLiveChatActionPanelAction](classes/ShowLiveChatActionPanelAction.md) - [ShowLiveChatDialogAction](classes/ShowLiveChatDialogAction.md) - [ShowLiveChatTooltipCommand](classes/ShowLiveChatTooltipCommand.md) +- [SignalAction](classes/SignalAction.md) +- [SignalServiceEndpoint](classes/SignalServiceEndpoint.md) - [SimpleCardContent](classes/SimpleCardContent.md) - [SimpleCardTeaser](classes/SimpleCardTeaser.md) - [SimpleMenuHeader](classes/SimpleMenuHeader.md) @@ -372,17 +421,21 @@ - [SortFilterHeader](classes/SortFilterHeader.md) - [SortFilterSubMenu](classes/SortFilterSubMenu.md) - [SponsorCommentBadge](classes/SponsorCommentBadge.md) +- [StartAt](classes/StartAt.md) - [StatRow](classes/StatRow.md) - [StructuredDescriptionContent](classes/StructuredDescriptionContent.md) - [StructuredDescriptionPlaylistLockup](classes/StructuredDescriptionPlaylistLockup.md) - [SubFeedOption](classes/SubFeedOption.md) - [SubFeedSelector](classes/SubFeedSelector.md) - [SubscribeButton](classes/SubscribeButton.md) +- [SubscribeEndpoint](classes/SubscribeEndpoint.md) - [SubscriptionNotificationToggleButton](classes/SubscriptionNotificationToggleButton.md) - [Tab](classes/Tab.md) - [Tabbed](classes/Tabbed.md) - [TabbedSearchResults](classes/TabbedSearchResults.md) +- [TextFieldView](classes/TextFieldView.md) - [TextHeader](classes/TextHeader.md) +- [ThirdPartyShareTargetSection](classes/ThirdPartyShareTargetSection.md) - [ThumbnailBadgeView](classes/ThumbnailBadgeView.md) - [ThumbnailHoverOverlayView](classes/ThumbnailHoverOverlayView.md) - [ThumbnailLandscapePortrait](classes/ThumbnailLandscapePortrait.md) @@ -417,11 +470,14 @@ - [TwoColumnBrowseResults](classes/TwoColumnBrowseResults.md) - [TwoColumnSearchResults](classes/TwoColumnSearchResults.md) - [TwoColumnWatchNextResults](classes/TwoColumnWatchNextResults.md) +- [UnifiedSharePanel](classes/UnifiedSharePanel.md) - [UniversalWatchCard](classes/UniversalWatchCard.md) +- [UnsubscribeEndpoint](classes/UnsubscribeEndpoint.md) - [UpdateDateTextAction](classes/UpdateDateTextAction.md) - [UpdateDescriptionAction](classes/UpdateDescriptionAction.md) - [UpdateEngagementPanelAction](classes/UpdateEngagementPanelAction.md) - [UpdateLiveChatPollAction](classes/UpdateLiveChatPollAction.md) +- [UpdateSubscribeButtonAction](classes/UpdateSubscribeButtonAction.md) - [UpdateTitleAction](classes/UpdateTitleAction.md) - [UpdateToggleButtonTextAction](classes/UpdateToggleButtonTextAction.md) - [UpdateViewershipAction](classes/UpdateViewershipAction.md) @@ -442,11 +498,14 @@ - [VideoOwner](classes/VideoOwner.md) - [VideoPrimaryInfo](classes/VideoPrimaryInfo.md) - [VideoSecondaryInfo](classes/VideoSecondaryInfo.md) +- [VideoViewCount](classes/VideoViewCount.md) - [ViewCountFactoid](classes/ViewCountFactoid.md) - [WatchCardCompactVideo](classes/WatchCardCompactVideo.md) - [WatchCardHeroVideo](classes/WatchCardHeroVideo.md) - [WatchCardRichHeader](classes/WatchCardRichHeader.md) - [WatchCardSectionSequence](classes/WatchCardSectionSequence.md) +- [WatchEndpoint](classes/WatchEndpoint.md) +- [WatchNextEndpoint](classes/WatchNextEndpoint.md) - [WatchNextEndScreen](classes/WatchNextEndScreen.md) - [WatchNextTabbedResults](classes/WatchNextTabbedResults.md) - [YpcTrailer](classes/YpcTrailer.md) diff --git a/docs/api/namespaces/YTNodes/classes/AboutChannel.md b/docs/api/namespaces/YTNodes/classes/AboutChannel.md index f785271e..37c502b3 100644 --- a/docs/api/namespaces/YTNodes/classes/AboutChannel.md +++ b/docs/api/namespaces/YTNodes/classes/AboutChannel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AboutChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannel.ts#L12) +[src/parser/classes/AboutChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannel.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AboutChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannel.ts#L9) +[src/parser/classes/AboutChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannel.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/AboutChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannel.ts#L10) +[src/parser/classes/AboutChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannel.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/AboutChannel.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannel.ts#L7) +[src/parser/classes/AboutChannel.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannel.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AboutChannelView.md b/docs/api/namespaces/YTNodes/classes/AboutChannelView.md index 922e6988..00596ac4 100644 --- a/docs/api/namespaces/YTNodes/classes/AboutChannelView.md +++ b/docs/api/namespaces/YTNodes/classes/AboutChannelView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L26) +[src/parser/classes/AboutChannelView.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L26) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L20) +[src/parser/classes/AboutChannelView.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L20) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L18) +[src/parser/classes/AboutChannelView.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L18) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L19) +[src/parser/classes/AboutChannelView.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L19) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L13) +[src/parser/classes/AboutChannelView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L14) +[src/parser/classes/AboutChannelView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L14) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L21) +[src/parser/classes/AboutChannelView.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L21) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L11) +[src/parser/classes/AboutChannelView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L11) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L12) +[src/parser/classes/AboutChannelView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L12) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L17) +[src/parser/classes/AboutChannelView.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L17) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L24) +[src/parser/classes/AboutChannelView.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L24) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L23) +[src/parser/classes/AboutChannelView.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L23) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L15) +[src/parser/classes/AboutChannelView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L15) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L22) +[src/parser/classes/AboutChannelView.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L22) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L16) +[src/parser/classes/AboutChannelView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L16) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/classes/AboutChannelView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AboutChannelView.ts#L9) +[src/parser/classes/AboutChannelView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AboutChannelView.ts#L9) ## Methods @@ -214,17 +214,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -258,7 +266,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -292,7 +300,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -330,4 +338,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AccountChannel.md b/docs/api/namespaces/YTNodes/classes/AccountChannel.md index ac52ca7a..429a9a82 100644 --- a/docs/api/namespaces/YTNodes/classes/AccountChannel.md +++ b/docs/api/namespaces/YTNodes/classes/AccountChannel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AccountChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountChannel.ts#L12) +[src/parser/classes/AccountChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountChannel.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AccountChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountChannel.ts#L10) +[src/parser/classes/AccountChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountChannel.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/AccountChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountChannel.ts#L9) +[src/parser/classes/AccountChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountChannel.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/AccountChannel.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountChannel.ts#L7) +[src/parser/classes/AccountChannel.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountChannel.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AccountItem.md b/docs/api/namespaces/YTNodes/classes/AccountItem.md index 4d7611d5..d03e8bf8 100644 --- a/docs/api/namespaces/YTNodes/classes/AccountItem.md +++ b/docs/api/namespaces/YTNodes/classes/AccountItem.md @@ -28,7 +28,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L21) +[src/parser/classes/AccountItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L22) ## Properties @@ -38,7 +38,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L19) +[src/parser/classes/AccountItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L19) *** @@ -48,7 +48,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L13) +[src/parser/classes/AccountItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L13) *** @@ -58,7 +58,17 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L14) +[src/parser/classes/AccountItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L20) *** @@ -68,7 +78,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L18) +[src/parser/classes/AccountItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L18) *** @@ -78,7 +88,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L17) +[src/parser/classes/AccountItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L17) *** @@ -88,7 +98,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L16) +[src/parser/classes/AccountItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L16) *** @@ -98,7 +108,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L15) +[src/parser/classes/AccountItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L15) *** @@ -112,7 +122,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -126,7 +136,7 @@ Not a real renderer but we treat it as one to keep things organized. #### Defined in -[src/parser/classes/AccountItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItem.ts#L11) +[src/parser/classes/AccountItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItem.ts#L11) ## Methods @@ -146,17 +156,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -190,7 +208,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -224,7 +242,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -262,4 +280,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AccountItemSection.md b/docs/api/namespaces/YTNodes/classes/AccountItemSection.md index 3013a657..155c1221 100644 --- a/docs/api/namespaces/YTNodes/classes/AccountItemSection.md +++ b/docs/api/namespaces/YTNodes/classes/AccountItemSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AccountItemSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItemSection.ts#L14) +[src/parser/classes/AccountItemSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItemSection.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AccountItemSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItemSection.ts#L11) +[src/parser/classes/AccountItemSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItemSection.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/AccountItemSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItemSection.ts#L12) +[src/parser/classes/AccountItemSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItemSection.ts#L12) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/AccountItemSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItemSection.ts#L9) +[src/parser/classes/AccountItemSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItemSection.ts#L9) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AccountItemSectionHeader.md b/docs/api/namespaces/YTNodes/classes/AccountItemSectionHeader.md index 3305edfc..4b563288 100644 --- a/docs/api/namespaces/YTNodes/classes/AccountItemSectionHeader.md +++ b/docs/api/namespaces/YTNodes/classes/AccountItemSectionHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AccountItemSectionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItemSectionHeader.ts#L10) +[src/parser/classes/AccountItemSectionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItemSectionHeader.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AccountItemSectionHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItemSectionHeader.ts#L8) +[src/parser/classes/AccountItemSectionHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItemSectionHeader.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/AccountItemSectionHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountItemSectionHeader.ts#L6) +[src/parser/classes/AccountItemSectionHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountItemSectionHeader.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AccountSectionList.md b/docs/api/namespaces/YTNodes/classes/AccountSectionList.md index 129fc678..97a6363a 100644 --- a/docs/api/namespaces/YTNodes/classes/AccountSectionList.md +++ b/docs/api/namespaces/YTNodes/classes/AccountSectionList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AccountSectionList.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountSectionList.ts#L15) +[src/parser/classes/AccountSectionList.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountSectionList.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AccountSectionList.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountSectionList.ts#L12) +[src/parser/classes/AccountSectionList.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountSectionList.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/AccountSectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountSectionList.ts#L13) +[src/parser/classes/AccountSectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountSectionList.ts#L13) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/AccountSectionList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AccountSectionList.ts#L10) +[src/parser/classes/AccountSectionList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AccountSectionList.ts#L10) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md b/docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md index 102079c5..fcb140f4 100644 --- a/docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md +++ b/docs/api/namespaces/YTNodes/classes/AddBannerToLiveChatCommand.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L11) +[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L9) +[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L7) +[src/parser/classes/livechat/AddBannerToLiveChatCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddBannerToLiveChatCommand.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AddChatItemAction.md b/docs/api/namespaces/YTNodes/classes/AddChatItemAction.md index d612882f..b33eddf2 100644 --- a/docs/api/namespaces/YTNodes/classes/AddChatItemAction.md +++ b/docs/api/namespaces/YTNodes/classes/AddChatItemAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/AddChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddChatItemAction.ts#L11) +[src/parser/classes/livechat/AddChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddChatItemAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/AddChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddChatItemAction.ts#L9) +[src/parser/classes/livechat/AddChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddChatItemAction.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/AddChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddChatItemAction.ts#L8) +[src/parser/classes/livechat/AddChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddChatItemAction.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/AddChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddChatItemAction.ts#L6) +[src/parser/classes/livechat/AddChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddChatItemAction.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md b/docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md index 8f056ca9..e0a596ae 100644 --- a/docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md +++ b/docs/api/namespaces/YTNodes/classes/AddLiveChatTickerItemAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L11) +[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L9) +[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L8) +[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L6) +[src/parser/classes/livechat/AddLiveChatTickerItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/AddLiveChatTickerItemAction.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AddToPlaylist.md b/docs/api/namespaces/YTNodes/classes/AddToPlaylist.md new file mode 100644 index 00000000..8036f166 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/AddToPlaylist.md @@ -0,0 +1,221 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AddToPlaylist + +# Class: AddToPlaylist + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new AddToPlaylist() + +> **new AddToPlaylist**(`data`): [`AddToPlaylist`](AddToPlaylist.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`AddToPlaylist`](AddToPlaylist.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/AddToPlaylist.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AddToPlaylist.ts#L13) + +## Properties + +### actions + +> **actions**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`MenuTitle`](MenuTitle.md)\> + +#### Defined in + +[src/parser/classes/AddToPlaylist.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AddToPlaylist.ts#L10) + +*** + +### playlists + +> **playlists**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlaylistAddToOption`](PlaylistAddToOption.md)\> + +#### Defined in + +[src/parser/classes/AddToPlaylist.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AddToPlaylist.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'AddToPlaylist'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/AddToPlaylist.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AddToPlaylist.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is AddToPlaylist & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is AddToPlaylist & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AddToPlaylistCommand.md b/docs/api/namespaces/YTNodes/classes/AddToPlaylistCommand.md new file mode 100644 index 00000000..7bda3ec4 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/AddToPlaylistCommand.md @@ -0,0 +1,251 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AddToPlaylistEndpoint.md b/docs/api/namespaces/YTNodes/classes/AddToPlaylistEndpoint.md new file mode 100644 index 00000000..b1828cb8 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/AddToPlaylistEndpoint.md @@ -0,0 +1,237 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AddToPlaylistEndpoint + +# Class: AddToPlaylistEndpoint + +## Extends + +- [`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md) + +## Constructors + +### new AddToPlaylistEndpoint() + +> **new AddToPlaylistEndpoint**(`data`): [`AddToPlaylistEndpoint`](AddToPlaylistEndpoint.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`AddToPlaylistEndpoint`](AddToPlaylistEndpoint.md) + +#### Overrides + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`constructor`](AddToPlaylistServiceEndpoint.md#constructors) + +#### Defined in + +[src/parser/classes/endpoints/AddToPlaylistEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/AddToPlaylistEndpoint.ts#L7) + +## Properties + +### type + +> `readonly` **type**: `string` + +#### Inherited from + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`type`](AddToPlaylistServiceEndpoint.md#type) + +#### Defined in + +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'AddToPlaylistEndpoint'` + +#### Overrides + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`type`](AddToPlaylistServiceEndpoint.md#type-1) + +#### Defined in + +[src/parser/classes/endpoints/AddToPlaylistEndpoint.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/AddToPlaylistEndpoint.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 + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`as`](AddToPlaylistServiceEndpoint.md#as) + +#### Defined in + +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### buildRequest() + +> **buildRequest**(): [`AddToPlaylistServiceRequest`](../../APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md) + +#### Returns + +[`AddToPlaylistServiceRequest`](../../APIResponseTypes/type-aliases/AddToPlaylistServiceRequest.md) + +#### Inherited from + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`buildRequest`](AddToPlaylistServiceEndpoint.md#buildrequest) + +#### Defined in + +[src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts#L19) + +*** + +### getApiPath() + +> **getApiPath**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`getApiPath`](AddToPlaylistServiceEndpoint.md#getapipath) + +#### Defined in + +[src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.ts#L15) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is AddToPlaylistEndpoint & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is AddToPlaylistEndpoint & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`hasKey`](AddToPlaylistServiceEndpoint.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`is`](AddToPlaylistServiceEndpoint.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`AddToPlaylistServiceEndpoint`](AddToPlaylistServiceEndpoint.md).[`key`](AddToPlaylistServiceEndpoint.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AddToPlaylistServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/AddToPlaylistServiceEndpoint.md new file mode 100644 index 00000000..ecd19f83 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/AddToPlaylistServiceEndpoint.md @@ -0,0 +1,245 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/AddToPlaylistServiceEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Alert.md b/docs/api/namespaces/YTNodes/classes/Alert.md index 14c4fa4d..63c1cef2 100644 --- a/docs/api/namespaces/YTNodes/classes/Alert.md +++ b/docs/api/namespaces/YTNodes/classes/Alert.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Alert.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Alert.ts#L11) +[src/parser/classes/Alert.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Alert.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Alert.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Alert.ts#L9) +[src/parser/classes/Alert.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Alert.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Alert.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Alert.ts#L8) +[src/parser/classes/Alert.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Alert.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/Alert.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Alert.ts#L6) +[src/parser/classes/Alert.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Alert.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AlertWithButton.md b/docs/api/namespaces/YTNodes/classes/AlertWithButton.md index e7e936e1..6fbd7196 100644 --- a/docs/api/namespaces/YTNodes/classes/AlertWithButton.md +++ b/docs/api/namespaces/YTNodes/classes/AlertWithButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AlertWithButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AlertWithButton.ts#L13) +[src/parser/classes/AlertWithButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AlertWithButton.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AlertWithButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AlertWithButton.ts#L10) +[src/parser/classes/AlertWithButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AlertWithButton.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/AlertWithButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AlertWithButton.ts#L11) +[src/parser/classes/AlertWithButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AlertWithButton.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/AlertWithButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AlertWithButton.ts#L9) +[src/parser/classes/AlertWithButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AlertWithButton.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/AlertWithButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AlertWithButton.ts#L7) +[src/parser/classes/AlertWithButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AlertWithButton.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AnalyticsMainAppKeyMetrics.md b/docs/api/namespaces/YTNodes/classes/AnalyticsMainAppKeyMetrics.md index e6025874..d52db821 100644 --- a/docs/api/namespaces/YTNodes/classes/AnalyticsMainAppKeyMetrics.md +++ b/docs/api/namespaces/YTNodes/classes/AnalyticsMainAppKeyMetrics.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L11) +[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L8) +[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L9) +[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L6) +[src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsMainAppKeyMetrics.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AnalyticsRoot.md b/docs/api/namespaces/YTNodes/classes/AnalyticsRoot.md index b8ccef90..ad3c0958 100644 --- a/docs/api/namespaces/YTNodes/classes/AnalyticsRoot.md +++ b/docs/api/namespaces/YTNodes/classes/AnalyticsRoot.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsRoot.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsRoot.ts#L23) +[src/parser/classes/analytics/AnalyticsRoot.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsRoot.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsRoot.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsRoot.ts#L8) +[src/parser/classes/analytics/AnalyticsRoot.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsRoot.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsRoot.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsRoot.ts#L11) +[src/parser/classes/analytics/AnalyticsRoot.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsRoot.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsRoot.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsRoot.ts#L7) +[src/parser/classes/analytics/AnalyticsRoot.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsRoot.ts#L7) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsRoot.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsRoot.ts#L9) +[src/parser/classes/analytics/AnalyticsRoot.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsRoot.ts#L9) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsRoot.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsRoot.ts#L5) +[src/parser/classes/analytics/AnalyticsRoot.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsRoot.ts#L5) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AnalyticsShortsCarouselCard.md b/docs/api/namespaces/YTNodes/classes/AnalyticsShortsCarouselCard.md index 5d28945c..ed36346b 100644 --- a/docs/api/namespaces/YTNodes/classes/AnalyticsShortsCarouselCard.md +++ b/docs/api/namespaces/YTNodes/classes/AnalyticsShortsCarouselCard.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L15) +[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L9) +[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L8) +[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L6) +[src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsShortsCarouselCard.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AnalyticsVideo.md b/docs/api/namespaces/YTNodes/classes/AnalyticsVideo.md index 5f961e5f..d006f875 100644 --- a/docs/api/namespaces/YTNodes/classes/AnalyticsVideo.md +++ b/docs/api/namespaces/YTNodes/classes/AnalyticsVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVideo.ts#L17) +[src/parser/classes/analytics/AnalyticsVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVideo.ts#L17) ## Properties @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVideo.ts#L9) +[src/parser/classes/analytics/AnalyticsVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVideo.ts#L9) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVideo.ts#L8) +[src/parser/classes/analytics/AnalyticsVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVideo.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVideo.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVideo.ts#L6) +[src/parser/classes/analytics/AnalyticsVideo.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVideo.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AnalyticsVodCarouselCard.md b/docs/api/namespaces/YTNodes/classes/AnalyticsVodCarouselCard.md index fcfbb856..b416e243 100644 --- a/docs/api/namespaces/YTNodes/classes/AnalyticsVodCarouselCard.md +++ b/docs/api/namespaces/YTNodes/classes/AnalyticsVodCarouselCard.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L12) +[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L10) +[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L8) +[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L9) +[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L9) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L6) +[src/parser/classes/analytics/AnalyticsVodCarouselCard.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/AnalyticsVodCarouselCard.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AnchoredSection.md b/docs/api/namespaces/YTNodes/classes/AnchoredSection.md index 98500fb6..3713f9d9 100644 --- a/docs/api/namespaces/YTNodes/classes/AnchoredSection.md +++ b/docs/api/namespaces/YTNodes/classes/AnchoredSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ytkids/AnchoredSection.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/AnchoredSection.ts#L19) +[src/parser/classes/ytkids/AnchoredSection.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/AnchoredSection.ts#L19) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/ytkids/AnchoredSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/AnchoredSection.ts#L13) +[src/parser/classes/ytkids/AnchoredSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/AnchoredSection.ts#L13) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/ytkids/AnchoredSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/AnchoredSection.ts#L17) +[src/parser/classes/ytkids/AnchoredSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/AnchoredSection.ts#L17) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ytkids/AnchoredSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/AnchoredSection.ts#L11) +[src/parser/classes/ytkids/AnchoredSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/AnchoredSection.ts#L11) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ytkids/AnchoredSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/AnchoredSection.ts#L12) +[src/parser/classes/ytkids/AnchoredSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/AnchoredSection.ts#L12) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ytkids/AnchoredSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/AnchoredSection.ts#L10) +[src/parser/classes/ytkids/AnchoredSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/AnchoredSection.ts#L10) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -112,7 +112,7 @@ #### Defined in -[src/parser/classes/ytkids/AnchoredSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/AnchoredSection.ts#L8) +[src/parser/classes/ytkids/AnchoredSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/AnchoredSection.ts#L8) ## Methods @@ -132,17 +132,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -176,7 +184,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -210,7 +218,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -248,4 +256,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md b/docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md index 84b6635c..6d03bb8a 100644 --- a/docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md +++ b/docs/api/namespaces/YTNodes/classes/AppendContinuationItemsAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/actions/AppendContinuationItemsAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/AppendContinuationItemsAction.ts#L12) +[src/parser/classes/actions/AppendContinuationItemsAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/AppendContinuationItemsAction.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/actions/AppendContinuationItemsAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/AppendContinuationItemsAction.ts#L9) +[src/parser/classes/actions/AppendContinuationItemsAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/AppendContinuationItemsAction.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/actions/AppendContinuationItemsAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/AppendContinuationItemsAction.ts#L10) +[src/parser/classes/actions/AppendContinuationItemsAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/AppendContinuationItemsAction.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/actions/AppendContinuationItemsAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/AppendContinuationItemsAction.ts#L7) +[src/parser/classes/actions/AppendContinuationItemsAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/AppendContinuationItemsAction.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AttributionView.md b/docs/api/namespaces/YTNodes/classes/AttributionView.md index 0db61399..26e58b8f 100644 --- a/docs/api/namespaces/YTNodes/classes/AttributionView.md +++ b/docs/api/namespaces/YTNodes/classes/AttributionView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AttributionView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AttributionView.ts#L11) +[src/parser/classes/AttributionView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AttributionView.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AttributionView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AttributionView.ts#L9) +[src/parser/classes/AttributionView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AttributionView.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/AttributionView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AttributionView.ts#L8) +[src/parser/classes/AttributionView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AttributionView.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/AttributionView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AttributionView.ts#L6) +[src/parser/classes/AttributionView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AttributionView.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AudioOnlyPlayability.md b/docs/api/namespaces/YTNodes/classes/AudioOnlyPlayability.md index 00d454b0..df5d9d65 100644 --- a/docs/api/namespaces/YTNodes/classes/AudioOnlyPlayability.md +++ b/docs/api/namespaces/YTNodes/classes/AudioOnlyPlayability.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AudioOnlyPlayability.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AudioOnlyPlayability.ts#L9) +[src/parser/classes/AudioOnlyPlayability.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AudioOnlyPlayability.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AudioOnlyPlayability.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AudioOnlyPlayability.ts#L7) +[src/parser/classes/AudioOnlyPlayability.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AudioOnlyPlayability.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/AudioOnlyPlayability.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AudioOnlyPlayability.ts#L5) +[src/parser/classes/AudioOnlyPlayability.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AudioOnlyPlayability.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md b/docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md index 098eb9b2..dddc2a38 100644 --- a/docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md +++ b/docs/api/namespaces/YTNodes/classes/AuthorCommentBadge.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/AuthorCommentBadge.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/AuthorCommentBadge.ts#L13) +[src/parser/classes/comments/AuthorCommentBadge.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/AuthorCommentBadge.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/AuthorCommentBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/AuthorCommentBadge.ts#L9) +[src/parser/classes/comments/AuthorCommentBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/AuthorCommentBadge.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/AuthorCommentBadge.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/AuthorCommentBadge.ts#L11) +[src/parser/classes/comments/AuthorCommentBadge.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/AuthorCommentBadge.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/AuthorCommentBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/AuthorCommentBadge.ts#L10) +[src/parser/classes/comments/AuthorCommentBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/AuthorCommentBadge.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/comments/AuthorCommentBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/AuthorCommentBadge.ts#L5) +[src/parser/classes/comments/AuthorCommentBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/AuthorCommentBadge.ts#L5) ## Accessors @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/comments/AuthorCommentBadge.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/AuthorCommentBadge.ts#L31) +[src/parser/classes/comments/AuthorCommentBadge.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/AuthorCommentBadge.ts#L31) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AutomixPreviewVideo.md b/docs/api/namespaces/YTNodes/classes/AutomixPreviewVideo.md index 0ad21ef1..cd536979 100644 --- a/docs/api/namespaces/YTNodes/classes/AutomixPreviewVideo.md +++ b/docs/api/namespaces/YTNodes/classes/AutomixPreviewVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AutomixPreviewVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AutomixPreviewVideo.ts#L10) +[src/parser/classes/AutomixPreviewVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AutomixPreviewVideo.ts#L10) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/AutomixPreviewVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AutomixPreviewVideo.ts#L8) +[src/parser/classes/AutomixPreviewVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AutomixPreviewVideo.ts#L8) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/AutomixPreviewVideo.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AutomixPreviewVideo.ts#L6) +[src/parser/classes/AutomixPreviewVideo.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AutomixPreviewVideo.ts#L6) ## Methods @@ -88,17 +88,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -132,7 +140,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -166,7 +174,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -204,4 +212,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/AvatarView.md b/docs/api/namespaces/YTNodes/classes/AvatarView.md index acbcb57f..4993bc18 100644 --- a/docs/api/namespaces/YTNodes/classes/AvatarView.md +++ b/docs/api/namespaces/YTNodes/classes/AvatarView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/AvatarView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AvatarView.ts#L16) +[src/parser/classes/AvatarView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AvatarView.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/AvatarView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AvatarView.ts#L14) +[src/parser/classes/AvatarView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AvatarView.ts#L14) *** @@ -46,25 +46,17 @@ #### Defined in -[src/parser/classes/AvatarView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AvatarView.ts#L8) +[src/parser/classes/AvatarView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AvatarView.ts#L8) *** ### image\_processor -> **image\_processor**: `object` - -#### border\_image\_processor - -> **border\_image\_processor**: `object` - -#### border\_image\_processor.circular - -> **circular**: `boolean` +> **image\_processor**: `undefined` \| `object` #### Defined in -[src/parser/classes/AvatarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AvatarView.ts#L9) +[src/parser/classes/AvatarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AvatarView.ts#L9) *** @@ -78,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -92,7 +84,7 @@ #### Defined in -[src/parser/classes/AvatarView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/AvatarView.ts#L6) +[src/parser/classes/AvatarView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/AvatarView.ts#L6) ## Methods @@ -112,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -156,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -190,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -228,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/BackstageImage.md b/docs/api/namespaces/YTNodes/classes/BackstageImage.md index b692c7ce..f11dda46 100644 --- a/docs/api/namespaces/YTNodes/classes/BackstageImage.md +++ b/docs/api/namespaces/YTNodes/classes/BackstageImage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/BackstageImage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstageImage.ts#L12) +[src/parser/classes/BackstageImage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstageImage.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/BackstageImage.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstageImage.ts#L10) +[src/parser/classes/BackstageImage.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstageImage.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/BackstageImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstageImage.ts#L9) +[src/parser/classes/BackstageImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstageImage.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/BackstageImage.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstageImage.ts#L7) +[src/parser/classes/BackstageImage.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstageImage.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/BackstagePost.md b/docs/api/namespaces/YTNodes/classes/BackstagePost.md index 2b6907e5..a7976ae4 100644 --- a/docs/api/namespaces/YTNodes/classes/BackstagePost.md +++ b/docs/api/namespaces/YTNodes/classes/BackstagePost.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L27) +[src/parser/classes/BackstagePost.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L27) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L21) +[src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L21) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L25) +[src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L25) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L14) +[src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L14) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L15) +[src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L15) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L24) +[src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L24) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L13) +[src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L13) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L20) +[src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L20) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L17) +[src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L17) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L16) +[src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L16) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L23) +[src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L23) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -154,7 +154,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L22) +[src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L22) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L19) +[src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L19) *** @@ -174,7 +174,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L18) +[src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L18) *** @@ -188,7 +188,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L11) +[src/parser/classes/BackstagePost.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L11) ## Methods @@ -208,17 +208,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -252,7 +260,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -286,7 +294,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -324,4 +332,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/BackstagePostThread.md b/docs/api/namespaces/YTNodes/classes/BackstagePostThread.md index 92447034..9c45c538 100644 --- a/docs/api/namespaces/YTNodes/classes/BackstagePostThread.md +++ b/docs/api/namespaces/YTNodes/classes/BackstagePostThread.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/BackstagePostThread.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePostThread.ts#L9) +[src/parser/classes/BackstagePostThread.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePostThread.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/BackstagePostThread.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePostThread.ts#L7) +[src/parser/classes/BackstagePostThread.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePostThread.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/BackstagePostThread.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePostThread.ts#L5) +[src/parser/classes/BackstagePostThread.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePostThread.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/BadgeView.md b/docs/api/namespaces/YTNodes/classes/BadgeView.md index a9881f87..d5856a46 100644 --- a/docs/api/namespaces/YTNodes/classes/BadgeView.md +++ b/docs/api/namespaces/YTNodes/classes/BadgeView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/BadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BadgeView.ts#L9) +[src/parser/classes/BadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BadgeView.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/BadgeView.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BadgeView.ts#L7) +[src/parser/classes/BadgeView.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BadgeView.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/BadgeView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BadgeView.ts#L6) +[src/parser/classes/BadgeView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BadgeView.ts#L6) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/BadgeView.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BadgeView.ts#L5) +[src/parser/classes/BadgeView.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BadgeView.ts#L5) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L7) +[src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/BrowseEndpoint.md b/docs/api/namespaces/YTNodes/classes/BrowseEndpoint.md new file mode 100644 index 00000000..bd8b8dfa --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/BrowseEndpoint.md @@ -0,0 +1,241 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/BrowseEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/BrowseFeedActions.md b/docs/api/namespaces/YTNodes/classes/BrowseFeedActions.md index 9f4a661f..71ba02ab 100644 --- a/docs/api/namespaces/YTNodes/classes/BrowseFeedActions.md +++ b/docs/api/namespaces/YTNodes/classes/BrowseFeedActions.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/BrowseFeedActions.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BrowseFeedActions.ts#L9) +[src/parser/classes/BrowseFeedActions.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BrowseFeedActions.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/BrowseFeedActions.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BrowseFeedActions.ts#L7) +[src/parser/classes/BrowseFeedActions.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BrowseFeedActions.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/BrowseFeedActions.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BrowseFeedActions.ts#L5) +[src/parser/classes/BrowseFeedActions.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BrowseFeedActions.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md b/docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md index 63764ca9..25a39dcd 100644 --- a/docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md +++ b/docs/api/namespaces/YTNodes/classes/BrowserMediaSession.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/BrowserMediaSession.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BrowserMediaSession.ts#L12) +[src/parser/classes/BrowserMediaSession.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BrowserMediaSession.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/BrowserMediaSession.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BrowserMediaSession.ts#L9) +[src/parser/classes/BrowserMediaSession.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BrowserMediaSession.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/BrowserMediaSession.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BrowserMediaSession.ts#L10) +[src/parser/classes/BrowserMediaSession.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BrowserMediaSession.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/BrowserMediaSession.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BrowserMediaSession.ts#L7) +[src/parser/classes/BrowserMediaSession.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BrowserMediaSession.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Button.md b/docs/api/namespaces/YTNodes/classes/Button.md index c36f6653..986ef8ea 100644 --- a/docs/api/namespaces/YTNodes/classes/Button.md +++ b/docs/api/namespaces/YTNodes/classes/Button.md @@ -31,7 +31,7 @@ #### Defined in -[src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L16) +[src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L16) ## Properties @@ -41,7 +41,7 @@ #### Defined in -[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L14) +[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L14) *** @@ -51,7 +51,7 @@ #### Defined in -[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L12) +[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L12) *** @@ -61,7 +61,7 @@ #### Defined in -[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L13) +[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L13) *** @@ -71,7 +71,7 @@ #### Defined in -[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L10) +[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L10) *** @@ -81,7 +81,7 @@ #### Defined in -[src/parser/classes/Button.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L9) +[src/parser/classes/Button.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L9) *** @@ -91,7 +91,7 @@ #### Defined in -[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L11) +[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L11) *** @@ -105,7 +105,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -119,7 +119,7 @@ #### Defined in -[src/parser/classes/Button.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L7) +[src/parser/classes/Button.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L7) ## Methods @@ -139,17 +139,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -183,7 +191,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -217,7 +225,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -255,4 +263,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ButtonView.md b/docs/api/namespaces/YTNodes/classes/ButtonView.md index 0887e3f8..ba685316 100644 --- a/docs/api/namespaces/YTNodes/classes/ButtonView.md +++ b/docs/api/namespaces/YTNodes/classes/ButtonView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L17) +[src/parser/classes/ButtonView.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L10) +[src/parser/classes/ButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L14) +[src/parser/classes/ButtonView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L13) +[src/parser/classes/ButtonView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L8) +[src/parser/classes/ButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L8) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L12) +[src/parser/classes/ButtonView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L15) +[src/parser/classes/ButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L15) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L11) +[src/parser/classes/ButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L11) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L9) +[src/parser/classes/ButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L9) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/ButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ButtonView.ts#L6) +[src/parser/classes/ButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ButtonView.ts#L6) ## Methods @@ -154,17 +154,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -198,7 +206,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -232,7 +240,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -270,4 +278,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md b/docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md index 5620ff56..d419d461 100644 --- a/docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md +++ b/docs/api/namespaces/YTNodes/classes/C4TabbedHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L28) +[src/parser/classes/C4TabbedHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L28) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L15) +[src/parser/classes/C4TabbedHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L16) +[src/parser/classes/C4TabbedHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L24) +[src/parser/classes/C4TabbedHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L24) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L25) +[src/parser/classes/C4TabbedHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L25) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L23) +[src/parser/classes/C4TabbedHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L23) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L18) +[src/parser/classes/C4TabbedHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L18) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L21) +[src/parser/classes/C4TabbedHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L21) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L22) +[src/parser/classes/C4TabbedHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L22) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L19) +[src/parser/classes/C4TabbedHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L19) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L26) +[src/parser/classes/C4TabbedHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L26) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L17) +[src/parser/classes/C4TabbedHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L17) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L20) +[src/parser/classes/C4TabbedHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L20) *** @@ -174,7 +174,7 @@ #### Defined in -[src/parser/classes/C4TabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/C4TabbedHeader.ts#L13) +[src/parser/classes/C4TabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/C4TabbedHeader.ts#L13) ## Methods @@ -194,17 +194,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -238,7 +246,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -272,7 +280,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -310,4 +318,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CallToActionButton.md b/docs/api/namespaces/YTNodes/classes/CallToActionButton.md index 2b70db7a..8256604a 100644 --- a/docs/api/namespaces/YTNodes/classes/CallToActionButton.md +++ b/docs/api/namespaces/YTNodes/classes/CallToActionButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CallToActionButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CallToActionButton.ts#L12) +[src/parser/classes/CallToActionButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CallToActionButton.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CallToActionButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CallToActionButton.ts#L9) +[src/parser/classes/CallToActionButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CallToActionButton.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CallToActionButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CallToActionButton.ts#L8) +[src/parser/classes/CallToActionButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CallToActionButton.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CallToActionButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CallToActionButton.ts#L10) +[src/parser/classes/CallToActionButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CallToActionButton.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/CallToActionButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CallToActionButton.ts#L6) +[src/parser/classes/CallToActionButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CallToActionButton.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Card.md b/docs/api/namespaces/YTNodes/classes/Card.md index 9358736b..81ded345 100644 --- a/docs/api/namespaces/YTNodes/classes/Card.md +++ b/docs/api/namespaces/YTNodes/classes/Card.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Card.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Card.ts#L19) +[src/parser/classes/Card.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Card.ts#L19) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Card.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Card.ts#L9) +[src/parser/classes/Card.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Card.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Card.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Card.ts#L8) +[src/parser/classes/Card.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Card.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Card.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Card.ts#L12) +[src/parser/classes/Card.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Card.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Card.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Card.ts#L10) +[src/parser/classes/Card.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Card.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/Card.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Card.ts#L7) +[src/parser/classes/Card.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Card.ts#L7) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/Card.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Card.ts#L5) +[src/parser/classes/Card.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Card.ts#L5) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CardCollection.md b/docs/api/namespaces/YTNodes/classes/CardCollection.md index 0a45f884..1122206f 100644 --- a/docs/api/namespaces/YTNodes/classes/CardCollection.md +++ b/docs/api/namespaces/YTNodes/classes/CardCollection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CardCollection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CardCollection.ts#L12) +[src/parser/classes/CardCollection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CardCollection.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CardCollection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CardCollection.ts#L10) +[src/parser/classes/CardCollection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CardCollection.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CardCollection.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CardCollection.ts#L8) +[src/parser/classes/CardCollection.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CardCollection.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CardCollection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CardCollection.ts#L9) +[src/parser/classes/CardCollection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CardCollection.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/CardCollection.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CardCollection.ts#L6) +[src/parser/classes/CardCollection.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CardCollection.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CarouselHeader.md b/docs/api/namespaces/YTNodes/classes/CarouselHeader.md index ad20b4e3..f7fdc3ba 100644 --- a/docs/api/namespaces/YTNodes/classes/CarouselHeader.md +++ b/docs/api/namespaces/YTNodes/classes/CarouselHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CarouselHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselHeader.ts#L9) +[src/parser/classes/CarouselHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselHeader.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CarouselHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselHeader.ts#L7) +[src/parser/classes/CarouselHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselHeader.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/CarouselHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselHeader.ts#L5) +[src/parser/classes/CarouselHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselHeader.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CarouselItem.md b/docs/api/namespaces/YTNodes/classes/CarouselItem.md index 9e3d46b4..f5b72a5d 100644 --- a/docs/api/namespaces/YTNodes/classes/CarouselItem.md +++ b/docs/api/namespaces/YTNodes/classes/CarouselItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L14) +[src/parser/classes/CarouselItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L9) +[src/parser/classes/CarouselItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L8) +[src/parser/classes/CarouselItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L10) +[src/parser/classes/CarouselItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L11) +[src/parser/classes/CarouselItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L12) +[src/parser/classes/CarouselItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L6) +[src/parser/classes/CarouselItem.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L6) ## Accessors @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/CarouselItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselItem.ts#L24) +[src/parser/classes/CarouselItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselItem.ts#L24) ## Methods @@ -138,17 +138,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -182,7 +190,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -216,7 +224,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -254,4 +262,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CarouselLockup.md b/docs/api/namespaces/YTNodes/classes/CarouselLockup.md index 36f0f947..207de18c 100644 --- a/docs/api/namespaces/YTNodes/classes/CarouselLockup.md +++ b/docs/api/namespaces/YTNodes/classes/CarouselLockup.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CarouselLockup.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselLockup.ts#L12) +[src/parser/classes/CarouselLockup.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselLockup.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CarouselLockup.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselLockup.ts#L9) +[src/parser/classes/CarouselLockup.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselLockup.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/CarouselLockup.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselLockup.ts#L10) +[src/parser/classes/CarouselLockup.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselLockup.ts#L10) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/CarouselLockup.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CarouselLockup.ts#L7) +[src/parser/classes/CarouselLockup.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CarouselLockup.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Channel.md b/docs/api/namespaces/YTNodes/classes/Channel.md index c7fbba15..8429e64c 100644 --- a/docs/api/namespaces/YTNodes/classes/Channel.md +++ b/docs/api/namespaces/YTNodes/classes/Channel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Channel.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L23) +[src/parser/classes/Channel.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L22) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Channel.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L14) +[src/parser/classes/Channel.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Channel.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L21) +[src/parser/classes/Channel.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L20) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Channel.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L19) +[src/parser/classes/Channel.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L18) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Channel.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L13) +[src/parser/classes/Channel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/Channel.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L17) +[src/parser/classes/Channel.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/Channel.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L18) +[src/parser/classes/Channel.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L17) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/Channel.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L20) +[src/parser/classes/Channel.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L19) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/Channel.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L15) +[src/parser/classes/Channel.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L14) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/Channel.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L16) +[src/parser/classes/Channel.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L15) *** @@ -144,45 +144,7 @@ #### Defined in -[src/parser/classes/Channel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L11) - -## Accessors - -### subscribers - -> `get` **subscribers**(): [`Text`](../../Misc/classes/Text.md) - -#### Deprecated - -This will be removed in a future release. -Please use [Channel.subscriber_count](Channel.md#subscriber_count) instead. - -#### Returns - -[`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Channel.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L47) - -*** - -### videos - -> `get` **videos**(): [`Text`](../../Misc/classes/Text.md) - -#### Deprecated - -This will be removed in a future release. -Please use [Channel.video_count](Channel.md#video_count) instead. - -#### Returns - -[`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/Channel.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Channel.ts#L57) +[src/parser/classes/Channel.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Channel.ts#L10) ## Methods @@ -202,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -246,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -280,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -318,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md b/docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md index 3190866f..51e99f03 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelAboutFullMetadata.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L31) +[src/parser/classes/ChannelAboutFullMetadata.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L30) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L14) +[src/parser/classes/ChannelAboutFullMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L29) +[src/parser/classes/ChannelAboutFullMetadata.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L28) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L27) +[src/parser/classes/ChannelAboutFullMetadata.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L26) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L15) +[src/parser/classes/ChannelAboutFullMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L28) +[src/parser/classes/ChannelAboutFullMetadata.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L27) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L25) +[src/parser/classes/ChannelAboutFullMetadata.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L24) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L26) +[src/parser/classes/ChannelAboutFullMetadata.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L25) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L12) +[src/parser/classes/ChannelAboutFullMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L11) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L24) +[src/parser/classes/ChannelAboutFullMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L23) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L13) +[src/parser/classes/ChannelAboutFullMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L12) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L17) +[src/parser/classes/ChannelAboutFullMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L16) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L23) +[src/parser/classes/ChannelAboutFullMetadata.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L22) *** @@ -174,45 +174,7 @@ #### Defined in -[src/parser/classes/ChannelAboutFullMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L10) - -## Accessors - -### joined - -> `get` **joined**(): [`Text`](../../Misc/classes/Text.md) - -#### Deprecated - -This will be removed in a future release. -Please use [ChannelAboutFullMetadata.joined_date](ChannelAboutFullMetadata.md#joined_date) instead. - -#### Returns - -[`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:68](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L68) - -*** - -### views - -> `get` **views**(): [`Text`](../../Misc/classes/Text.md) - -#### Deprecated - -This will be removed in a future release. -Please use [ChannelAboutFullMetadata.view_count](ChannelAboutFullMetadata.md#view_count) instead. - -#### Returns - -[`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelAboutFullMetadata.ts:58](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAboutFullMetadata.ts#L58) +[src/parser/classes/ChannelAboutFullMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAboutFullMetadata.ts#L9) ## Methods @@ -232,17 +194,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -276,7 +246,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -310,7 +280,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -348,4 +318,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md b/docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md index 49805dc2..d67708d2 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelAgeGate.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L18) +[src/parser/classes/ChannelAgeGate.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L12) +[src/parser/classes/ChannelAgeGate.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L11) +[src/parser/classes/ChannelAgeGate.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L13) +[src/parser/classes/ChannelAgeGate.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L14) +[src/parser/classes/ChannelAgeGate.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L16) +[src/parser/classes/ChannelAgeGate.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L15) +[src/parser/classes/ChannelAgeGate.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L15) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/ChannelAgeGate.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelAgeGate.ts#L9) +[src/parser/classes/ChannelAgeGate.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelAgeGate.ts#L9) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md b/docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md index 03e6770a..87b82c4a 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelExternalLinkView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelExternalLinkView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelExternalLinkView.ts#L13) +[src/parser/classes/ChannelExternalLinkView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelExternalLinkView.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelExternalLinkView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelExternalLinkView.ts#L11) +[src/parser/classes/ChannelExternalLinkView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelExternalLinkView.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelExternalLinkView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelExternalLinkView.ts#L10) +[src/parser/classes/ChannelExternalLinkView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelExternalLinkView.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelExternalLinkView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelExternalLinkView.ts#L9) +[src/parser/classes/ChannelExternalLinkView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelExternalLinkView.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ChannelExternalLinkView.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelExternalLinkView.ts#L7) +[src/parser/classes/ChannelExternalLinkView.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelExternalLinkView.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelFeaturedContent.md b/docs/api/namespaces/YTNodes/classes/ChannelFeaturedContent.md index 418b3385..3e379332 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelFeaturedContent.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelFeaturedContent.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelFeaturedContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelFeaturedContent.ts#L11) +[src/parser/classes/ChannelFeaturedContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelFeaturedContent.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelFeaturedContent.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelFeaturedContent.ts#L9) +[src/parser/classes/ChannelFeaturedContent.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelFeaturedContent.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelFeaturedContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelFeaturedContent.ts#L8) +[src/parser/classes/ChannelFeaturedContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelFeaturedContent.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ChannelFeaturedContent.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelFeaturedContent.ts#L6) +[src/parser/classes/ChannelFeaturedContent.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelFeaturedContent.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinks.md b/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinks.md index 10da6cb4..764ecbb9 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinks.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinks.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinks.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinks.ts#L29) +[src/parser/classes/ChannelHeaderLinks.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinks.ts#L29) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinks.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinks.ts#L26) +[src/parser/classes/ChannelHeaderLinks.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinks.ts#L26) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinks.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinks.ts#L27) +[src/parser/classes/ChannelHeaderLinks.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinks.ts#L27) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinks.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinks.ts#L24) +[src/parser/classes/ChannelHeaderLinks.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinks.ts#L24) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md b/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md index cfe20a87..365092f8 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelHeaderLinksView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinksView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinksView.ts#L11) +[src/parser/classes/ChannelHeaderLinksView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinksView.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinksView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinksView.ts#L8) +[src/parser/classes/ChannelHeaderLinksView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinksView.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinksView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinksView.ts#L9) +[src/parser/classes/ChannelHeaderLinksView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinksView.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ChannelHeaderLinksView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelHeaderLinksView.ts#L6) +[src/parser/classes/ChannelHeaderLinksView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelHeaderLinksView.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelMetadata.md b/docs/api/namespaces/YTNodes/classes/ChannelMetadata.md index 711c4c61..f67fdbea 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelMetadata.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelMetadata.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L23) +[src/parser/classes/ChannelMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L20) +[src/parser/classes/ChannelMetadata.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L20) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L19) +[src/parser/classes/ChannelMetadata.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L19) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L18) +[src/parser/classes/ChannelMetadata.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L18) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L16) +[src/parser/classes/ChannelMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L16) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L9) +[src/parser/classes/ChannelMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L9) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L13) +[src/parser/classes/ChannelMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L13) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L21) +[src/parser/classes/ChannelMetadata.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L21) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L14) +[src/parser/classes/ChannelMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L14) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L15) +[src/parser/classes/ChannelMetadata.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L15) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L17) +[src/parser/classes/ChannelMetadata.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L17) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L11) +[src/parser/classes/ChannelMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L11) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L8) +[src/parser/classes/ChannelMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L8) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L10) +[src/parser/classes/ChannelMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L10) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L12) +[src/parser/classes/ChannelMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L12) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/classes/ChannelMetadata.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMetadata.ts#L6) +[src/parser/classes/ChannelMetadata.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMetadata.ts#L6) ## Methods @@ -214,17 +214,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -258,7 +266,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -292,7 +300,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -330,4 +338,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelMobileHeader.md b/docs/api/namespaces/YTNodes/classes/ChannelMobileHeader.md index cee24586..a06e85a3 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelMobileHeader.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelMobileHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelMobileHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMobileHeader.ts#L10) +[src/parser/classes/ChannelMobileHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMobileHeader.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelMobileHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMobileHeader.ts#L8) +[src/parser/classes/ChannelMobileHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMobileHeader.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ChannelMobileHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelMobileHeader.ts#L6) +[src/parser/classes/ChannelMobileHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelMobileHeader.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelOptions.md b/docs/api/namespaces/YTNodes/classes/ChannelOptions.md index 9353ce2e..8156b81e 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelOptions.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelOptions.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelOptions.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOptions.ts#L15) +[src/parser/classes/ChannelOptions.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOptions.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelOptions.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOptions.ts#L10) +[src/parser/classes/ChannelOptions.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOptions.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelOptions.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOptions.ts#L11) +[src/parser/classes/ChannelOptions.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOptions.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelOptions.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOptions.ts#L13) +[src/parser/classes/ChannelOptions.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOptions.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChannelOptions.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOptions.ts#L12) +[src/parser/classes/ChannelOptions.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOptions.ts#L12) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ChannelOptions.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOptions.ts#L8) +[src/parser/classes/ChannelOptions.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOptions.ts#L8) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md b/docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md index 0b90e36c..3c5c4542 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelOwnerEmptyState.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelOwnerEmptyState.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOwnerEmptyState.ts#L12) +[src/parser/classes/ChannelOwnerEmptyState.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOwnerEmptyState.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelOwnerEmptyState.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOwnerEmptyState.ts#L10) +[src/parser/classes/ChannelOwnerEmptyState.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOwnerEmptyState.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelOwnerEmptyState.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOwnerEmptyState.ts#L9) +[src/parser/classes/ChannelOwnerEmptyState.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOwnerEmptyState.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ChannelOwnerEmptyState.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelOwnerEmptyState.ts#L7) +[src/parser/classes/ChannelOwnerEmptyState.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelOwnerEmptyState.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md b/docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md index 7d9d4bcc..e698bff4 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelSubMenu.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelSubMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelSubMenu.ts#L16) +[src/parser/classes/ChannelSubMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelSubMenu.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelSubMenu.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelSubMenu.ts#L8) +[src/parser/classes/ChannelSubMenu.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelSubMenu.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelSubMenu.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelSubMenu.ts#L14) +[src/parser/classes/ChannelSubMenu.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelSubMenu.ts#L14) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ChannelSubMenu.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelSubMenu.ts#L6) +[src/parser/classes/ChannelSubMenu.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelSubMenu.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelTagline.md b/docs/api/namespaces/YTNodes/classes/ChannelTagline.md index 0a160966..2e02c99c 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelTagline.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelTagline.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L25) +[src/parser/classes/ChannelTagline.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L25) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L9) +[src/parser/classes/ChannelTagline.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L10) +[src/parser/classes/ChannelTagline.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L11) +[src/parser/classes/ChannelTagline.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L21) +[src/parser/classes/ChannelTagline.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L21) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L22) +[src/parser/classes/ChannelTagline.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L22) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L23) +[src/parser/classes/ChannelTagline.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L23) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/ChannelTagline.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelTagline.ts#L7) +[src/parser/classes/ChannelTagline.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelTagline.ts#L7) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md b/docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md index 08c3aa24..e6557b15 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelThumbnailWithLink.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelThumbnailWithLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelThumbnailWithLink.ts#L13) +[src/parser/classes/ChannelThumbnailWithLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelThumbnailWithLink.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelThumbnailWithLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelThumbnailWithLink.ts#L10) +[src/parser/classes/ChannelThumbnailWithLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelThumbnailWithLink.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelThumbnailWithLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelThumbnailWithLink.ts#L11) +[src/parser/classes/ChannelThumbnailWithLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelThumbnailWithLink.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelThumbnailWithLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelThumbnailWithLink.ts#L9) +[src/parser/classes/ChannelThumbnailWithLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelThumbnailWithLink.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ChannelThumbnailWithLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelThumbnailWithLink.ts#L7) +[src/parser/classes/ChannelThumbnailWithLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelThumbnailWithLink.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md b/docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md index a1c6a64d..5a0c6790 100644 --- a/docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md +++ b/docs/api/namespaces/YTNodes/classes/ChannelVideoPlayer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChannelVideoPlayer.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L15) +[src/parser/classes/ChannelVideoPlayer.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelVideoPlayer.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChannelVideoPlayer.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L11) +[src/parser/classes/ChannelVideoPlayer.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelVideoPlayer.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChannelVideoPlayer.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L9) +[src/parser/classes/ChannelVideoPlayer.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelVideoPlayer.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChannelVideoPlayer.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L13) +[src/parser/classes/ChannelVideoPlayer.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelVideoPlayer.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChannelVideoPlayer.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L10) +[src/parser/classes/ChannelVideoPlayer.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelVideoPlayer.ts#L9) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/ChannelVideoPlayer.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L12) +[src/parser/classes/ChannelVideoPlayer.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelVideoPlayer.ts#L11) *** @@ -104,45 +104,7 @@ #### Defined in -[src/parser/classes/ChannelVideoPlayer.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L7) - -## Accessors - -### published - -> `get` **published**(): [`Text`](../../Misc/classes/Text.md) - -#### Deprecated - -This will be removed in a future release. -Please use [ChannelVideoPlayer.published_time](ChannelVideoPlayer.md#published_time) instead. - -#### Returns - -[`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L39) - -*** - -### views - -> `get` **views**(): [`Text`](../../Misc/classes/Text.md) - -#### Deprecated - -This will be removed in a future release. -Please use [ChannelVideoPlayer.view_count](ChannelVideoPlayer.md#view_count) instead. - -#### Returns - -[`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/ChannelVideoPlayer.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChannelVideoPlayer.ts#L29) +[src/parser/classes/ChannelVideoPlayer.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChannelVideoPlayer.ts#L6) ## Methods @@ -162,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -206,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -240,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -278,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Chapter.md b/docs/api/namespaces/YTNodes/classes/Chapter.md index cd9cd027..bb138701 100644 --- a/docs/api/namespaces/YTNodes/classes/Chapter.md +++ b/docs/api/namespaces/YTNodes/classes/Chapter.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Chapter.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Chapter.ts#L13) +[src/parser/classes/Chapter.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Chapter.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Chapter.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Chapter.ts#L11) +[src/parser/classes/Chapter.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Chapter.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Chapter.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Chapter.ts#L10) +[src/parser/classes/Chapter.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Chapter.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Chapter.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Chapter.ts#L9) +[src/parser/classes/Chapter.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Chapter.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/Chapter.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Chapter.ts#L7) +[src/parser/classes/Chapter.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Chapter.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChildVideo.md b/docs/api/namespaces/YTNodes/classes/ChildVideo.md index 142fc505..4777d042 100644 --- a/docs/api/namespaces/YTNodes/classes/ChildVideo.md +++ b/docs/api/namespaces/YTNodes/classes/ChildVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChildVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChildVideo.ts#L20) +[src/parser/classes/ChildVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChildVideo.ts#L20) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/ChildVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChildVideo.ts#L13) +[src/parser/classes/ChildVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChildVideo.ts#L13) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/ChildVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChildVideo.ts#L18) +[src/parser/classes/ChildVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChildVideo.ts#L18) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ChildVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChildVideo.ts#L10) +[src/parser/classes/ChildVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChildVideo.ts#L10) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ChildVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChildVideo.ts#L11) +[src/parser/classes/ChildVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChildVideo.ts#L11) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/ChildVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChildVideo.ts#L8) +[src/parser/classes/ChildVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChildVideo.ts#L8) ## Methods @@ -122,17 +122,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -166,7 +174,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -200,7 +208,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -238,4 +246,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChipBarView.md b/docs/api/namespaces/YTNodes/classes/ChipBarView.md index 32295a78..23a0f52e 100644 --- a/docs/api/namespaces/YTNodes/classes/ChipBarView.md +++ b/docs/api/namespaces/YTNodes/classes/ChipBarView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChipBarView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipBarView.ts#L10) +[src/parser/classes/ChipBarView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipBarView.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChipBarView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipBarView.ts#L8) +[src/parser/classes/ChipBarView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipBarView.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ChipBarView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipBarView.ts#L6) +[src/parser/classes/ChipBarView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipBarView.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChipCloud.md b/docs/api/namespaces/YTNodes/classes/ChipCloud.md index 625f1b08..33ad9690 100644 --- a/docs/api/namespaces/YTNodes/classes/ChipCloud.md +++ b/docs/api/namespaces/YTNodes/classes/ChipCloud.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChipCloud.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloud.ts#L14) +[src/parser/classes/ChipCloud.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloud.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChipCloud.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloud.ts#L9) +[src/parser/classes/ChipCloud.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloud.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChipCloud.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloud.ts#L12) +[src/parser/classes/ChipCloud.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloud.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChipCloud.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloud.ts#L10) +[src/parser/classes/ChipCloud.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloud.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChipCloud.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloud.ts#L11) +[src/parser/classes/ChipCloud.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloud.ts#L11) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ChipCloud.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloud.ts#L7) +[src/parser/classes/ChipCloud.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloud.ts#L7) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChipCloudChip.md b/docs/api/namespaces/YTNodes/classes/ChipCloudChip.md index 7a3c7e12..ec0dbaee 100644 --- a/docs/api/namespaces/YTNodes/classes/ChipCloudChip.md +++ b/docs/api/namespaces/YTNodes/classes/ChipCloudChip.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChipCloudChip.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloudChip.ts#L13) +[src/parser/classes/ChipCloudChip.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloudChip.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChipCloudChip.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloudChip.ts#L10) +[src/parser/classes/ChipCloudChip.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloudChip.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChipCloudChip.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloudChip.ts#L9) +[src/parser/classes/ChipCloudChip.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloudChip.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChipCloudChip.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloudChip.ts#L11) +[src/parser/classes/ChipCloudChip.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloudChip.ts#L11) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ChipCloudChip.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipCloudChip.ts#L7) +[src/parser/classes/ChipCloudChip.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipCloudChip.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ChipView.md b/docs/api/namespaces/YTNodes/classes/ChipView.md index abbe1956..0c87106d 100644 --- a/docs/api/namespaces/YTNodes/classes/ChipView.md +++ b/docs/api/namespaces/YTNodes/classes/ChipView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ChipView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipView.ts#L13) +[src/parser/classes/ChipView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipView.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ChipView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipView.ts#L11) +[src/parser/classes/ChipView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipView.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ChipView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipView.ts#L9) +[src/parser/classes/ChipView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipView.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ChipView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipView.ts#L10) +[src/parser/classes/ChipView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipView.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ChipView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipView.ts#L8) +[src/parser/classes/ChipView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipView.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ChipView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ChipView.ts#L6) +[src/parser/classes/ChipView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ChipView.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ClipAdState.md b/docs/api/namespaces/YTNodes/classes/ClipAdState.md index e4200a30..3b4c32e4 100644 --- a/docs/api/namespaces/YTNodes/classes/ClipAdState.md +++ b/docs/api/namespaces/YTNodes/classes/ClipAdState.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ClipAdState.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipAdState.ts#L12) +[src/parser/classes/ClipAdState.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipAdState.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ClipAdState.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipAdState.ts#L10) +[src/parser/classes/ClipAdState.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipAdState.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ClipAdState.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipAdState.ts#L9) +[src/parser/classes/ClipAdState.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipAdState.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ClipAdState.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipAdState.ts#L7) +[src/parser/classes/ClipAdState.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipAdState.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ClipCreation.md b/docs/api/namespaces/YTNodes/classes/ClipCreation.md index 381c109d..06e952f8 100644 --- a/docs/api/namespaces/YTNodes/classes/ClipCreation.md +++ b/docs/api/namespaces/YTNodes/classes/ClipCreation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L27) +[src/parser/classes/ClipCreation.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L27) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L23) +[src/parser/classes/ClipCreation.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L23) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L22) +[src/parser/classes/ClipCreation.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L22) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L20) +[src/parser/classes/ClipCreation.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L20) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L24) +[src/parser/classes/ClipCreation.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L24) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L21) +[src/parser/classes/ClipCreation.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L21) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L25) +[src/parser/classes/ClipCreation.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L25) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L19) +[src/parser/classes/ClipCreation.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L19) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L18) +[src/parser/classes/ClipCreation.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L18) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L17) +[src/parser/classes/ClipCreation.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L17) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L16) +[src/parser/classes/ClipCreation.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L16) *** @@ -154,7 +154,7 @@ #### Defined in -[src/parser/classes/ClipCreation.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreation.ts#L14) +[src/parser/classes/ClipCreation.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreation.ts#L14) ## Methods @@ -174,17 +174,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -218,7 +226,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -252,7 +260,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -290,4 +298,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md b/docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md index 8a982892..74987499 100644 --- a/docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md +++ b/docs/api/namespaces/YTNodes/classes/ClipCreationScrubber.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L17) +[src/parser/classes/ClipCreationScrubber.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L11) +[src/parser/classes/ClipCreationScrubber.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L15) +[src/parser/classes/ClipCreationScrubber.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L14) +[src/parser/classes/ClipCreationScrubber.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L8) +[src/parser/classes/ClipCreationScrubber.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L8) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L9) +[src/parser/classes/ClipCreationScrubber.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L9) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L10) +[src/parser/classes/ClipCreationScrubber.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L10) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L13) +[src/parser/classes/ClipCreationScrubber.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L13) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L12) +[src/parser/classes/ClipCreationScrubber.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L12) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/ClipCreationScrubber.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationScrubber.ts#L6) +[src/parser/classes/ClipCreationScrubber.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationScrubber.ts#L6) ## Methods @@ -154,17 +154,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -198,7 +206,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -232,7 +240,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -270,4 +278,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md b/docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md index 506955aa..5b198e51 100644 --- a/docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md +++ b/docs/api/namespaces/YTNodes/classes/ClipCreationTextInput.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ClipCreationTextInput.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationTextInput.ts#L12) +[src/parser/classes/ClipCreationTextInput.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationTextInput.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ClipCreationTextInput.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationTextInput.ts#L10) +[src/parser/classes/ClipCreationTextInput.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationTextInput.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ClipCreationTextInput.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationTextInput.ts#L9) +[src/parser/classes/ClipCreationTextInput.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationTextInput.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ClipCreationTextInput.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipCreationTextInput.ts#L7) +[src/parser/classes/ClipCreationTextInput.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipCreationTextInput.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ClipSection.md b/docs/api/namespaces/YTNodes/classes/ClipSection.md index 4cac1087..f269b0f9 100644 --- a/docs/api/namespaces/YTNodes/classes/ClipSection.md +++ b/docs/api/namespaces/YTNodes/classes/ClipSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ClipSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipSection.ts#L15) +[src/parser/classes/ClipSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipSection.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ClipSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipSection.ts#L13) +[src/parser/classes/ClipSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipSection.ts#L13) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ClipSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ClipSection.ts#L11) +[src/parser/classes/ClipSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ClipSection.ts#L11) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md b/docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md index 2aeb4ac9..ca608c81 100644 --- a/docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md +++ b/docs/api/namespaces/YTNodes/classes/CollaboratorInfoCardContent.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CollaboratorInfoCardContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollaboratorInfoCardContent.ts#L16) +[src/parser/classes/CollaboratorInfoCardContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollaboratorInfoCardContent.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CollaboratorInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollaboratorInfoCardContent.ts#L10) +[src/parser/classes/CollaboratorInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollaboratorInfoCardContent.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CollaboratorInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollaboratorInfoCardContent.ts#L12) +[src/parser/classes/CollaboratorInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollaboratorInfoCardContent.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CollaboratorInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollaboratorInfoCardContent.ts#L11) +[src/parser/classes/CollaboratorInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollaboratorInfoCardContent.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/CollaboratorInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollaboratorInfoCardContent.ts#L14) +[src/parser/classes/CollaboratorInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollaboratorInfoCardContent.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/CollaboratorInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollaboratorInfoCardContent.ts#L13) +[src/parser/classes/CollaboratorInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollaboratorInfoCardContent.ts#L13) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/CollaboratorInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollaboratorInfoCardContent.ts#L8) +[src/parser/classes/CollaboratorInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollaboratorInfoCardContent.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CollageHeroImage.md b/docs/api/namespaces/YTNodes/classes/CollageHeroImage.md index 621e544e..d59c7665 100644 --- a/docs/api/namespaces/YTNodes/classes/CollageHeroImage.md +++ b/docs/api/namespaces/YTNodes/classes/CollageHeroImage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CollageHeroImage.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollageHeroImage.ts#L14) +[src/parser/classes/CollageHeroImage.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollageHeroImage.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CollageHeroImage.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollageHeroImage.ts#L11) +[src/parser/classes/CollageHeroImage.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollageHeroImage.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CollageHeroImage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollageHeroImage.ts#L12) +[src/parser/classes/CollageHeroImage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollageHeroImage.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CollageHeroImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollageHeroImage.ts#L9) +[src/parser/classes/CollageHeroImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollageHeroImage.ts#L9) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/CollageHeroImage.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollageHeroImage.ts#L10) +[src/parser/classes/CollageHeroImage.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollageHeroImage.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/CollageHeroImage.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollageHeroImage.ts#L7) +[src/parser/classes/CollageHeroImage.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollageHeroImage.ts#L7) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md b/docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md index fd8192bb..15882e6b 100644 --- a/docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md +++ b/docs/api/namespaces/YTNodes/classes/CollectionThumbnailView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CollectionThumbnailView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollectionThumbnailView.ts#L14) +[src/parser/classes/CollectionThumbnailView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollectionThumbnailView.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CollectionThumbnailView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollectionThumbnailView.ts#L8) +[src/parser/classes/CollectionThumbnailView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollectionThumbnailView.ts#L8) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/CollectionThumbnailView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollectionThumbnailView.ts#L9) +[src/parser/classes/CollectionThumbnailView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollectionThumbnailView.ts#L9) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/CollectionThumbnailView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CollectionThumbnailView.ts#L6) +[src/parser/classes/CollectionThumbnailView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CollectionThumbnailView.ts#L6) ## Methods @@ -102,17 +102,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -146,7 +154,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -180,7 +188,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -218,4 +226,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommandExecutorCommand.md b/docs/api/namespaces/YTNodes/classes/CommandExecutorCommand.md new file mode 100644 index 00000000..e83830ba --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/CommandExecutorCommand.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / CommandExecutorCommand + +# Class: CommandExecutorCommand + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new CommandExecutorCommand() + +> **new CommandExecutorCommand**(`data`): [`CommandExecutorCommand`](CommandExecutorCommand.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`CommandExecutorCommand`](CommandExecutorCommand.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/commands/CommandExecutorCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/commands/CommandExecutorCommand.ts#L10) + +## Properties + +### commands + +> **commands**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> + +#### Defined in + +[src/parser/classes/commands/CommandExecutorCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/commands/CommandExecutorCommand.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'CommandExecutorCommand'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/commands/CommandExecutorCommand.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/commands/CommandExecutorCommand.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is CommandExecutorCommand & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is CommandExecutorCommand & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Comment.md b/docs/api/namespaces/YTNodes/classes/Comment.md index 65aa82f7..4e1c37e2 100644 --- a/docs/api/namespaces/YTNodes/classes/Comment.md +++ b/docs/api/namespaces/YTNodes/classes/Comment.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L47) +[src/parser/classes/comments/Comment.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L47) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L36) +[src/parser/classes/comments/Comment.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L36) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L35) +[src/parser/classes/comments/Comment.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L35) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L34) +[src/parser/classes/comments/Comment.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L34) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L33) +[src/parser/classes/comments/Comment.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L33) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L29) +[src/parser/classes/comments/Comment.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L29) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L37) +[src/parser/classes/comments/Comment.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L37) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L27) +[src/parser/classes/comments/Comment.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L27) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L30) +[src/parser/classes/comments/Comment.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L30) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L42) +[src/parser/classes/comments/Comment.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L42) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L43) +[src/parser/classes/comments/Comment.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L43) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L41) +[src/parser/classes/comments/Comment.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L41) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:45](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L45) +[src/parser/classes/comments/Comment.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L45) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L44) +[src/parser/classes/comments/Comment.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L44) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L32) +[src/parser/classes/comments/Comment.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L32) *** @@ -176,7 +176,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L28) +[src/parser/classes/comments/Comment.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L28) *** @@ -186,7 +186,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L40) +[src/parser/classes/comments/Comment.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L40) *** @@ -196,7 +196,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L31) +[src/parser/classes/comments/Comment.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L31) *** @@ -210,7 +210,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -220,7 +220,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L39) +[src/parser/classes/comments/Comment.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L39) *** @@ -230,7 +230,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L38) +[src/parser/classes/comments/Comment.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L38) *** @@ -244,7 +244,7 @@ #### Defined in -[src/parser/classes/comments/Comment.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L23) +[src/parser/classes/comments/Comment.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L23) ## Methods @@ -264,17 +264,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -290,7 +298,7 @@ Dislikes the comment. #### Defined in -[src/parser/classes/comments/Comment.ts:101](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L101) +[src/parser/classes/comments/Comment.ts:101](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L101) *** @@ -324,7 +332,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -358,7 +366,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -396,7 +404,7 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) *** @@ -412,7 +420,7 @@ Likes the comment. #### Defined in -[src/parser/classes/comments/Comment.ts:82](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L82) +[src/parser/classes/comments/Comment.ts:82](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L82) *** @@ -432,7 +440,7 @@ Creates a reply to the comment. #### Defined in -[src/parser/classes/comments/Comment.ts:121](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L121) +[src/parser/classes/comments/Comment.ts:121](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L121) *** @@ -450,7 +458,7 @@ Creates a reply to the comment. #### Defined in -[src/parser/classes/comments/Comment.ts:176](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L176) +[src/parser/classes/comments/Comment.ts:176](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L176) *** @@ -472,4 +480,4 @@ Ex; en, ja #### Defined in -[src/parser/classes/comments/Comment.ts:151](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/Comment.ts#L151) +[src/parser/classes/comments/Comment.ts:151](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/Comment.ts#L151) diff --git a/docs/api/namespaces/YTNodes/classes/CommentActionButtons.md b/docs/api/namespaces/YTNodes/classes/CommentActionButtons.md index a9fcad2a..ebf0b45f 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentActionButtons.md +++ b/docs/api/namespaces/YTNodes/classes/CommentActionButtons.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentActionButtons.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentActionButtons.ts#L17) +[src/parser/classes/comments/CommentActionButtons.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentActionButtons.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentActionButtons.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentActionButtons.ts#L15) +[src/parser/classes/comments/CommentActionButtons.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentActionButtons.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentActionButtons.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentActionButtons.ts#L13) +[src/parser/classes/comments/CommentActionButtons.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentActionButtons.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentActionButtons.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentActionButtons.ts#L12) +[src/parser/classes/comments/CommentActionButtons.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentActionButtons.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentActionButtons.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentActionButtons.ts#L14) +[src/parser/classes/comments/CommentActionButtons.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentActionButtons.ts#L14) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/comments/CommentActionButtons.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentActionButtons.ts#L10) +[src/parser/classes/comments/CommentActionButtons.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentActionButtons.ts#L10) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentDialog.md b/docs/api/namespaces/YTNodes/classes/CommentDialog.md index 99cca555..d45d504e 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentDialog.md +++ b/docs/api/namespaces/YTNodes/classes/CommentDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L21) +[src/parser/classes/comments/CommentDialog.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L14) +[src/parser/classes/comments/CommentDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L16) +[src/parser/classes/comments/CommentDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L13) +[src/parser/classes/comments/CommentDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L18) +[src/parser/classes/comments/CommentDialog.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L18) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L19) +[src/parser/classes/comments/CommentDialog.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L19) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L17) +[src/parser/classes/comments/CommentDialog.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L17) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L15) +[src/parser/classes/comments/CommentDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L15) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/comments/CommentDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentDialog.ts#L11) +[src/parser/classes/comments/CommentDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentDialog.ts#L11) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentReplies.md b/docs/api/namespaces/YTNodes/classes/CommentReplies.md index 6bb62efa..b998ed45 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentReplies.md +++ b/docs/api/namespaces/YTNodes/classes/CommentReplies.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplies.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplies.ts#L17) +[src/parser/classes/comments/CommentReplies.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplies.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplies.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplies.ts#L11) +[src/parser/classes/comments/CommentReplies.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplies.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplies.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplies.ts#L15) +[src/parser/classes/comments/CommentReplies.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplies.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplies.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplies.ts#L13) +[src/parser/classes/comments/CommentReplies.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplies.ts#L13) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplies.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplies.ts#L12) +[src/parser/classes/comments/CommentReplies.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplies.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplies.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplies.ts#L14) +[src/parser/classes/comments/CommentReplies.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplies.ts#L14) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplies.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplies.ts#L9) +[src/parser/classes/comments/CommentReplies.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplies.ts#L9) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md b/docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md index 521a3d51..c0f6b016 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md +++ b/docs/api/namespaces/YTNodes/classes/CommentReplyDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplyDialog.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplyDialog.ts#L18) +[src/parser/classes/comments/CommentReplyDialog.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplyDialog.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplyDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplyDialog.ts#L14) +[src/parser/classes/comments/CommentReplyDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplyDialog.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplyDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplyDialog.ts#L13) +[src/parser/classes/comments/CommentReplyDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplyDialog.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplyDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplyDialog.ts#L16) +[src/parser/classes/comments/CommentReplyDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplyDialog.ts#L16) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplyDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplyDialog.ts#L15) +[src/parser/classes/comments/CommentReplyDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplyDialog.ts#L15) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplyDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplyDialog.ts#L12) +[src/parser/classes/comments/CommentReplyDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplyDialog.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/comments/CommentReplyDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentReplyDialog.ts#L10) +[src/parser/classes/comments/CommentReplyDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentReplyDialog.ts#L10) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentSimplebox.md b/docs/api/namespaces/YTNodes/classes/CommentSimplebox.md index 9526cac8..dceb1487 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentSimplebox.md +++ b/docs/api/namespaces/YTNodes/classes/CommentSimplebox.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentSimplebox.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentSimplebox.ts#L18) +[src/parser/classes/comments/CommentSimplebox.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentSimplebox.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentSimplebox.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentSimplebox.ts#L14) +[src/parser/classes/comments/CommentSimplebox.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentSimplebox.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentSimplebox.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentSimplebox.ts#L16) +[src/parser/classes/comments/CommentSimplebox.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentSimplebox.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentSimplebox.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentSimplebox.ts#L13) +[src/parser/classes/comments/CommentSimplebox.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentSimplebox.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentSimplebox.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentSimplebox.ts#L15) +[src/parser/classes/comments/CommentSimplebox.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentSimplebox.ts#L15) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/CommentSimplebox.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentSimplebox.ts#L12) +[src/parser/classes/comments/CommentSimplebox.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentSimplebox.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/comments/CommentSimplebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentSimplebox.ts#L10) +[src/parser/classes/comments/CommentSimplebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentSimplebox.ts#L10) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentThread.md b/docs/api/namespaces/YTNodes/classes/CommentThread.md index da7553c1..d46a6067 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentThread.md +++ b/docs/api/namespaces/YTNodes/classes/CommentThread.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L27) +[src/parser/classes/comments/CommentThread.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L27) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L21) +[src/parser/classes/comments/CommentThread.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L21) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L23) +[src/parser/classes/comments/CommentThread.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L23) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L25) +[src/parser/classes/comments/CommentThread.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L25) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L24) +[src/parser/classes/comments/CommentThread.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L24) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L22) +[src/parser/classes/comments/CommentThread.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L22) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L16) +[src/parser/classes/comments/CommentThread.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L16) ## Accessors @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/comments/CommentThread.ts:103](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L103) +[src/parser/classes/comments/CommentThread.ts:103](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L103) ## Methods @@ -138,17 +138,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -164,7 +172,7 @@ Retrieves next batch of replies. #### Defined in -[src/parser/classes/comments/CommentThread.ts:73](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L73) +[src/parser/classes/comments/CommentThread.ts:73](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L73) *** @@ -180,7 +188,7 @@ Retrieves replies to this comment thread. #### Defined in -[src/parser/classes/comments/CommentThread.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L43) +[src/parser/classes/comments/CommentThread.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L43) *** @@ -214,7 +222,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -248,7 +256,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -286,7 +294,7 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) *** @@ -304,4 +312,4 @@ If the node does not have the key #### Defined in -[src/parser/classes/comments/CommentThread.ts:109](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentThread.ts#L109) +[src/parser/classes/comments/CommentThread.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentThread.ts#L109) diff --git a/docs/api/namespaces/YTNodes/classes/CommentView.md b/docs/api/namespaces/YTNodes/classes/CommentView.md index 039c7aa7..d716e027 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentView.md +++ b/docs/api/namespaces/YTNodes/classes/CommentView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:50](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L50) +[src/parser/classes/comments/CommentView.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L50) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L44) +[src/parser/classes/comments/CommentView.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L44) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L36) +[src/parser/classes/comments/CommentView.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L36) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L24) +[src/parser/classes/comments/CommentView.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L24) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L34) +[src/parser/classes/comments/CommentView.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L34) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L19) +[src/parser/classes/comments/CommentView.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L19) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L47) +[src/parser/classes/comments/CommentView.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L47) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L48) +[src/parser/classes/comments/CommentView.ts:48](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L48) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L46) +[src/parser/classes/comments/CommentView.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L46) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L39) +[src/parser/classes/comments/CommentView.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L39) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L25) +[src/parser/classes/comments/CommentView.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L25) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L26) +[src/parser/classes/comments/CommentView.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L26) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L18) +[src/parser/classes/comments/CommentView.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L18) *** @@ -176,7 +176,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L37) +[src/parser/classes/comments/CommentView.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L37) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L40) +[src/parser/classes/comments/CommentView.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L40) *** @@ -204,7 +204,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L35) +[src/parser/classes/comments/CommentView.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L35) *** @@ -214,7 +214,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L22) +[src/parser/classes/comments/CommentView.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L22) *** @@ -224,7 +224,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L38) +[src/parser/classes/comments/CommentView.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L38) *** @@ -238,7 +238,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -248,7 +248,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L21) +[src/parser/classes/comments/CommentView.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L21) *** @@ -258,7 +258,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L20) +[src/parser/classes/comments/CommentView.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L20) *** @@ -272,7 +272,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L14) +[src/parser/classes/comments/CommentView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L14) ## Methods @@ -294,7 +294,7 @@ #### Defined in -[src/parser/classes/comments/CommentView.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L65) +[src/parser/classes/comments/CommentView.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L65) *** @@ -314,17 +314,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -346,7 +354,7 @@ If the Actions instance is not set for this comment or if the dislike command is #### Defined in -[src/parser/classes/comments/CommentView.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L127) +[src/parser/classes/comments/CommentView.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L127) *** @@ -380,7 +388,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -414,7 +422,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -452,7 +460,7 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) *** @@ -474,7 +482,7 @@ If the Actions instance is not set for this comment or if the like command is no #### Defined in -[src/parser/classes/comments/CommentView.ts:109](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L109) +[src/parser/classes/comments/CommentView.ts:109](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L109) *** @@ -502,7 +510,7 @@ If the Actions instance is not set for this comment or if the reply command is n #### Defined in -[src/parser/classes/comments/CommentView.ts:182](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L182) +[src/parser/classes/comments/CommentView.ts:182](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L182) *** @@ -520,7 +528,7 @@ If the Actions instance is not set for this comment or if the reply command is n #### Defined in -[src/parser/classes/comments/CommentView.ts:236](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L236) +[src/parser/classes/comments/CommentView.ts:236](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L236) *** @@ -548,7 +556,7 @@ if the Actions instance is not set for this comment or if the comment content is #### Defined in -[src/parser/classes/comments/CommentView.ts:211](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L211) +[src/parser/classes/comments/CommentView.ts:211](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L211) *** @@ -570,7 +578,7 @@ If the Actions instance is not set for this comment or if the undislike command #### Defined in -[src/parser/classes/comments/CommentView.ts:163](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L163) +[src/parser/classes/comments/CommentView.ts:163](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L163) *** @@ -592,4 +600,4 @@ If the Actions instance is not set for this comment or if the unlike command is #### Defined in -[src/parser/classes/comments/CommentView.ts:145](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentView.ts#L145) +[src/parser/classes/comments/CommentView.ts:145](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentView.ts#L145) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md b/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md index 21503208..b1102b3c 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md +++ b/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L19) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L19) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L13) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L16) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L12) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L17) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L17) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L14) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L14) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L15) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L15) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointHeader.ts#L10) +[src/parser/classes/comments/CommentsEntryPointHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointHeader.ts#L10) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md b/docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md index 5688dca3..51f2b6a6 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md +++ b/docs/api/namespaces/YTNodes/classes/CommentsEntryPointTeaser.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L12) +[src/parser/classes/comments/CommentsEntryPointTeaser.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L9) +[src/parser/classes/comments/CommentsEntryPointTeaser.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L10) +[src/parser/classes/comments/CommentsEntryPointTeaser.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/comments/CommentsEntryPointTeaser.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L7) +[src/parser/classes/comments/CommentsEntryPointTeaser.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsEntryPointTeaser.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsHeader.md b/docs/api/namespaces/YTNodes/classes/CommentsHeader.md index 28fbbe6d..9a4c9a02 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentsHeader.md +++ b/docs/api/namespaces/YTNodes/classes/CommentsHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L26) +[src/parser/classes/comments/CommentsHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L26) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L14) +[src/parser/classes/comments/CommentsHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L13) +[src/parser/classes/comments/CommentsHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L15) +[src/parser/classes/comments/CommentsHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L18) +[src/parser/classes/comments/CommentsHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L18) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L16) +[src/parser/classes/comments/CommentsHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L12) +[src/parser/classes/comments/CommentsHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L12) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/comments/CommentsHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsHeader.ts#L10) +[src/parser/classes/comments/CommentsHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsHeader.ts#L10) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md b/docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md index ea09c9dd..378cb588 100644 --- a/docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md +++ b/docs/api/namespaces/YTNodes/classes/CommentsSimplebox.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CommentsSimplebox.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsSimplebox.ts#L12) +[src/parser/classes/comments/CommentsSimplebox.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsSimplebox.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CommentsSimplebox.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsSimplebox.ts#L9) +[src/parser/classes/comments/CommentsSimplebox.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsSimplebox.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/CommentsSimplebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsSimplebox.ts#L10) +[src/parser/classes/comments/CommentsSimplebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsSimplebox.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/comments/CommentsSimplebox.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CommentsSimplebox.ts#L7) +[src/parser/classes/comments/CommentsSimplebox.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CommentsSimplebox.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CompactChannel.md b/docs/api/namespaces/YTNodes/classes/CompactChannel.md index 97b0ba83..05dcd600 100644 --- a/docs/api/namespaces/YTNodes/classes/CompactChannel.md +++ b/docs/api/namespaces/YTNodes/classes/CompactChannel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L21) +[src/parser/classes/CompactChannel.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L12) +[src/parser/classes/CompactChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L14) +[src/parser/classes/CompactChannel.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L17) +[src/parser/classes/CompactChannel.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L17) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L19) +[src/parser/classes/CompactChannel.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L19) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L16) +[src/parser/classes/CompactChannel.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L13) +[src/parser/classes/CompactChannel.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L13) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L11) +[src/parser/classes/CompactChannel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L11) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L18) +[src/parser/classes/CompactChannel.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L18) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L15) +[src/parser/classes/CompactChannel.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L15) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/CompactChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactChannel.ts#L9) +[src/parser/classes/CompactChannel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactChannel.ts#L9) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CompactLink.md b/docs/api/namespaces/YTNodes/classes/CompactLink.md index abbf1c75..7e9edc7f 100644 --- a/docs/api/namespaces/YTNodes/classes/CompactLink.md +++ b/docs/api/namespaces/YTNodes/classes/CompactLink.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CompactLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactLink.ts#L13) +[src/parser/classes/CompactLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactLink.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CompactLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactLink.ts#L10) +[src/parser/classes/CompactLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactLink.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CompactLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactLink.ts#L11) +[src/parser/classes/CompactLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactLink.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CompactLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactLink.ts#L9) +[src/parser/classes/CompactLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactLink.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/CompactLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactLink.ts#L7) +[src/parser/classes/CompactLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactLink.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CompactMix.md b/docs/api/namespaces/YTNodes/classes/CompactMix.md index 09eb5e37..65b5d718 100644 --- a/docs/api/namespaces/YTNodes/classes/CompactMix.md +++ b/docs/api/namespaces/YTNodes/classes/CompactMix.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CompactMix.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMix.ts#L7) +[src/parser/classes/CompactMix.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMix.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L15) +[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L15) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L23) +[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L23) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L24) +[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L24) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L20) +[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L20) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L13) +[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L13) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L22) +[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L22) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L21) +[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L21) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L25) +[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L25) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L17) +[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L17) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L16) +[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L16) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L14) +[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L14) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L18) +[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L18) *** @@ -222,7 +222,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L19) +[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L19) *** @@ -236,7 +236,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L26) +[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L26) *** @@ -250,7 +250,7 @@ #### Defined in -[src/parser/classes/CompactMix.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMix.ts#L5) +[src/parser/classes/CompactMix.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMix.ts#L5) ## Methods @@ -270,17 +270,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`Playlist`](Playlist.md).[`as`](Playlist.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -314,7 +322,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -348,7 +356,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -386,4 +394,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CompactMovie.md b/docs/api/namespaces/YTNodes/classes/CompactMovie.md index 8f9f524f..c9936195 100644 --- a/docs/api/namespaces/YTNodes/classes/CompactMovie.md +++ b/docs/api/namespaces/YTNodes/classes/CompactMovie.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L31) +[src/parser/classes/CompactMovie.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L31) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L19) +[src/parser/classes/CompactMovie.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L19) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L27) +[src/parser/classes/CompactMovie.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L27) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L21) +[src/parser/classes/CompactMovie.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L21) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L26) +[src/parser/classes/CompactMovie.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L26) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L14) +[src/parser/classes/CompactMovie.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L14) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L29) +[src/parser/classes/CompactMovie.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L29) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L18) +[src/parser/classes/CompactMovie.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L18) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L17) +[src/parser/classes/CompactMovie.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L17) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L15) +[src/parser/classes/CompactMovie.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L15) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L16) +[src/parser/classes/CompactMovie.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L16) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -158,7 +158,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L28) +[src/parser/classes/CompactMovie.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L28) *** @@ -172,7 +172,7 @@ #### Defined in -[src/parser/classes/CompactMovie.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactMovie.ts#L12) +[src/parser/classes/CompactMovie.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactMovie.ts#L12) ## Methods @@ -192,17 +192,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -236,7 +244,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -270,7 +278,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -308,4 +316,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CompactPlaylist.md b/docs/api/namespaces/YTNodes/classes/CompactPlaylist.md index 50a3e59a..42c1eac9 100644 --- a/docs/api/namespaces/YTNodes/classes/CompactPlaylist.md +++ b/docs/api/namespaces/YTNodes/classes/CompactPlaylist.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CompactPlaylist.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactPlaylist.ts#L7) +[src/parser/classes/CompactPlaylist.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactPlaylist.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L15) +[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L15) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L23) +[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L23) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L24) +[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L24) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L20) +[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L20) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L13) +[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L13) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L22) +[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L22) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L21) +[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L21) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L25) +[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L25) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L17) +[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L17) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L16) +[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L16) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L14) +[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L14) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L18) +[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L18) *** @@ -222,7 +222,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L19) +[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L19) *** @@ -236,7 +236,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L26) +[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L26) *** @@ -250,7 +250,7 @@ #### Defined in -[src/parser/classes/CompactPlaylist.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactPlaylist.ts#L5) +[src/parser/classes/CompactPlaylist.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactPlaylist.ts#L5) ## Methods @@ -270,17 +270,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`Playlist`](Playlist.md).[`as`](Playlist.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -314,7 +322,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -348,7 +356,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -386,4 +394,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CompactStation.md b/docs/api/namespaces/YTNodes/classes/CompactStation.md index 97c9be18..8f2ddcf9 100644 --- a/docs/api/namespaces/YTNodes/classes/CompactStation.md +++ b/docs/api/namespaces/YTNodes/classes/CompactStation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CompactStation.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactStation.ts#L16) +[src/parser/classes/CompactStation.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactStation.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CompactStation.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactStation.ts#L11) +[src/parser/classes/CompactStation.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactStation.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CompactStation.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactStation.ts#L13) +[src/parser/classes/CompactStation.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactStation.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CompactStation.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactStation.ts#L14) +[src/parser/classes/CompactStation.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactStation.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/CompactStation.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactStation.ts#L10) +[src/parser/classes/CompactStation.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactStation.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/CompactStation.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactStation.ts#L12) +[src/parser/classes/CompactStation.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactStation.ts#L12) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/CompactStation.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactStation.ts#L8) +[src/parser/classes/CompactStation.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactStation.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CompactVideo.md b/docs/api/namespaces/YTNodes/classes/CompactVideo.md index bb63d1c2..f05a5c89 100644 --- a/docs/api/namespaces/YTNodes/classes/CompactVideo.md +++ b/docs/api/namespaces/YTNodes/classes/CompactVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L33) +[src/parser/classes/CompactVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L33) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L18) +[src/parser/classes/CompactVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L18) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L22) +[src/parser/classes/CompactVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L22) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L24) +[src/parser/classes/CompactVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L24) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L30) +[src/parser/classes/CompactVideo.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L30) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L14) +[src/parser/classes/CompactVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L14) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L31) +[src/parser/classes/CompactVideo.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L31) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L21) +[src/parser/classes/CompactVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L21) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L16) +[src/parser/classes/CompactVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L16) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L20) +[src/parser/classes/CompactVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L20) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L29) +[src/parser/classes/CompactVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L29) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L15) +[src/parser/classes/CompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L15) *** @@ -154,7 +154,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L17) +[src/parser/classes/CompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L17) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -178,7 +178,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L19) +[src/parser/classes/CompactVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L19) *** @@ -192,7 +192,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L12) +[src/parser/classes/CompactVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L12) ## Accessors @@ -206,7 +206,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:59](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L59) +[src/parser/classes/CompactVideo.ts:59](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L59) *** @@ -220,7 +220,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L63) +[src/parser/classes/CompactVideo.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L63) *** @@ -234,7 +234,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:67](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L67) +[src/parser/classes/CompactVideo.ts:67](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L67) *** @@ -248,7 +248,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:74](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L74) +[src/parser/classes/CompactVideo.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L74) *** @@ -262,7 +262,7 @@ #### Defined in -[src/parser/classes/CompactVideo.ts:78](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L78) +[src/parser/classes/CompactVideo.ts:78](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L78) ## Methods @@ -282,17 +282,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -326,7 +334,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -360,7 +368,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -398,4 +406,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ConfirmDialog.md b/docs/api/namespaces/YTNodes/classes/ConfirmDialog.md index 1c4ffa51..c40926ba 100644 --- a/docs/api/namespaces/YTNodes/classes/ConfirmDialog.md +++ b/docs/api/namespaces/YTNodes/classes/ConfirmDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ConfirmDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConfirmDialog.ts#L14) +[src/parser/classes/ConfirmDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConfirmDialog.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ConfirmDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConfirmDialog.ts#L11) +[src/parser/classes/ConfirmDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConfirmDialog.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ConfirmDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConfirmDialog.ts#L10) +[src/parser/classes/ConfirmDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConfirmDialog.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ConfirmDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConfirmDialog.ts#L12) +[src/parser/classes/ConfirmDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConfirmDialog.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ConfirmDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConfirmDialog.ts#L9) +[src/parser/classes/ConfirmDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConfirmDialog.ts#L9) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ConfirmDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConfirmDialog.ts#L7) +[src/parser/classes/ConfirmDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConfirmDialog.ts#L7) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ContentMetadataView.md b/docs/api/namespaces/YTNodes/classes/ContentMetadataView.md index c5023d89..e3618996 100644 --- a/docs/api/namespaces/YTNodes/classes/ContentMetadataView.md +++ b/docs/api/namespaces/YTNodes/classes/ContentMetadataView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ContentMetadataView.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentMetadataView.ts#L17) +[src/parser/classes/ContentMetadataView.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentMetadataView.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ContentMetadataView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentMetadataView.ts#L15) +[src/parser/classes/ContentMetadataView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentMetadataView.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ContentMetadataView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentMetadataView.ts#L14) +[src/parser/classes/ContentMetadataView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentMetadataView.ts#L14) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ContentMetadataView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentMetadataView.ts#L12) +[src/parser/classes/ContentMetadataView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentMetadataView.ts#L12) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md b/docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md index 5e1ce5de..e3208a04 100644 --- a/docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md +++ b/docs/api/namespaces/YTNodes/classes/ContentPreviewImageView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ContentPreviewImageView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentPreviewImageView.ts#L11) +[src/parser/classes/ContentPreviewImageView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentPreviewImageView.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ContentPreviewImageView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentPreviewImageView.ts#L8) +[src/parser/classes/ContentPreviewImageView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentPreviewImageView.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ContentPreviewImageView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentPreviewImageView.ts#L9) +[src/parser/classes/ContentPreviewImageView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentPreviewImageView.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ContentPreviewImageView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContentPreviewImageView.ts#L6) +[src/parser/classes/ContentPreviewImageView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContentPreviewImageView.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ContinuationCommand.md b/docs/api/namespaces/YTNodes/classes/ContinuationCommand.md new file mode 100644 index 00000000..efe5abad --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ContinuationCommand.md @@ -0,0 +1,241 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ContinuationItem.md b/docs/api/namespaces/YTNodes/classes/ContinuationItem.md index 82bc5d3a..f5cbf682 100644 --- a/docs/api/namespaces/YTNodes/classes/ContinuationItem.md +++ b/docs/api/namespaces/YTNodes/classes/ContinuationItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ContinuationItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContinuationItem.ts#L13) +[src/parser/classes/ContinuationItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContinuationItem.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ContinuationItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContinuationItem.ts#L10) +[src/parser/classes/ContinuationItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContinuationItem.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ContinuationItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContinuationItem.ts#L11) +[src/parser/classes/ContinuationItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContinuationItem.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ContinuationItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContinuationItem.ts#L9) +[src/parser/classes/ContinuationItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContinuationItem.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ContinuationItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ContinuationItem.ts#L7) +[src/parser/classes/ContinuationItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ContinuationItem.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ConversationBar.md b/docs/api/namespaces/YTNodes/classes/ConversationBar.md index 01060d2c..9b876017 100644 --- a/docs/api/namespaces/YTNodes/classes/ConversationBar.md +++ b/docs/api/namespaces/YTNodes/classes/ConversationBar.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ConversationBar.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConversationBar.ts#L10) +[src/parser/classes/ConversationBar.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConversationBar.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ConversationBar.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConversationBar.ts#L8) +[src/parser/classes/ConversationBar.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConversationBar.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ConversationBar.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ConversationBar.ts#L6) +[src/parser/classes/ConversationBar.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ConversationBar.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CopyLink.md b/docs/api/namespaces/YTNodes/classes/CopyLink.md index 11848230..855134a2 100644 --- a/docs/api/namespaces/YTNodes/classes/CopyLink.md +++ b/docs/api/namespaces/YTNodes/classes/CopyLink.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CopyLink.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CopyLink.ts#L12) +[src/parser/classes/CopyLink.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CopyLink.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CopyLink.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CopyLink.ts#L8) +[src/parser/classes/CopyLink.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CopyLink.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CopyLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CopyLink.ts#L9) +[src/parser/classes/CopyLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CopyLink.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CopyLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CopyLink.ts#L10) +[src/parser/classes/CopyLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CopyLink.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/CopyLink.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CopyLink.ts#L6) +[src/parser/classes/CopyLink.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CopyLink.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CreateCommentEndpoint.md b/docs/api/namespaces/YTNodes/classes/CreateCommentEndpoint.md new file mode 100644 index 00000000..aefff424 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/CreateCommentEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreateCommentEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreateCommentEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreateCommentEndpoint.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/CreateCommentEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreateCommentEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md b/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md index 47fb9dee..8877b901 100644 --- a/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md +++ b/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/CreatePlaylistDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CreatePlaylistDialog.ts#L16) +[src/parser/classes/CreatePlaylistDialog.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CreatePlaylistDialog.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/CreatePlaylistDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CreatePlaylistDialog.ts#L13) +[src/parser/classes/CreatePlaylistDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CreatePlaylistDialog.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/CreatePlaylistDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CreatePlaylistDialog.ts#L14) +[src/parser/classes/CreatePlaylistDialog.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CreatePlaylistDialog.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/CreatePlaylistDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CreatePlaylistDialog.ts#L12) +[src/parser/classes/CreatePlaylistDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CreatePlaylistDialog.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/CreatePlaylistDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CreatePlaylistDialog.ts#L10) +[src/parser/classes/CreatePlaylistDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CreatePlaylistDialog.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/CreatePlaylistDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CreatePlaylistDialog.ts#L11) +[src/parser/classes/CreatePlaylistDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CreatePlaylistDialog.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/CreatePlaylistDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CreatePlaylistDialog.ts#L8) +[src/parser/classes/CreatePlaylistDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CreatePlaylistDialog.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialogFormView.md b/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialogFormView.md new file mode 100644 index 00000000..b3f6755c --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/CreatePlaylistDialogFormView.md @@ -0,0 +1,261 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CreatePlaylistServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/CreatePlaylistServiceEndpoint.md new file mode 100644 index 00000000..43725c49 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/CreatePlaylistServiceEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.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/CreatePlaylistServiceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/CreatePlaylistServiceEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CreatorHeart.md b/docs/api/namespaces/YTNodes/classes/CreatorHeart.md index 175fd2ae..aae26952 100644 --- a/docs/api/namespaces/YTNodes/classes/CreatorHeart.md +++ b/docs/api/namespaces/YTNodes/classes/CreatorHeart.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L20) +[src/parser/classes/comments/CreatorHeart.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L8) +[src/parser/classes/comments/CreatorHeart.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L8) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L10) +[src/parser/classes/comments/CreatorHeart.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L10) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L9) +[src/parser/classes/comments/CreatorHeart.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L9) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L15) +[src/parser/classes/comments/CreatorHeart.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L15) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L17) +[src/parser/classes/comments/CreatorHeart.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L17) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L16) +[src/parser/classes/comments/CreatorHeart.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L16) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L18) +[src/parser/classes/comments/CreatorHeart.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L18) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -132,7 +132,7 @@ #### Defined in -[src/parser/classes/comments/CreatorHeart.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/CreatorHeart.ts#L6) +[src/parser/classes/comments/CreatorHeart.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/CreatorHeart.ts#L6) ## Methods @@ -152,17 +152,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -196,7 +204,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -230,7 +238,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -268,4 +276,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/CtaGoToCreatorStudio.md b/docs/api/namespaces/YTNodes/classes/CtaGoToCreatorStudio.md index 4c578661..49c3a5ae 100644 --- a/docs/api/namespaces/YTNodes/classes/CtaGoToCreatorStudio.md +++ b/docs/api/namespaces/YTNodes/classes/CtaGoToCreatorStudio.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L10) +[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L7) +[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L8) +[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L5) +[src/parser/classes/analytics/CtaGoToCreatorStudio.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/CtaGoToCreatorStudio.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DataModelSection.md b/docs/api/namespaces/YTNodes/classes/DataModelSection.md index 96d74b31..8a23f4de 100644 --- a/docs/api/namespaces/YTNodes/classes/DataModelSection.md +++ b/docs/api/namespaces/YTNodes/classes/DataModelSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/DataModelSection.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/DataModelSection.ts#L40) +[src/parser/classes/analytics/DataModelSection.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/DataModelSection.ts#L40) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/analytics/DataModelSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/DataModelSection.ts#L11) +[src/parser/classes/analytics/DataModelSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/DataModelSection.ts#L11) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/analytics/DataModelSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/DataModelSection.ts#L9) +[src/parser/classes/analytics/DataModelSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/DataModelSection.ts#L9) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/analytics/DataModelSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/DataModelSection.ts#L15) +[src/parser/classes/analytics/DataModelSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/DataModelSection.ts#L15) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/analytics/DataModelSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/DataModelSection.ts#L8) +[src/parser/classes/analytics/DataModelSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/DataModelSection.ts#L8) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/classes/analytics/DataModelSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/DataModelSection.ts#L7) +[src/parser/classes/analytics/DataModelSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/DataModelSection.ts#L7) *** @@ -154,7 +154,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/classes/analytics/DataModelSection.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/DataModelSection.ts#L5) +[src/parser/classes/analytics/DataModelSection.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/DataModelSection.ts#L5) ## Methods @@ -188,17 +188,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -232,7 +240,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -266,7 +274,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -304,4 +312,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md b/docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md index baa07c82..91caec0d 100644 --- a/docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md +++ b/docs/api/namespaces/YTNodes/classes/DecoratedAvatarView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DecoratedAvatarView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedAvatarView.ts#L13) +[src/parser/classes/DecoratedAvatarView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedAvatarView.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DecoratedAvatarView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedAvatarView.ts#L10) +[src/parser/classes/DecoratedAvatarView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedAvatarView.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DecoratedAvatarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedAvatarView.ts#L9) +[src/parser/classes/DecoratedAvatarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedAvatarView.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/DecoratedAvatarView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedAvatarView.ts#L11) +[src/parser/classes/DecoratedAvatarView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedAvatarView.ts#L11) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/DecoratedAvatarView.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedAvatarView.ts#L7) +[src/parser/classes/DecoratedAvatarView.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedAvatarView.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md b/docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md index ce3c5624..8d9dfb55 100644 --- a/docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md +++ b/docs/api/namespaces/YTNodes/classes/DecoratedPlayerBar.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DecoratedPlayerBar.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedPlayerBar.ts#L13) +[src/parser/classes/DecoratedPlayerBar.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedPlayerBar.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DecoratedPlayerBar.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedPlayerBar.ts#L10) +[src/parser/classes/DecoratedPlayerBar.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedPlayerBar.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DecoratedPlayerBar.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedPlayerBar.ts#L11) +[src/parser/classes/DecoratedPlayerBar.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedPlayerBar.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/DecoratedPlayerBar.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DecoratedPlayerBar.ts#L8) +[src/parser/classes/DecoratedPlayerBar.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DecoratedPlayerBar.ts#L8) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md b/docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md index 49b58e7a..87e7ae1a 100644 --- a/docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md +++ b/docs/api/namespaces/YTNodes/classes/DefaultPromoPanel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L21) +[src/parser/classes/DefaultPromoPanel.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L10) +[src/parser/classes/DefaultPromoPanel.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L11) +[src/parser/classes/DefaultPromoPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L12) +[src/parser/classes/DefaultPromoPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L18) +[src/parser/classes/DefaultPromoPanel.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L18) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L15) +[src/parser/classes/DefaultPromoPanel.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L15) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L16) +[src/parser/classes/DefaultPromoPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L16) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L19) +[src/parser/classes/DefaultPromoPanel.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L19) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L14) +[src/parser/classes/DefaultPromoPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L14) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L17) +[src/parser/classes/DefaultPromoPanel.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L17) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L13) +[src/parser/classes/DefaultPromoPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L13) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L9) +[src/parser/classes/DefaultPromoPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L9) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/DefaultPromoPanel.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DefaultPromoPanel.ts#L7) +[src/parser/classes/DefaultPromoPanel.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DefaultPromoPanel.ts#L7) ## Methods @@ -184,17 +184,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -228,7 +236,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -262,7 +270,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -300,4 +308,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DeletePlaylistEndpoint.md b/docs/api/namespaces/YTNodes/classes/DeletePlaylistEndpoint.md new file mode 100644 index 00000000..95d258dc --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/DeletePlaylistEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/DeletePlaylistEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/DeletePlaylistEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/DeletePlaylistEndpoint.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/DeletePlaylistEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/DeletePlaylistEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md b/docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md index d6208751..cfd526a2 100644 --- a/docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md +++ b/docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DescriptionPreviewView.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DescriptionPreviewView.ts#L24) +[src/parser/classes/DescriptionPreviewView.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DescriptionPreviewView.ts#L24) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DescriptionPreviewView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DescriptionPreviewView.ts#L12) +[src/parser/classes/DescriptionPreviewView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DescriptionPreviewView.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DescriptionPreviewView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DescriptionPreviewView.ts#L9) +[src/parser/classes/DescriptionPreviewView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DescriptionPreviewView.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/DescriptionPreviewView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DescriptionPreviewView.ts#L10) +[src/parser/classes/DescriptionPreviewView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DescriptionPreviewView.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/DescriptionPreviewView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DescriptionPreviewView.ts#L13) +[src/parser/classes/DescriptionPreviewView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DescriptionPreviewView.ts#L13) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/DescriptionPreviewView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DescriptionPreviewView.ts#L11) +[src/parser/classes/DescriptionPreviewView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DescriptionPreviewView.ts#L11) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/DescriptionPreviewView.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DescriptionPreviewView.ts#L7) +[src/parser/classes/DescriptionPreviewView.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DescriptionPreviewView.ts#L7) ## Methods @@ -148,17 +148,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -192,7 +200,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -226,7 +234,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -264,4 +272,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DialogHeaderView.md b/docs/api/namespaces/YTNodes/classes/DialogHeaderView.md new file mode 100644 index 00000000..4bfec551 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/DialogHeaderView.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DialogHeaderView + +# Class: DialogHeaderView + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new DialogHeaderView() + +> **new DialogHeaderView**(`data`): [`DialogHeaderView`](DialogHeaderView.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`DialogHeaderView`](DialogHeaderView.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/DialogHeaderView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogHeaderView.ts#L10) + +## Properties + +### headline + +> **headline**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/DialogHeaderView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogHeaderView.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'DialogHeaderView'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/DialogHeaderView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogHeaderView.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is DialogHeaderView & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is DialogHeaderView & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DialogView.md b/docs/api/namespaces/YTNodes/classes/DialogView.md new file mode 100644 index 00000000..67957521 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/DialogView.md @@ -0,0 +1,231 @@ +[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:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogView.ts#L14) + +## Properties + +### custom\_content + +> **custom\_content**: `null` \| [`CreatePlaylistDialogFormView`](CreatePlaylistDialogFormView.md) + +#### Defined in + +[src/parser/classes/DialogView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogView.ts#L12) + +*** + +### footer + +> **footer**: `null` \| [`FormFooterView`](FormFooterView.md) + +#### Defined in + +[src/parser/classes/DialogView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogView.ts#L11) + +*** + +### header + +> **header**: `null` \| [`DialogHeaderView`](DialogHeaderView.md) + +#### Defined in + +[src/parser/classes/DialogView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogView.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/fc5571629eca037af7de03f4b903da6add1f300b/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:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DialogView.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DidYouMean.md b/docs/api/namespaces/YTNodes/classes/DidYouMean.md index 86f1a4b9..bada5fdf 100644 --- a/docs/api/namespaces/YTNodes/classes/DidYouMean.md +++ b/docs/api/namespaces/YTNodes/classes/DidYouMean.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DidYouMean.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DidYouMean.ts#L13) +[src/parser/classes/DidYouMean.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DidYouMean.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DidYouMean.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DidYouMean.ts#L10) +[src/parser/classes/DidYouMean.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DidYouMean.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DidYouMean.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DidYouMean.ts#L11) +[src/parser/classes/DidYouMean.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DidYouMean.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/DidYouMean.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DidYouMean.ts#L9) +[src/parser/classes/DidYouMean.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DidYouMean.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/DidYouMean.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DidYouMean.ts#L7) +[src/parser/classes/DidYouMean.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DidYouMean.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DimChatItemAction.md b/docs/api/namespaces/YTNodes/classes/DimChatItemAction.md index 0312e894..4e89600e 100644 --- a/docs/api/namespaces/YTNodes/classes/DimChatItemAction.md +++ b/docs/api/namespaces/YTNodes/classes/DimChatItemAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/DimChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/DimChatItemAction.ts#L9) +[src/parser/classes/livechat/DimChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/DimChatItemAction.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/DimChatItemAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/DimChatItemAction.ts#L7) +[src/parser/classes/livechat/DimChatItemAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/DimChatItemAction.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/DimChatItemAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/DimChatItemAction.ts#L5) +[src/parser/classes/livechat/DimChatItemAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/DimChatItemAction.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DislikeButtonView.md b/docs/api/namespaces/YTNodes/classes/DislikeButtonView.md index b4bd61e3..c94c7d4e 100644 --- a/docs/api/namespaces/YTNodes/classes/DislikeButtonView.md +++ b/docs/api/namespaces/YTNodes/classes/DislikeButtonView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DislikeButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DislikeButtonView.ts#L11) +[src/parser/classes/DislikeButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DislikeButtonView.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DislikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DislikeButtonView.ts#L9) +[src/parser/classes/DislikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DislikeButtonView.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DislikeButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DislikeButtonView.ts#L8) +[src/parser/classes/DislikeButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DislikeButtonView.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/DislikeButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DislikeButtonView.ts#L6) +[src/parser/classes/DislikeButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DislikeButtonView.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DownloadButton.md b/docs/api/namespaces/YTNodes/classes/DownloadButton.md index ac520ccb..6163f42b 100644 --- a/docs/api/namespaces/YTNodes/classes/DownloadButton.md +++ b/docs/api/namespaces/YTNodes/classes/DownloadButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DownloadButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DownloadButton.ts#L13) +[src/parser/classes/DownloadButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DownloadButton.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DownloadButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DownloadButton.ts#L10) +[src/parser/classes/DownloadButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DownloadButton.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DownloadButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DownloadButton.ts#L9) +[src/parser/classes/DownloadButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DownloadButton.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/DownloadButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DownloadButton.ts#L8) +[src/parser/classes/DownloadButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DownloadButton.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/DownloadButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DownloadButton.ts#L11) +[src/parser/classes/DownloadButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DownloadButton.ts#L11) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/DownloadButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DownloadButton.ts#L6) +[src/parser/classes/DownloadButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DownloadButton.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Dropdown.md b/docs/api/namespaces/YTNodes/classes/Dropdown.md index 325e7c2d..b6388274 100644 --- a/docs/api/namespaces/YTNodes/classes/Dropdown.md +++ b/docs/api/namespaces/YTNodes/classes/Dropdown.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Dropdown.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Dropdown.ts#L11) +[src/parser/classes/Dropdown.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Dropdown.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Dropdown.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Dropdown.ts#L9) +[src/parser/classes/Dropdown.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Dropdown.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Dropdown.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Dropdown.ts#L8) +[src/parser/classes/Dropdown.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Dropdown.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/Dropdown.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Dropdown.ts#L6) +[src/parser/classes/Dropdown.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Dropdown.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DropdownItem.md b/docs/api/namespaces/YTNodes/classes/DropdownItem.md index 97a0f19b..120fab95 100644 --- a/docs/api/namespaces/YTNodes/classes/DropdownItem.md +++ b/docs/api/namespaces/YTNodes/classes/DropdownItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L16) +[src/parser/classes/DropdownItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L13) +[src/parser/classes/DropdownItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L14) +[src/parser/classes/DropdownItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L12) +[src/parser/classes/DropdownItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L9) +[src/parser/classes/DropdownItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L9) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L10) +[src/parser/classes/DropdownItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L11) +[src/parser/classes/DropdownItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L11) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/DropdownItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DropdownItem.ts#L7) +[src/parser/classes/DropdownItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownItem.ts#L7) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DropdownView.md b/docs/api/namespaces/YTNodes/classes/DropdownView.md new file mode 100644 index 00000000..94526933 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/DropdownView.md @@ -0,0 +1,261 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DropdownView.ts#L24) + +*** + +### id + +> **id**: `string` + +#### Defined in + +[src/parser/classes/DropdownView.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/DynamicTextView.md b/docs/api/namespaces/YTNodes/classes/DynamicTextView.md index 5cfe0c43..4d324f30 100644 --- a/docs/api/namespaces/YTNodes/classes/DynamicTextView.md +++ b/docs/api/namespaces/YTNodes/classes/DynamicTextView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/DynamicTextView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DynamicTextView.ts#L11) +[src/parser/classes/DynamicTextView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DynamicTextView.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/DynamicTextView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DynamicTextView.ts#L9) +[src/parser/classes/DynamicTextView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DynamicTextView.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/DynamicTextView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DynamicTextView.ts#L8) +[src/parser/classes/DynamicTextView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DynamicTextView.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/DynamicTextView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/DynamicTextView.ts#L6) +[src/parser/classes/DynamicTextView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/DynamicTextView.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Element.md b/docs/api/namespaces/YTNodes/classes/Element.md index fc8b3f58..2786d2cd 100644 --- a/docs/api/namespaces/YTNodes/classes/Element.md +++ b/docs/api/namespaces/YTNodes/classes/Element.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Element.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Element.ts#L11) +[src/parser/classes/Element.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Element.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Element.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Element.ts#L9) +[src/parser/classes/Element.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Element.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Element.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Element.ts#L8) +[src/parser/classes/Element.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Element.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/Element.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Element.ts#L6) +[src/parser/classes/Element.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Element.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md b/docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md index 0aa03b42..1be029ee 100644 --- a/docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md +++ b/docs/api/namespaces/YTNodes/classes/EmergencyOnebox.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EmergencyOnebox.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmergencyOnebox.ts#L13) +[src/parser/classes/EmergencyOnebox.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmergencyOnebox.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EmergencyOnebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmergencyOnebox.ts#L10) +[src/parser/classes/EmergencyOnebox.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmergencyOnebox.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EmergencyOnebox.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmergencyOnebox.ts#L11) +[src/parser/classes/EmergencyOnebox.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmergencyOnebox.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/EmergencyOnebox.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmergencyOnebox.ts#L9) +[src/parser/classes/EmergencyOnebox.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmergencyOnebox.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/EmergencyOnebox.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmergencyOnebox.ts#L7) +[src/parser/classes/EmergencyOnebox.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmergencyOnebox.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPicker.md b/docs/api/namespaces/YTNodes/classes/EmojiPicker.md index 1cf9ac5e..92e980b6 100644 --- a/docs/api/namespaces/YTNodes/classes/EmojiPicker.md +++ b/docs/api/namespaces/YTNodes/classes/EmojiPicker.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L23) +[src/parser/classes/comments/EmojiPicker.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L10) +[src/parser/classes/comments/EmojiPicker.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L11) +[src/parser/classes/comments/EmojiPicker.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L15) +[src/parser/classes/comments/EmojiPicker.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L9) +[src/parser/classes/comments/EmojiPicker.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L9) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L14) +[src/parser/classes/comments/EmojiPicker.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L14) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L13) +[src/parser/classes/comments/EmojiPicker.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L13) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L12) +[src/parser/classes/comments/EmojiPicker.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L12) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L21) +[src/parser/classes/comments/EmojiPicker.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L21) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L16) +[src/parser/classes/comments/EmojiPicker.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L16) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L17) +[src/parser/classes/comments/EmojiPicker.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L17) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L20) +[src/parser/classes/comments/EmojiPicker.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L20) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L19) +[src/parser/classes/comments/EmojiPicker.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L19) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L18) +[src/parser/classes/comments/EmojiPicker.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L18) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -184,7 +184,7 @@ #### Defined in -[src/parser/classes/comments/EmojiPicker.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/EmojiPicker.ts#L7) +[src/parser/classes/comments/EmojiPicker.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/EmojiPicker.ts#L7) ## Methods @@ -204,17 +204,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -248,7 +256,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -282,7 +290,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -320,4 +328,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md b/docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md index e8332702..ecb94cc9 100644 --- a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md +++ b/docs/api/namespaces/YTNodes/classes/EmojiPickerCategory.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategory.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategory.ts#L14) +[src/parser/classes/EmojiPickerCategory.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategory.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategory.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategory.ts#L8) +[src/parser/classes/EmojiPickerCategory.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategory.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategory.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategory.ts#L12) +[src/parser/classes/EmojiPickerCategory.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategory.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategory.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategory.ts#L10) +[src/parser/classes/EmojiPickerCategory.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategory.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategory.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategory.ts#L11) +[src/parser/classes/EmojiPickerCategory.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategory.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategory.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategory.ts#L9) +[src/parser/classes/EmojiPickerCategory.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategory.ts#L9) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategory.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategory.ts#L6) +[src/parser/classes/EmojiPickerCategory.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategory.ts#L6) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md b/docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md index 081f1480..f375482b 100644 --- a/docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md +++ b/docs/api/namespaces/YTNodes/classes/EmojiPickerCategoryButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategoryButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategoryButton.ts#L11) +[src/parser/classes/EmojiPickerCategoryButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategoryButton.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategoryButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategoryButton.ts#L7) +[src/parser/classes/EmojiPickerCategoryButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategoryButton.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategoryButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategoryButton.ts#L8) +[src/parser/classes/EmojiPickerCategoryButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategoryButton.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategoryButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategoryButton.ts#L9) +[src/parser/classes/EmojiPickerCategoryButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategoryButton.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/EmojiPickerCategoryButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerCategoryButton.ts#L5) +[src/parser/classes/EmojiPickerCategoryButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerCategoryButton.ts#L5) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md b/docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md index cbd57634..e05bf3d1 100644 --- a/docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md +++ b/docs/api/namespaces/YTNodes/classes/EmojiPickerUpsellCategory.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L16) +[src/parser/classes/EmojiPickerUpsellCategory.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L9) +[src/parser/classes/EmojiPickerUpsellCategory.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L14) +[src/parser/classes/EmojiPickerUpsellCategory.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L12) +[src/parser/classes/EmojiPickerUpsellCategory.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L13) +[src/parser/classes/EmojiPickerUpsellCategory.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L10) +[src/parser/classes/EmojiPickerUpsellCategory.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L11) +[src/parser/classes/EmojiPickerUpsellCategory.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L11) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/EmojiPickerUpsellCategory.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EmojiPickerUpsellCategory.ts#L7) +[src/parser/classes/EmojiPickerUpsellCategory.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EmojiPickerUpsellCategory.ts#L7) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md b/docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md index d4c93672..73e5dadd 100644 --- a/docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md +++ b/docs/api/namespaces/YTNodes/classes/EndScreenPlaylist.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L17) +[src/parser/classes/EndScreenPlaylist.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L12) +[src/parser/classes/EndScreenPlaylist.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L13) +[src/parser/classes/EndScreenPlaylist.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L10) +[src/parser/classes/EndScreenPlaylist.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L14) +[src/parser/classes/EndScreenPlaylist.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L11) +[src/parser/classes/EndScreenPlaylist.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L15) +[src/parser/classes/EndScreenPlaylist.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L15) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/EndScreenPlaylist.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenPlaylist.ts#L8) +[src/parser/classes/EndScreenPlaylist.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenPlaylist.ts#L8) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EndScreenVideo.md b/docs/api/namespaces/YTNodes/classes/EndScreenVideo.md index 971bc419..a72643f8 100644 --- a/docs/api/namespaces/YTNodes/classes/EndScreenVideo.md +++ b/docs/api/namespaces/YTNodes/classes/EndScreenVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L24) +[src/parser/classes/EndScreenVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L24) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L15) +[src/parser/classes/EndScreenVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L18) +[src/parser/classes/EndScreenVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L18) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L19) +[src/parser/classes/EndScreenVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L19) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L16) +[src/parser/classes/EndScreenVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L16) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L11) +[src/parser/classes/EndScreenVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L11) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L17) +[src/parser/classes/EndScreenVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L17) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L14) +[src/parser/classes/EndScreenVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L14) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L13) +[src/parser/classes/EndScreenVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L13) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L12) +[src/parser/classes/EndScreenVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L12) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/classes/EndScreenVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndScreenVideo.ts#L9) +[src/parser/classes/EndScreenVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndScreenVideo.ts#L9) ## Methods @@ -172,17 +172,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -216,7 +224,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -250,7 +258,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -288,4 +296,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Endscreen.md b/docs/api/namespaces/YTNodes/classes/Endscreen.md index 07a2db74..caf8b0aa 100644 --- a/docs/api/namespaces/YTNodes/classes/Endscreen.md +++ b/docs/api/namespaces/YTNodes/classes/Endscreen.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Endscreen.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Endscreen.ts#L10) +[src/parser/classes/Endscreen.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Endscreen.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Endscreen.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Endscreen.ts#L7) +[src/parser/classes/Endscreen.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Endscreen.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Endscreen.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Endscreen.ts#L8) +[src/parser/classes/Endscreen.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Endscreen.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/Endscreen.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Endscreen.ts#L5) +[src/parser/classes/Endscreen.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Endscreen.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EndscreenElement.md b/docs/api/namespaces/YTNodes/classes/EndscreenElement.md index e3ca4398..f83aab5e 100644 --- a/docs/api/namespaces/YTNodes/classes/EndscreenElement.md +++ b/docs/api/namespaces/YTNodes/classes/EndscreenElement.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L29) +[src/parser/classes/EndscreenElement.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L29) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L24) +[src/parser/classes/EndscreenElement.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L24) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L16) +[src/parser/classes/EndscreenElement.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L26) +[src/parser/classes/EndscreenElement.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L26) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L12) +[src/parser/classes/EndscreenElement.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L17) +[src/parser/classes/EndscreenElement.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L17) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L14) +[src/parser/classes/EndscreenElement.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L14) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L27) +[src/parser/classes/EndscreenElement.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L27) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L13) +[src/parser/classes/EndscreenElement.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L13) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L18) +[src/parser/classes/EndscreenElement.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L18) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L21) +[src/parser/classes/EndscreenElement.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L21) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L15) +[src/parser/classes/EndscreenElement.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L15) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L19) +[src/parser/classes/EndscreenElement.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L19) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L25) +[src/parser/classes/EndscreenElement.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L25) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L10) +[src/parser/classes/EndscreenElement.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L10) *** @@ -176,7 +176,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L20) +[src/parser/classes/EndscreenElement.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L20) *** @@ -186,7 +186,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L11) +[src/parser/classes/EndscreenElement.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L11) *** @@ -196,7 +196,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L22) +[src/parser/classes/EndscreenElement.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L22) *** @@ -210,7 +210,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -220,7 +220,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L23) +[src/parser/classes/EndscreenElement.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L23) *** @@ -234,7 +234,7 @@ #### Defined in -[src/parser/classes/EndscreenElement.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EndscreenElement.ts#L8) +[src/parser/classes/EndscreenElement.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EndscreenElement.ts#L8) ## Methods @@ -254,17 +254,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -298,7 +306,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -332,7 +340,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -370,4 +378,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md b/docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md index 02bd7cc1..950d4292 100644 --- a/docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md +++ b/docs/api/namespaces/YTNodes/classes/EngagementPanelSectionList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L25) +[src/parser/classes/EngagementPanelSectionList.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L25) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L16) +[src/parser/classes/EngagementPanelSectionList.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L16) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L15) +[src/parser/classes/EngagementPanelSectionList.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L15) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L19) +[src/parser/classes/EngagementPanelSectionList.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L19) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L18) +[src/parser/classes/EngagementPanelSectionList.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L18) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L17) +[src/parser/classes/EngagementPanelSectionList.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L17) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L23) +[src/parser/classes/EngagementPanelSectionList.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L23) *** @@ -122,7 +122,7 @@ #### Defined in -[src/parser/classes/EngagementPanelSectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelSectionList.ts#L13) +[src/parser/classes/EngagementPanelSectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelSectionList.ts#L13) ## Methods @@ -142,17 +142,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -186,7 +194,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -220,7 +228,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -258,4 +266,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md b/docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md index 0aee1ed6..69cd43d9 100644 --- a/docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md +++ b/docs/api/namespaces/YTNodes/classes/EngagementPanelTitleHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EngagementPanelTitleHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelTitleHeader.ts#L12) +[src/parser/classes/EngagementPanelTitleHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelTitleHeader.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EngagementPanelTitleHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelTitleHeader.ts#L9) +[src/parser/classes/EngagementPanelTitleHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelTitleHeader.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/EngagementPanelTitleHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelTitleHeader.ts#L10) +[src/parser/classes/EngagementPanelTitleHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelTitleHeader.ts#L10) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/EngagementPanelTitleHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EngagementPanelTitleHeader.ts#L7) +[src/parser/classes/EngagementPanelTitleHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EngagementPanelTitleHeader.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md b/docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md index 9b993eb7..eb39be32 100644 --- a/docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md +++ b/docs/api/namespaces/YTNodes/classes/EomSettingsDisclaimer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/EomSettingsDisclaimer.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EomSettingsDisclaimer.ts#L14) +[src/parser/classes/EomSettingsDisclaimer.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EomSettingsDisclaimer.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/EomSettingsDisclaimer.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EomSettingsDisclaimer.ts#L8) +[src/parser/classes/EomSettingsDisclaimer.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EomSettingsDisclaimer.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/EomSettingsDisclaimer.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EomSettingsDisclaimer.ts#L9) +[src/parser/classes/EomSettingsDisclaimer.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EomSettingsDisclaimer.ts#L9) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/EomSettingsDisclaimer.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EomSettingsDisclaimer.ts#L12) +[src/parser/classes/EomSettingsDisclaimer.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EomSettingsDisclaimer.ts#L12) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/EomSettingsDisclaimer.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/EomSettingsDisclaimer.ts#L6) +[src/parser/classes/EomSettingsDisclaimer.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/EomSettingsDisclaimer.ts#L6) ## Methods @@ -108,17 +108,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -152,7 +160,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -186,7 +194,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -224,4 +232,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md b/docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md index 1395e110..d2a318ee 100644 --- a/docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md +++ b/docs/api/namespaces/YTNodes/classes/ExpandableMetadata.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ExpandableMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableMetadata.ts#L23) +[src/parser/classes/ExpandableMetadata.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableMetadata.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ExpandableMetadata.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableMetadata.ts#L21) +[src/parser/classes/ExpandableMetadata.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableMetadata.ts#L21) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ExpandableMetadata.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableMetadata.ts#L20) +[src/parser/classes/ExpandableMetadata.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableMetadata.ts#L20) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ExpandableMetadata.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableMetadata.ts#L19) +[src/parser/classes/ExpandableMetadata.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableMetadata.ts#L19) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/ExpandableMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableMetadata.ts#L12) +[src/parser/classes/ExpandableMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableMetadata.ts#L12) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/ExpandableMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableMetadata.ts#L10) +[src/parser/classes/ExpandableMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableMetadata.ts#L10) ## Methods @@ -130,17 +130,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -174,7 +182,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -208,7 +216,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -246,4 +254,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandableTab.md b/docs/api/namespaces/YTNodes/classes/ExpandableTab.md index 888e1b50..5e989a97 100644 --- a/docs/api/namespaces/YTNodes/classes/ExpandableTab.md +++ b/docs/api/namespaces/YTNodes/classes/ExpandableTab.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ExpandableTab.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableTab.ts#L13) +[src/parser/classes/ExpandableTab.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableTab.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ExpandableTab.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableTab.ts#L11) +[src/parser/classes/ExpandableTab.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableTab.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ExpandableTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableTab.ts#L9) +[src/parser/classes/ExpandableTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableTab.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ExpandableTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableTab.ts#L10) +[src/parser/classes/ExpandableTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableTab.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ExpandableTab.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableTab.ts#L8) +[src/parser/classes/ExpandableTab.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableTab.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ExpandableTab.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableTab.ts#L6) +[src/parser/classes/ExpandableTab.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableTab.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md b/docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md index ddfcc140..47555a8b 100644 --- a/docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md +++ b/docs/api/namespaces/YTNodes/classes/ExpandableVideoDescriptionBody.md @@ -26,17 +26,17 @@ #### Defined in -[src/parser/classes/ExpandableVideoDescriptionBody.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableVideoDescriptionBody.ts#L13) +[src/parser/classes/ExpandableVideoDescriptionBody.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableVideoDescriptionBody.ts#L13) ## Properties ### attributed\_description\_body\_text? -> `optional` **attributed\_description\_body\_text**: `string` +> `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/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableVideoDescriptionBody.ts#L11) +[src/parser/classes/ExpandableVideoDescriptionBody.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableVideoDescriptionBody.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ExpandableVideoDescriptionBody.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableVideoDescriptionBody.ts#L10) +[src/parser/classes/ExpandableVideoDescriptionBody.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableVideoDescriptionBody.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ExpandableVideoDescriptionBody.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableVideoDescriptionBody.ts#L9) +[src/parser/classes/ExpandableVideoDescriptionBody.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableVideoDescriptionBody.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ExpandableVideoDescriptionBody.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandableVideoDescriptionBody.ts#L7) +[src/parser/classes/ExpandableVideoDescriptionBody.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandableVideoDescriptionBody.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md b/docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md index 0d5d3eea..12b3946a 100644 --- a/docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md +++ b/docs/api/namespaces/YTNodes/classes/ExpandedShelfContents.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ExpandedShelfContents.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandedShelfContents.ts#L9) +[src/parser/classes/ExpandedShelfContents.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandedShelfContents.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ExpandedShelfContents.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandedShelfContents.ts#L7) +[src/parser/classes/ExpandedShelfContents.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandedShelfContents.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ExpandedShelfContents.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandedShelfContents.ts#L5) +[src/parser/classes/ExpandedShelfContents.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandedShelfContents.ts#L5) ## Accessors @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/ExpandedShelfContents.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ExpandedShelfContents.ts#L15) +[src/parser/classes/ExpandedShelfContents.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ExpandedShelfContents.ts#L15) ## Methods @@ -98,17 +98,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -142,7 +150,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -176,7 +184,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -214,4 +222,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Factoid.md b/docs/api/namespaces/YTNodes/classes/Factoid.md index 999f2783..c7d28307 100644 --- a/docs/api/namespaces/YTNodes/classes/Factoid.md +++ b/docs/api/namespaces/YTNodes/classes/Factoid.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Factoid.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Factoid.ts#L12) +[src/parser/classes/Factoid.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Factoid.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Factoid.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Factoid.ts#L10) +[src/parser/classes/Factoid.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Factoid.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Factoid.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Factoid.ts#L8) +[src/parser/classes/Factoid.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Factoid.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/Factoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Factoid.ts#L9) +[src/parser/classes/Factoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Factoid.ts#L9) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/Factoid.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Factoid.ts#L6) +[src/parser/classes/Factoid.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Factoid.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md b/docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md index 076bbd41..357cc70b 100644 --- a/docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md +++ b/docs/api/namespaces/YTNodes/classes/FancyDismissibleDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/FancyDismissibleDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FancyDismissibleDialog.ts#L11) +[src/parser/classes/FancyDismissibleDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FancyDismissibleDialog.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/FancyDismissibleDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FancyDismissibleDialog.ts#L9) +[src/parser/classes/FancyDismissibleDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FancyDismissibleDialog.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/FancyDismissibleDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FancyDismissibleDialog.ts#L8) +[src/parser/classes/FancyDismissibleDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FancyDismissibleDialog.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/FancyDismissibleDialog.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FancyDismissibleDialog.ts#L6) +[src/parser/classes/FancyDismissibleDialog.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FancyDismissibleDialog.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/FeedFilterChipBar.md b/docs/api/namespaces/YTNodes/classes/FeedFilterChipBar.md index dd8456cb..7ab6a3c6 100644 --- a/docs/api/namespaces/YTNodes/classes/FeedFilterChipBar.md +++ b/docs/api/namespaces/YTNodes/classes/FeedFilterChipBar.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/FeedFilterChipBar.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedFilterChipBar.ts#L10) +[src/parser/classes/FeedFilterChipBar.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedFilterChipBar.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/FeedFilterChipBar.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedFilterChipBar.ts#L8) +[src/parser/classes/FeedFilterChipBar.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedFilterChipBar.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/FeedFilterChipBar.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedFilterChipBar.ts#L6) +[src/parser/classes/FeedFilterChipBar.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedFilterChipBar.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/FeedNudge.md b/docs/api/namespaces/YTNodes/classes/FeedNudge.md index fca2827c..1d4f5a53 100644 --- a/docs/api/namespaces/YTNodes/classes/FeedNudge.md +++ b/docs/api/namespaces/YTNodes/classes/FeedNudge.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L17) +[src/parser/classes/FeedNudge.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L13) +[src/parser/classes/FeedNudge.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L15) +[src/parser/classes/FeedNudge.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L12) +[src/parser/classes/FeedNudge.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L11) +[src/parser/classes/FeedNudge.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L10) +[src/parser/classes/FeedNudge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L10) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L14) +[src/parser/classes/FeedNudge.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L14) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/FeedNudge.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedNudge.ts#L8) +[src/parser/classes/FeedNudge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedNudge.ts#L8) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/FeedTabbedHeader.md b/docs/api/namespaces/YTNodes/classes/FeedTabbedHeader.md index c9a55c36..75909006 100644 --- a/docs/api/namespaces/YTNodes/classes/FeedTabbedHeader.md +++ b/docs/api/namespaces/YTNodes/classes/FeedTabbedHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/FeedTabbedHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedTabbedHeader.ts#L10) +[src/parser/classes/FeedTabbedHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedTabbedHeader.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/FeedTabbedHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedTabbedHeader.ts#L8) +[src/parser/classes/FeedTabbedHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedTabbedHeader.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/FeedTabbedHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FeedTabbedHeader.ts#L6) +[src/parser/classes/FeedTabbedHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FeedTabbedHeader.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/FeedbackEndpoint.md b/docs/api/namespaces/YTNodes/classes/FeedbackEndpoint.md new file mode 100644 index 00000000..5b14bc6d --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/FeedbackEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/FeedbackEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/FeedbackEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/FeedbackEndpoint.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/FeedbackEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/FeedbackEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md b/docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md index 445d2057..bd641489 100644 --- a/docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md +++ b/docs/api/namespaces/YTNodes/classes/FlexibleActionsView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/FlexibleActionsView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FlexibleActionsView.ts#L16) +[src/parser/classes/FlexibleActionsView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FlexibleActionsView.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/FlexibleActionsView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FlexibleActionsView.ts#L13) +[src/parser/classes/FlexibleActionsView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FlexibleActionsView.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/FlexibleActionsView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FlexibleActionsView.ts#L14) +[src/parser/classes/FlexibleActionsView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FlexibleActionsView.ts#L14) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/FlexibleActionsView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/FlexibleActionsView.ts#L11) +[src/parser/classes/FlexibleActionsView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/FlexibleActionsView.ts#L11) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/FormFooterView.md b/docs/api/namespaces/YTNodes/classes/FormFooterView.md new file mode 100644 index 00000000..c04afe2a --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/FormFooterView.md @@ -0,0 +1,231 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GameCard.md b/docs/api/namespaces/YTNodes/classes/GameCard.md index a7914552..eed07baf 100644 --- a/docs/api/namespaces/YTNodes/classes/GameCard.md +++ b/docs/api/namespaces/YTNodes/classes/GameCard.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GameCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameCard.ts#L9) +[src/parser/classes/GameCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameCard.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GameCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameCard.ts#L7) +[src/parser/classes/GameCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameCard.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/GameCard.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameCard.ts#L5) +[src/parser/classes/GameCard.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameCard.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GameDetails.md b/docs/api/namespaces/YTNodes/classes/GameDetails.md index 0e707968..e15cd3b7 100644 --- a/docs/api/namespaces/YTNodes/classes/GameDetails.md +++ b/docs/api/namespaces/YTNodes/classes/GameDetails.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GameDetails.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameDetails.ts#L16) +[src/parser/classes/GameDetails.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameDetails.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GameDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameDetails.ts#L11) +[src/parser/classes/GameDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameDetails.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GameDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameDetails.ts#L12) +[src/parser/classes/GameDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameDetails.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GameDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameDetails.ts#L13) +[src/parser/classes/GameDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameDetails.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GameDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameDetails.ts#L14) +[src/parser/classes/GameDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameDetails.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/GameDetails.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameDetails.ts#L10) +[src/parser/classes/GameDetails.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameDetails.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/GameDetails.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GameDetails.ts#L8) +[src/parser/classes/GameDetails.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GameDetails.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GetAccountsListInnertubeEndpoint.md b/docs/api/namespaces/YTNodes/classes/GetAccountsListInnertubeEndpoint.md new file mode 100644 index 00000000..7d9dbc59 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/GetAccountsListInnertubeEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.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/GetAccountsListInnertubeEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/GetAccountsListInnertubeEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GetKidsBlocklistPickerCommand.md b/docs/api/namespaces/YTNodes/classes/GetKidsBlocklistPickerCommand.md new file mode 100644 index 00000000..dc72c4d3 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/GetKidsBlocklistPickerCommand.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/commands/GetKidsBlocklistPickerCommand.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/commands/GetKidsBlocklistPickerCommand.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/commands/GetKidsBlocklistPickerCommand.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/commands/GetKidsBlocklistPickerCommand.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/commands/GetKidsBlocklistPickerCommand.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md b/docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md index 77862d6e..eca617cd 100644 --- a/docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md +++ b/docs/api/namespaces/YTNodes/classes/GetMultiPageMenuAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/actions/GetMultiPageMenuAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/GetMultiPageMenuAction.ts#L11) +[src/parser/classes/actions/GetMultiPageMenuAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/GetMultiPageMenuAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/actions/GetMultiPageMenuAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/GetMultiPageMenuAction.ts#L9) +[src/parser/classes/actions/GetMultiPageMenuAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/GetMultiPageMenuAction.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/actions/GetMultiPageMenuAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/GetMultiPageMenuAction.ts#L7) +[src/parser/classes/actions/GetMultiPageMenuAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/GetMultiPageMenuAction.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Grid.md b/docs/api/namespaces/YTNodes/classes/Grid.md index 33d17ebf..7f3bf695 100644 --- a/docs/api/namespaces/YTNodes/classes/Grid.md +++ b/docs/api/namespaces/YTNodes/classes/Grid.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Grid.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L14) +[src/parser/classes/Grid.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Grid.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L11) +[src/parser/classes/Grid.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Grid.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L12) +[src/parser/classes/Grid.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Grid.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L8) +[src/parser/classes/Grid.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Grid.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L7) +[src/parser/classes/Grid.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L7) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/Grid.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L10) +[src/parser/classes/Grid.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/Grid.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L9) +[src/parser/classes/Grid.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L9) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/Grid.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L5) +[src/parser/classes/Grid.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L5) ## Accessors @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/Grid.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Grid.ts#L39) +[src/parser/classes/Grid.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Grid.ts#L39) ## Methods @@ -148,17 +148,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -192,7 +200,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -226,7 +234,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -264,4 +272,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GridChannel.md b/docs/api/namespaces/YTNodes/classes/GridChannel.md index 7ac2ee8d..f46f1c51 100644 --- a/docs/api/namespaces/YTNodes/classes/GridChannel.md +++ b/docs/api/namespaces/YTNodes/classes/GridChannel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L17) +[src/parser/classes/GridChannel.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L11) +[src/parser/classes/GridChannel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L14) +[src/parser/classes/GridChannel.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L10) +[src/parser/classes/GridChannel.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L15) +[src/parser/classes/GridChannel.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L15) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L12) +[src/parser/classes/GridChannel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L13) +[src/parser/classes/GridChannel.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L13) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/GridChannel.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridChannel.ts#L8) +[src/parser/classes/GridChannel.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridChannel.ts#L8) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GridHeader.md b/docs/api/namespaces/YTNodes/classes/GridHeader.md index 2fb2384a..21eb4817 100644 --- a/docs/api/namespaces/YTNodes/classes/GridHeader.md +++ b/docs/api/namespaces/YTNodes/classes/GridHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GridHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridHeader.ts#L10) +[src/parser/classes/GridHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridHeader.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GridHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridHeader.ts#L8) +[src/parser/classes/GridHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridHeader.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/GridHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridHeader.ts#L6) +[src/parser/classes/GridHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridHeader.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GridMix.md b/docs/api/namespaces/YTNodes/classes/GridMix.md index b48d1f71..e581f932 100644 --- a/docs/api/namespaces/YTNodes/classes/GridMix.md +++ b/docs/api/namespaces/YTNodes/classes/GridMix.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L20) +[src/parser/classes/GridMix.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L12) +[src/parser/classes/GridMix.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L16) +[src/parser/classes/GridMix.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L10) +[src/parser/classes/GridMix.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L17) +[src/parser/classes/GridMix.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L17) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L18) +[src/parser/classes/GridMix.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L18) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L13) +[src/parser/classes/GridMix.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L13) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L11) +[src/parser/classes/GridMix.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L11) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L14) +[src/parser/classes/GridMix.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L14) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L15) +[src/parser/classes/GridMix.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L15) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/GridMix.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMix.ts#L8) +[src/parser/classes/GridMix.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMix.ts#L8) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GridMovie.md b/docs/api/namespaces/YTNodes/classes/GridMovie.md index 4f1d9b14..c5d2de06 100644 --- a/docs/api/namespaces/YTNodes/classes/GridMovie.md +++ b/docs/api/namespaces/YTNodes/classes/GridMovie.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L20) +[src/parser/classes/GridMovie.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L16) +[src/parser/classes/GridMovie.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L16) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L14) +[src/parser/classes/GridMovie.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L15) +[src/parser/classes/GridMovie.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L11) +[src/parser/classes/GridMovie.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L17) +[src/parser/classes/GridMovie.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L17) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L18) +[src/parser/classes/GridMovie.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L18) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L13) +[src/parser/classes/GridMovie.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L13) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L12) +[src/parser/classes/GridMovie.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L12) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/GridMovie.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridMovie.ts#L9) +[src/parser/classes/GridMovie.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridMovie.ts#L9) ## Methods @@ -154,17 +154,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -198,7 +206,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -232,7 +240,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -270,4 +278,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GridPlaylist.md b/docs/api/namespaces/YTNodes/classes/GridPlaylist.md index 4a132fc6..7caac1d9 100644 --- a/docs/api/namespaces/YTNodes/classes/GridPlaylist.md +++ b/docs/api/namespaces/YTNodes/classes/GridPlaylist.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L23) +[src/parser/classes/GridPlaylist.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L13) +[src/parser/classes/GridPlaylist.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L14) +[src/parser/classes/GridPlaylist.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L15) +[src/parser/classes/GridPlaylist.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L11) +[src/parser/classes/GridPlaylist.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L19) +[src/parser/classes/GridPlaylist.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L19) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L18) +[src/parser/classes/GridPlaylist.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L18) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L17) +[src/parser/classes/GridPlaylist.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L12) +[src/parser/classes/GridPlaylist.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L12) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L20) +[src/parser/classes/GridPlaylist.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L20) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L21) +[src/parser/classes/GridPlaylist.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L21) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L16) +[src/parser/classes/GridPlaylist.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L16) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/GridPlaylist.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridPlaylist.ts#L9) +[src/parser/classes/GridPlaylist.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridPlaylist.ts#L9) ## Methods @@ -184,17 +184,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -228,7 +236,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -262,7 +270,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -300,4 +308,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GridShow.md b/docs/api/namespaces/YTNodes/classes/GridShow.md index 458a817c..866f4a25 100644 --- a/docs/api/namespaces/YTNodes/classes/GridShow.md +++ b/docs/api/namespaces/YTNodes/classes/GridShow.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L20) +[src/parser/classes/GridShow.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L18) +[src/parser/classes/GridShow.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L18) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L15) +[src/parser/classes/GridShow.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L16) +[src/parser/classes/GridShow.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L16) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L17) +[src/parser/classes/GridShow.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L17) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L14) +[src/parser/classes/GridShow.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L14) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L13) +[src/parser/classes/GridShow.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L13) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/GridShow.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridShow.ts#L11) +[src/parser/classes/GridShow.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridShow.ts#L11) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GridVideo.md b/docs/api/namespaces/YTNodes/classes/GridVideo.md index 36be9112..d2e0e415 100644 --- a/docs/api/namespaces/YTNodes/classes/GridVideo.md +++ b/docs/api/namespaces/YTNodes/classes/GridVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L29) +[src/parser/classes/GridVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L29) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L19) +[src/parser/classes/GridVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L19) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L24) +[src/parser/classes/GridVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L24) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L18) +[src/parser/classes/GridVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L18) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L22) +[src/parser/classes/GridVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L22) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L12) +[src/parser/classes/GridVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L27) +[src/parser/classes/GridVideo.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L27) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L23) +[src/parser/classes/GridVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L23) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L17) +[src/parser/classes/GridVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L17) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L16) +[src/parser/classes/GridVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L16) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L21) +[src/parser/classes/GridVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L21) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L15) +[src/parser/classes/GridVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L15) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L14) +[src/parser/classes/GridVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L14) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L13) +[src/parser/classes/GridVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L13) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L25) +[src/parser/classes/GridVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L25) *** @@ -190,7 +190,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L26) +[src/parser/classes/GridVideo.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L26) *** @@ -200,7 +200,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L20) +[src/parser/classes/GridVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L20) *** @@ -214,7 +214,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L10) +[src/parser/classes/GridVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L10) ## Accessors @@ -228,7 +228,7 @@ #### Defined in -[src/parser/classes/GridVideo.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GridVideo.ts#L57) +[src/parser/classes/GridVideo.ts:57](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GridVideo.ts#L57) ## Methods @@ -248,17 +248,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -292,7 +300,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -326,7 +334,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -364,4 +372,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md b/docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md index 0fa2912c..f340e53a 100644 --- a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md +++ b/docs/api/namespaces/YTNodes/classes/GuideCollapsibleEntry.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleEntry.ts#L13) +[src/parser/classes/GuideCollapsibleEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleEntry.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleEntry.ts#L10) +[src/parser/classes/GuideCollapsibleEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleEntry.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleEntry.ts#L11) +[src/parser/classes/GuideCollapsibleEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleEntry.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleEntry.ts#L9) +[src/parser/classes/GuideCollapsibleEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleEntry.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleEntry.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleEntry.ts#L7) +[src/parser/classes/GuideCollapsibleEntry.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleEntry.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md b/docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md index 28636221..38d8f48a 100644 --- a/docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md +++ b/docs/api/namespaces/YTNodes/classes/GuideCollapsibleSectionEntry.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleSectionEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleSectionEntry.ts#L13) +[src/parser/classes/GuideCollapsibleSectionEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleSectionEntry.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleSectionEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleSectionEntry.ts#L10) +[src/parser/classes/GuideCollapsibleSectionEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleSectionEntry.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleSectionEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleSectionEntry.ts#L9) +[src/parser/classes/GuideCollapsibleSectionEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleSectionEntry.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleSectionEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleSectionEntry.ts#L8) +[src/parser/classes/GuideCollapsibleSectionEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleSectionEntry.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleSectionEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleSectionEntry.ts#L11) +[src/parser/classes/GuideCollapsibleSectionEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleSectionEntry.ts#L11) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/GuideCollapsibleSectionEntry.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideCollapsibleSectionEntry.ts#L6) +[src/parser/classes/GuideCollapsibleSectionEntry.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideCollapsibleSectionEntry.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md b/docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md index 4a5722f9..c9678d06 100644 --- a/docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md +++ b/docs/api/namespaces/YTNodes/classes/GuideDownloadsEntry.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GuideDownloadsEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideDownloadsEntry.ts#L9) +[src/parser/classes/GuideDownloadsEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideDownloadsEntry.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/GuideDownloadsEntry.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideDownloadsEntry.ts#L7) +[src/parser/classes/GuideDownloadsEntry.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideDownloadsEntry.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L14) +[src/parser/classes/GuideEntry.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L14) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L11) +[src/parser/classes/GuideEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L11) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L12) +[src/parser/classes/GuideEntry.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L12) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L15) +[src/parser/classes/GuideEntry.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L15) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L13) +[src/parser/classes/GuideEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L13) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L10) +[src/parser/classes/GuideEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L10) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/classes/GuideDownloadsEntry.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideDownloadsEntry.ts#L5) +[src/parser/classes/GuideDownloadsEntry.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideDownloadsEntry.ts#L5) ## Methods @@ -168,17 +168,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -212,7 +220,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -246,7 +254,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -284,4 +292,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GuideEntry.md b/docs/api/namespaces/YTNodes/classes/GuideEntry.md index 2825455a..5c39d72c 100644 --- a/docs/api/namespaces/YTNodes/classes/GuideEntry.md +++ b/docs/api/namespaces/YTNodes/classes/GuideEntry.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L17) +[src/parser/classes/GuideEntry.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L17) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L14) +[src/parser/classes/GuideEntry.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L14) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L11) +[src/parser/classes/GuideEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L12) +[src/parser/classes/GuideEntry.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L12) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L15) +[src/parser/classes/GuideEntry.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L15) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L13) +[src/parser/classes/GuideEntry.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L13) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L10) +[src/parser/classes/GuideEntry.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L10) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/GuideEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideEntry.ts#L8) +[src/parser/classes/GuideEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideEntry.ts#L8) ## Methods @@ -138,17 +138,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -182,7 +190,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -216,7 +224,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -254,4 +262,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GuideSection.md b/docs/api/namespaces/YTNodes/classes/GuideSection.md index e1caf9f9..b9ca149a 100644 --- a/docs/api/namespaces/YTNodes/classes/GuideSection.md +++ b/docs/api/namespaces/YTNodes/classes/GuideSection.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/GuideSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSection.ts#L12) +[src/parser/classes/GuideSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSection.ts#L12) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/GuideSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSection.ts#L10) +[src/parser/classes/GuideSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSection.ts#L10) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/GuideSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSection.ts#L9) +[src/parser/classes/GuideSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSection.ts#L9) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/GuideSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSection.ts#L7) +[src/parser/classes/GuideSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSection.ts#L7) ## Methods @@ -98,17 +98,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -142,7 +150,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -176,7 +184,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -214,4 +222,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/GuideSubscriptionsSection.md b/docs/api/namespaces/YTNodes/classes/GuideSubscriptionsSection.md index 8b15400e..3b3757ae 100644 --- a/docs/api/namespaces/YTNodes/classes/GuideSubscriptionsSection.md +++ b/docs/api/namespaces/YTNodes/classes/GuideSubscriptionsSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/GuideSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSection.ts#L12) +[src/parser/classes/GuideSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSection.ts#L12) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/GuideSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSection.ts#L10) +[src/parser/classes/GuideSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSection.ts#L10) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/GuideSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSection.ts#L9) +[src/parser/classes/GuideSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSection.ts#L9) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/GuideSubscriptionsSection.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/GuideSubscriptionsSection.ts#L4) +[src/parser/classes/GuideSubscriptionsSection.ts:4](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/GuideSubscriptionsSection.ts#L4) ## Methods @@ -102,17 +102,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`GuideSection`](GuideSection.md).[`as`](GuideSection.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -146,7 +154,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -180,7 +188,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -218,4 +226,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HashtagHeader.md b/docs/api/namespaces/YTNodes/classes/HashtagHeader.md index 2e5e4c9f..1e69ddfb 100644 --- a/docs/api/namespaces/YTNodes/classes/HashtagHeader.md +++ b/docs/api/namespaces/YTNodes/classes/HashtagHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HashtagHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagHeader.ts#L11) +[src/parser/classes/HashtagHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagHeader.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HashtagHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagHeader.ts#L8) +[src/parser/classes/HashtagHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagHeader.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/HashtagHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagHeader.ts#L9) +[src/parser/classes/HashtagHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagHeader.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/HashtagHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagHeader.ts#L6) +[src/parser/classes/HashtagHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagHeader.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HashtagTile.md b/docs/api/namespaces/YTNodes/classes/HashtagTile.md index 89c4ec39..b52e795f 100644 --- a/docs/api/namespaces/YTNodes/classes/HashtagTile.md +++ b/docs/api/namespaces/YTNodes/classes/HashtagTile.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L18) +[src/parser/classes/HashtagTile.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L13) +[src/parser/classes/HashtagTile.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L10) +[src/parser/classes/HashtagTile.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L14) +[src/parser/classes/HashtagTile.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L16) +[src/parser/classes/HashtagTile.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L16) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L11) +[src/parser/classes/HashtagTile.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L11) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L12) +[src/parser/classes/HashtagTile.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L12) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L15) +[src/parser/classes/HashtagTile.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L15) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/HashtagTile.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HashtagTile.ts#L8) +[src/parser/classes/HashtagTile.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HashtagTile.ts#L8) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HeatMarker.md b/docs/api/namespaces/YTNodes/classes/HeatMarker.md index d3daf8b0..bf3bcb20 100644 --- a/docs/api/namespaces/YTNodes/classes/HeatMarker.md +++ b/docs/api/namespaces/YTNodes/classes/HeatMarker.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HeatMarker.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeatMarker.ts#L11) +[src/parser/classes/HeatMarker.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeatMarker.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HeatMarker.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeatMarker.ts#L9) +[src/parser/classes/HeatMarker.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeatMarker.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/HeatMarker.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeatMarker.ts#L8) +[src/parser/classes/HeatMarker.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeatMarker.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/HeatMarker.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeatMarker.ts#L7) +[src/parser/classes/HeatMarker.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeatMarker.ts#L7) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/HeatMarker.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeatMarker.ts#L5) +[src/parser/classes/HeatMarker.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeatMarker.ts#L5) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Heatmap.md b/docs/api/namespaces/YTNodes/classes/Heatmap.md index b41bdd65..73f0c030 100644 --- a/docs/api/namespaces/YTNodes/classes/Heatmap.md +++ b/docs/api/namespaces/YTNodes/classes/Heatmap.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Heatmap.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Heatmap.ts#L14) +[src/parser/classes/Heatmap.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Heatmap.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Heatmap.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Heatmap.ts#L11) +[src/parser/classes/Heatmap.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Heatmap.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Heatmap.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Heatmap.ts#L12) +[src/parser/classes/Heatmap.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Heatmap.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Heatmap.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Heatmap.ts#L8) +[src/parser/classes/Heatmap.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Heatmap.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Heatmap.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Heatmap.ts#L9) +[src/parser/classes/Heatmap.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Heatmap.ts#L9) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/Heatmap.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Heatmap.ts#L10) +[src/parser/classes/Heatmap.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Heatmap.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/Heatmap.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Heatmap.ts#L6) +[src/parser/classes/Heatmap.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Heatmap.ts#L6) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md b/docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md index b15da102..64d87490 100644 --- a/docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md +++ b/docs/api/namespaces/YTNodes/classes/HeroPlaylistThumbnail.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HeroPlaylistThumbnail.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeroPlaylistThumbnail.ts#L12) +[src/parser/classes/HeroPlaylistThumbnail.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeroPlaylistThumbnail.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HeroPlaylistThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeroPlaylistThumbnail.ts#L10) +[src/parser/classes/HeroPlaylistThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeroPlaylistThumbnail.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/HeroPlaylistThumbnail.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeroPlaylistThumbnail.ts#L9) +[src/parser/classes/HeroPlaylistThumbnail.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeroPlaylistThumbnail.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/HeroPlaylistThumbnail.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HeroPlaylistThumbnail.ts#L7) +[src/parser/classes/HeroPlaylistThumbnail.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HeroPlaylistThumbnail.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HighlightsCarousel.md b/docs/api/namespaces/YTNodes/classes/HighlightsCarousel.md index c0e89e43..87c86530 100644 --- a/docs/api/namespaces/YTNodes/classes/HighlightsCarousel.md +++ b/docs/api/namespaces/YTNodes/classes/HighlightsCarousel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HighlightsCarousel.ts:74](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HighlightsCarousel.ts#L74) +[src/parser/classes/HighlightsCarousel.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HighlightsCarousel.ts#L74) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HighlightsCarousel.ts:72](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HighlightsCarousel.ts#L72) +[src/parser/classes/HighlightsCarousel.ts:72](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HighlightsCarousel.ts#L72) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/HighlightsCarousel.ts:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HighlightsCarousel.ts#L70) +[src/parser/classes/HighlightsCarousel.ts:70](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HighlightsCarousel.ts#L70) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HistorySuggestion.md b/docs/api/namespaces/YTNodes/classes/HistorySuggestion.md index 96d0d473..cafaf16d 100644 --- a/docs/api/namespaces/YTNodes/classes/HistorySuggestion.md +++ b/docs/api/namespaces/YTNodes/classes/HistorySuggestion.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HistorySuggestion.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HistorySuggestion.ts#L7) +[src/parser/classes/HistorySuggestion.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HistorySuggestion.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L10) +[src/parser/classes/SearchSuggestion.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L10) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L11) +[src/parser/classes/SearchSuggestion.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L11) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L12) +[src/parser/classes/SearchSuggestion.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L12) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L9) +[src/parser/classes/SearchSuggestion.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L9) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/HistorySuggestion.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HistorySuggestion.ts#L5) +[src/parser/classes/HistorySuggestion.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HistorySuggestion.ts#L5) ## Methods @@ -130,17 +130,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`SearchSuggestion`](SearchSuggestion.md).[`as`](SearchSuggestion.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -174,7 +182,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -208,7 +216,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -246,4 +254,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HorizontalCardList.md b/docs/api/namespaces/YTNodes/classes/HorizontalCardList.md index 74f83bea..44238c20 100644 --- a/docs/api/namespaces/YTNodes/classes/HorizontalCardList.md +++ b/docs/api/namespaces/YTNodes/classes/HorizontalCardList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HorizontalCardList.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalCardList.ts#L18) +[src/parser/classes/HorizontalCardList.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalCardList.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HorizontalCardList.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalCardList.ts#L13) +[src/parser/classes/HorizontalCardList.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalCardList.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/HorizontalCardList.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalCardList.ts#L14) +[src/parser/classes/HorizontalCardList.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalCardList.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/HorizontalCardList.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalCardList.ts#L16) +[src/parser/classes/HorizontalCardList.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalCardList.ts#L16) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/HorizontalCardList.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalCardList.ts#L15) +[src/parser/classes/HorizontalCardList.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalCardList.ts#L15) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/HorizontalCardList.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalCardList.ts#L11) +[src/parser/classes/HorizontalCardList.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalCardList.ts#L11) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HorizontalList.md b/docs/api/namespaces/YTNodes/classes/HorizontalList.md index 8704f1c3..102d8349 100644 --- a/docs/api/namespaces/YTNodes/classes/HorizontalList.md +++ b/docs/api/namespaces/YTNodes/classes/HorizontalList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HorizontalList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalList.ts#L10) +[src/parser/classes/HorizontalList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalList.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HorizontalList.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalList.ts#L8) +[src/parser/classes/HorizontalList.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalList.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/HorizontalList.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalList.ts#L7) +[src/parser/classes/HorizontalList.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalList.ts#L7) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/HorizontalList.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalList.ts#L5) +[src/parser/classes/HorizontalList.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalList.ts#L5) ## Accessors @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/HorizontalList.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalList.ts#L17) +[src/parser/classes/HorizontalList.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalList.ts#L17) ## Methods @@ -108,17 +108,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -152,7 +160,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -186,7 +194,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -224,4 +232,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md b/docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md index e939cb49..7918e90c 100644 --- a/docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md +++ b/docs/api/namespaces/YTNodes/classes/HorizontalMovieList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/HorizontalMovieList.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalMovieList.ts#L12) +[src/parser/classes/HorizontalMovieList.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalMovieList.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/HorizontalMovieList.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalMovieList.ts#L8) +[src/parser/classes/HorizontalMovieList.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalMovieList.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/HorizontalMovieList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalMovieList.ts#L10) +[src/parser/classes/HorizontalMovieList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalMovieList.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/HorizontalMovieList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalMovieList.ts#L9) +[src/parser/classes/HorizontalMovieList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalMovieList.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/HorizontalMovieList.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalMovieList.ts#L6) +[src/parser/classes/HorizontalMovieList.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalMovieList.ts#L6) ## Accessors @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/HorizontalMovieList.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/HorizontalMovieList.ts#L20) +[src/parser/classes/HorizontalMovieList.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/HorizontalMovieList.ts#L20) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/IconLink.md b/docs/api/namespaces/YTNodes/classes/IconLink.md index 5e43fa69..580c82ab 100644 --- a/docs/api/namespaces/YTNodes/classes/IconLink.md +++ b/docs/api/namespaces/YTNodes/classes/IconLink.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/IconLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IconLink.ts#L13) +[src/parser/classes/IconLink.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IconLink.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/IconLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IconLink.ts#L11) +[src/parser/classes/IconLink.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IconLink.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/IconLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IconLink.ts#L9) +[src/parser/classes/IconLink.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IconLink.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/IconLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IconLink.ts#L10) +[src/parser/classes/IconLink.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IconLink.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/IconLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IconLink.ts#L7) +[src/parser/classes/IconLink.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IconLink.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ImageBannerView.md b/docs/api/namespaces/YTNodes/classes/ImageBannerView.md index 49024a1a..13b96a8d 100644 --- a/docs/api/namespaces/YTNodes/classes/ImageBannerView.md +++ b/docs/api/namespaces/YTNodes/classes/ImageBannerView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ImageBannerView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ImageBannerView.ts#L11) +[src/parser/classes/ImageBannerView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ImageBannerView.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ImageBannerView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ImageBannerView.ts#L8) +[src/parser/classes/ImageBannerView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ImageBannerView.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ImageBannerView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ImageBannerView.ts#L9) +[src/parser/classes/ImageBannerView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ImageBannerView.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ImageBannerView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ImageBannerView.ts#L6) +[src/parser/classes/ImageBannerView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ImageBannerView.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md b/docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md index 26e16e51..18abef40 100644 --- a/docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md +++ b/docs/api/namespaces/YTNodes/classes/IncludingResultsFor.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L16) +[src/parser/classes/IncludingResultsFor.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L10) +[src/parser/classes/IncludingResultsFor.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L11) +[src/parser/classes/IncludingResultsFor.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L9) +[src/parser/classes/IncludingResultsFor.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L9) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L13) +[src/parser/classes/IncludingResultsFor.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L14) +[src/parser/classes/IncludingResultsFor.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L14) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L12) +[src/parser/classes/IncludingResultsFor.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L12) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/IncludingResultsFor.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/IncludingResultsFor.ts#L7) +[src/parser/classes/IncludingResultsFor.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/IncludingResultsFor.ts#L7) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md b/docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md index 872e482d..7cf99612 100644 --- a/docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md +++ b/docs/api/namespaces/YTNodes/classes/InfoPanelContainer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L19) +[src/parser/classes/InfoPanelContainer.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L19) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L15) +[src/parser/classes/InfoPanelContainer.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L13) +[src/parser/classes/InfoPanelContainer.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L14) +[src/parser/classes/InfoPanelContainer.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L17) +[src/parser/classes/InfoPanelContainer.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L17) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L12) +[src/parser/classes/InfoPanelContainer.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L11) +[src/parser/classes/InfoPanelContainer.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L11) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L16) +[src/parser/classes/InfoPanelContainer.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L16) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/InfoPanelContainer.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContainer.ts#L9) +[src/parser/classes/InfoPanelContainer.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContainer.ts#L9) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/InfoPanelContent.md b/docs/api/namespaces/YTNodes/classes/InfoPanelContent.md index 033654e4..357906f3 100644 --- a/docs/api/namespaces/YTNodes/classes/InfoPanelContent.md +++ b/docs/api/namespaces/YTNodes/classes/InfoPanelContent.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L21) +[src/parser/classes/InfoPanelContent.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L14) +[src/parser/classes/InfoPanelContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L18) +[src/parser/classes/InfoPanelContent.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L18) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L19) +[src/parser/classes/InfoPanelContent.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L19) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L13) +[src/parser/classes/InfoPanelContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L12) +[src/parser/classes/InfoPanelContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L16) +[src/parser/classes/InfoPanelContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L16) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L15) +[src/parser/classes/InfoPanelContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L15) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L11) +[src/parser/classes/InfoPanelContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L11) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L17) +[src/parser/classes/InfoPanelContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L17) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/InfoPanelContent.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoPanelContent.ts#L9) +[src/parser/classes/InfoPanelContent.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoPanelContent.ts#L9) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/InfoRow.md b/docs/api/namespaces/YTNodes/classes/InfoRow.md index 4e803120..96156bed 100644 --- a/docs/api/namespaces/YTNodes/classes/InfoRow.md +++ b/docs/api/namespaces/YTNodes/classes/InfoRow.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/InfoRow.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoRow.ts#L13) +[src/parser/classes/InfoRow.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoRow.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/InfoRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoRow.ts#L9) +[src/parser/classes/InfoRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoRow.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/InfoRow.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoRow.ts#L10) +[src/parser/classes/InfoRow.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoRow.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/InfoRow.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoRow.ts#L11) +[src/parser/classes/InfoRow.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoRow.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/InfoRow.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoRow.ts#L8) +[src/parser/classes/InfoRow.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoRow.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/InfoRow.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InfoRow.ts#L6) +[src/parser/classes/InfoRow.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InfoRow.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md b/docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md index 32e34c75..aa39a7a6 100644 --- a/docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md +++ b/docs/api/namespaces/YTNodes/classes/InteractiveTabbedHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L23) +[src/parser/classes/InteractiveTabbedHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L21) +[src/parser/classes/InteractiveTabbedHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L21) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L17) +[src/parser/classes/InteractiveTabbedHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L17) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L19) +[src/parser/classes/InteractiveTabbedHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L19) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L18) +[src/parser/classes/InteractiveTabbedHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L18) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L20) +[src/parser/classes/InteractiveTabbedHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L20) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L15) +[src/parser/classes/InteractiveTabbedHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L15) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L13) +[src/parser/classes/InteractiveTabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L13) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L16) +[src/parser/classes/InteractiveTabbedHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L16) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L14) +[src/parser/classes/InteractiveTabbedHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L14) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/InteractiveTabbedHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/InteractiveTabbedHeader.ts#L11) +[src/parser/classes/InteractiveTabbedHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/InteractiveTabbedHeader.ts#L11) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ItemSection.md b/docs/api/namespaces/YTNodes/classes/ItemSection.md index 0f00658f..9213ddd8 100644 --- a/docs/api/namespaces/YTNodes/classes/ItemSection.md +++ b/docs/api/namespaces/YTNodes/classes/ItemSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ItemSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSection.ts#L17) +[src/parser/classes/ItemSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSection.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ItemSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSection.ts#L13) +[src/parser/classes/ItemSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSection.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ItemSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSection.ts#L15) +[src/parser/classes/ItemSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSection.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ItemSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSection.ts#L12) +[src/parser/classes/ItemSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSection.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ItemSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSection.ts#L14) +[src/parser/classes/ItemSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSection.ts#L14) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ItemSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSection.ts#L10) +[src/parser/classes/ItemSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSection.ts#L10) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ItemSectionHeader.md b/docs/api/namespaces/YTNodes/classes/ItemSectionHeader.md index b122f2f1..a245eb36 100644 --- a/docs/api/namespaces/YTNodes/classes/ItemSectionHeader.md +++ b/docs/api/namespaces/YTNodes/classes/ItemSectionHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ItemSectionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionHeader.ts#L10) +[src/parser/classes/ItemSectionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionHeader.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ItemSectionHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionHeader.ts#L8) +[src/parser/classes/ItemSectionHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionHeader.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ItemSectionHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionHeader.ts#L6) +[src/parser/classes/ItemSectionHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionHeader.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ItemSectionTab.md b/docs/api/namespaces/YTNodes/classes/ItemSectionTab.md index 0a7fe615..33f67628 100644 --- a/docs/api/namespaces/YTNodes/classes/ItemSectionTab.md +++ b/docs/api/namespaces/YTNodes/classes/ItemSectionTab.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ItemSectionTab.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTab.ts#L13) +[src/parser/classes/ItemSectionTab.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTab.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ItemSectionTab.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTab.ts#L11) +[src/parser/classes/ItemSectionTab.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTab.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ItemSectionTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTab.ts#L10) +[src/parser/classes/ItemSectionTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTab.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ItemSectionTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTab.ts#L9) +[src/parser/classes/ItemSectionTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTab.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ItemSectionTab.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTab.ts#L7) +[src/parser/classes/ItemSectionTab.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTab.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md b/docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md index 618c815c..8a1ecb22 100644 --- a/docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md +++ b/docs/api/namespaces/YTNodes/classes/ItemSectionTabbedHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ItemSectionTabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTabbedHeader.ts#L13) +[src/parser/classes/ItemSectionTabbedHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTabbedHeader.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ItemSectionTabbedHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTabbedHeader.ts#L11) +[src/parser/classes/ItemSectionTabbedHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTabbedHeader.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ItemSectionTabbedHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTabbedHeader.ts#L10) +[src/parser/classes/ItemSectionTabbedHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTabbedHeader.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ItemSectionTabbedHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTabbedHeader.ts#L9) +[src/parser/classes/ItemSectionTabbedHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTabbedHeader.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ItemSectionTabbedHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ItemSectionTabbedHeader.ts#L7) +[src/parser/classes/ItemSectionTabbedHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ItemSectionTabbedHeader.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md b/docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md index cff41325..b15e8e13 100644 --- a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md +++ b/docs/api/namespaces/YTNodes/classes/KidsBlocklistPicker.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L15) +[src/parser/classes/ytkids/KidsBlocklistPicker.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L11) +[src/parser/classes/ytkids/KidsBlocklistPicker.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L12) +[src/parser/classes/ytkids/KidsBlocklistPicker.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L13) +[src/parser/classes/ytkids/KidsBlocklistPicker.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L10) +[src/parser/classes/ytkids/KidsBlocklistPicker.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPicker.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L8) +[src/parser/classes/ytkids/KidsBlocklistPicker.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPicker.ts#L8) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md b/docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md index cd24f5a6..8edd980c 100644 --- a/docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md +++ b/docs/api/namespaces/YTNodes/classes/KidsBlocklistPickerItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L21) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L17) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L17) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L18) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L18) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L19) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L19) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L16) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L16) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L15) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L15) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L11) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L11) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Cast to one of the given types. #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L30) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L30) *** @@ -182,7 +190,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -216,7 +224,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -254,7 +262,7 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) *** @@ -272,4 +280,4 @@ If the node does not have the key #### Defined in -[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsBlocklistPickerItem.ts#L46) +[src/parser/classes/ytkids/KidsBlocklistPickerItem.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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 index 9ac113be..8cf90ca6 100644 --- a/docs/api/namespaces/YTNodes/classes/KidsCategoriesHeader.md +++ b/docs/api/namespaces/YTNodes/classes/KidsCategoriesHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L13) +[src/parser/classes/ytkids/KidsCategoriesHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L10) +[src/parser/classes/ytkids/KidsCategoriesHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L11) +[src/parser/classes/ytkids/KidsCategoriesHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoriesHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L8) +[src/parser/classes/ytkids/KidsCategoriesHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoriesHeader.ts#L8) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md b/docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md index bbb2f942..b74c6a02 100644 --- a/docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md +++ b/docs/api/namespaces/YTNodes/classes/KidsCategoryTab.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoryTab.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoryTab.ts#L17) +[src/parser/classes/ytkids/KidsCategoryTab.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoryTab.ts#L17) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoryTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoryTab.ts#L10) +[src/parser/classes/ytkids/KidsCategoryTab.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoryTab.ts#L10) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoryTab.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoryTab.ts#L14) +[src/parser/classes/ytkids/KidsCategoryTab.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoryTab.ts#L14) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoryTab.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoryTab.ts#L15) +[src/parser/classes/ytkids/KidsCategoryTab.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoryTab.ts#L15) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoryTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoryTab.ts#L9) +[src/parser/classes/ytkids/KidsCategoryTab.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoryTab.ts#L9) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsCategoryTab.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsCategoryTab.ts#L7) +[src/parser/classes/ytkids/KidsCategoryTab.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsCategoryTab.ts#L7) ## Methods @@ -122,17 +122,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -166,7 +174,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -200,7 +208,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -238,4 +246,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/KidsHomeScreen.md b/docs/api/namespaces/YTNodes/classes/KidsHomeScreen.md index 59fe37d6..d41cece4 100644 --- a/docs/api/namespaces/YTNodes/classes/KidsHomeScreen.md +++ b/docs/api/namespaces/YTNodes/classes/KidsHomeScreen.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsHomeScreen.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsHomeScreen.ts#L11) +[src/parser/classes/ytkids/KidsHomeScreen.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsHomeScreen.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsHomeScreen.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsHomeScreen.ts#L9) +[src/parser/classes/ytkids/KidsHomeScreen.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsHomeScreen.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ytkids/KidsHomeScreen.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ytkids/KidsHomeScreen.ts#L7) +[src/parser/classes/ytkids/KidsHomeScreen.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ytkids/KidsHomeScreen.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LikeButton.md b/docs/api/namespaces/YTNodes/classes/LikeButton.md index 83bd2d2a..a269fb3a 100644 --- a/docs/api/namespaces/YTNodes/classes/LikeButton.md +++ b/docs/api/namespaces/YTNodes/classes/LikeButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LikeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButton.ts#L16) +[src/parser/classes/LikeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButton.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LikeButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButton.ts#L14) +[src/parser/classes/LikeButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButton.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/LikeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButton.ts#L12) +[src/parser/classes/LikeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButton.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/LikeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButton.ts#L13) +[src/parser/classes/LikeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButton.ts#L13) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/LikeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButton.ts#L8) +[src/parser/classes/LikeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButton.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/LikeButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButton.ts#L6) +[src/parser/classes/LikeButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButton.ts#L6) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LikeButtonView.md b/docs/api/namespaces/YTNodes/classes/LikeButtonView.md index 0140b1dc..4c241d3d 100644 --- a/docs/api/namespaces/YTNodes/classes/LikeButtonView.md +++ b/docs/api/namespaces/YTNodes/classes/LikeButtonView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LikeButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButtonView.ts#L15) +[src/parser/classes/LikeButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButtonView.ts#L15) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/LikeButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButtonView.ts#L10) +[src/parser/classes/LikeButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButtonView.ts#L10) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/LikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButtonView.ts#L9) +[src/parser/classes/LikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButtonView.ts#L9) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/LikeButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButtonView.ts#L8) +[src/parser/classes/LikeButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButtonView.ts#L8) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/LikeButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LikeButtonView.ts#L6) +[src/parser/classes/LikeButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LikeButtonView.ts#L6) ## Methods @@ -112,17 +112,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -156,7 +164,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -190,7 +198,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -228,4 +236,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LikeEndpoint.md b/docs/api/namespaces/YTNodes/classes/LikeEndpoint.md new file mode 100644 index 00000000..f0d84f9a --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LikeEndpoint.md @@ -0,0 +1,255 @@ +[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:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LikeEndpoint.ts#L12) + +## 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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LikeEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LikeEndpoint.ts#L23) + +*** + +### 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:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LikeEndpoint.ts#L17) + +*** + +### getParams() + +> **getParams**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[src/parser/classes/endpoints/LikeEndpoint.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LikeEndpoint.ts#L36) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChat.md b/docs/api/namespaces/YTNodes/classes/LiveChat.md index 333bd66b..35ee83c8 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChat.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChat.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChat.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChat.ts#L22) +[src/parser/classes/LiveChat.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChat.ts#L22) ## Properties @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/LiveChat.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChat.ts#L12) +[src/parser/classes/LiveChat.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChat.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/LiveChat.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChat.ts#L10) +[src/parser/classes/LiveChat.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChat.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/LiveChat.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChat.ts#L8) +[src/parser/classes/LiveChat.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChat.ts#L8) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/LiveChat.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChat.ts#L9) +[src/parser/classes/LiveChat.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChat.ts#L9) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/LiveChat.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChat.ts#L20) +[src/parser/classes/LiveChat.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChat.ts#L20) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/LiveChat.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChat.ts#L6) +[src/parser/classes/LiveChat.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChat.ts#L6) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md b/docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md index 10a5a4b3..e5df07de 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatActionPanel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/LiveChatActionPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/LiveChatActionPanel.ts#L12) +[src/parser/classes/livechat/LiveChatActionPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/LiveChatActionPanel.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/LiveChatActionPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/LiveChatActionPanel.ts#L9) +[src/parser/classes/livechat/LiveChatActionPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/LiveChatActionPanel.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/LiveChatActionPanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/LiveChatActionPanel.ts#L8) +[src/parser/classes/livechat/LiveChatActionPanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/LiveChatActionPanel.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/LiveChatActionPanel.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/LiveChatActionPanel.ts#L10) +[src/parser/classes/livechat/LiveChatActionPanel.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/LiveChatActionPanel.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/livechat/LiveChatActionPanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/LiveChatActionPanel.ts#L6) +[src/parser/classes/livechat/LiveChatActionPanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/LiveChatActionPanel.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md b/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md index 2b387a70..8639c15e 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChatAuthorBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatAuthorBadge.ts#L10) +[src/parser/classes/LiveChatAuthorBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatAuthorBadge.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LiveChatAuthorBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatAuthorBadge.ts#L8) +[src/parser/classes/LiveChatAuthorBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatAuthorBadge.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L7) +[src/parser/classes/MetadataBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L7) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L9) +[src/parser/classes/MetadataBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L9) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L8) +[src/parser/classes/MetadataBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L8) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L10) +[src/parser/classes/MetadataBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L10) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/LiveChatAuthorBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatAuthorBadge.ts#L6) +[src/parser/classes/LiveChatAuthorBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatAuthorBadge.ts#L6) ## Methods @@ -140,17 +140,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -184,7 +192,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -218,7 +226,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -256,4 +264,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md index 9b714a24..f161896b 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatAutoModMessage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L19) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L19) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L14) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L15) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L17) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L17) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L12) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L13) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L16) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L16) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L10) +[src/parser/classes/livechat/items/LiveChatAutoModMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatAutoModMessage.ts#L10) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBanner.md b/docs/api/namespaces/YTNodes/classes/LiveChatBanner.md index 67338dc5..6c4f88fb 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBanner.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatBanner.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L17) +[src/parser/classes/livechat/items/LiveChatBanner.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L11) +[src/parser/classes/livechat/items/LiveChatBanner.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L15) +[src/parser/classes/livechat/items/LiveChatBanner.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L10) +[src/parser/classes/livechat/items/LiveChatBanner.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L9) +[src/parser/classes/livechat/items/LiveChatBanner.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L9) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L14) +[src/parser/classes/livechat/items/LiveChatBanner.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L14) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L13) +[src/parser/classes/livechat/items/LiveChatBanner.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L13) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L12) +[src/parser/classes/livechat/items/LiveChatBanner.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L12) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBanner.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBanner.ts#L7) +[src/parser/classes/livechat/items/LiveChatBanner.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBanner.ts#L7) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerChatSummary.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerChatSummary.md new file mode 100644 index 00000000..6db2fd9b --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LiveChatBannerChatSummary.md @@ -0,0 +1,251 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md index 8a4f676d..9be90679 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatBannerHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L14) +[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L12) +[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L11) +[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L10) +[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L8) +[src/parser/classes/livechat/items/LiveChatBannerHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerHeader.ts#L8) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md index 7e766e63..93aa1ce7 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatBannerPoll.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L23) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L12) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L14) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L19) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L19) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L21) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L21) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L20) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L20) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L11) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L11) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L9) +[src/parser/classes/livechat/items/LiveChatBannerPoll.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatBannerPoll.ts#L9) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatBannerRedirect.md b/docs/api/namespaces/YTNodes/classes/LiveChatBannerRedirect.md new file mode 100644 index 00000000..903124a8 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LiveChatBannerRedirect.md @@ -0,0 +1,241 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatDialog.md b/docs/api/namespaces/YTNodes/classes/LiveChatDialog.md index 95ee4e59..21e51170 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatDialog.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChatDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatDialog.ts#L12) +[src/parser/classes/LiveChatDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatDialog.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LiveChatDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatDialog.ts#L9) +[src/parser/classes/LiveChatDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatDialog.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/LiveChatDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatDialog.ts#L10) +[src/parser/classes/LiveChatDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatDialog.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/LiveChatDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatDialog.ts#L7) +[src/parser/classes/LiveChatDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatDialog.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatHeader.md b/docs/api/namespaces/YTNodes/classes/LiveChatHeader.md index 4cd77b34..4d41c523 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatHeader.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChatHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatHeader.ts#L14) +[src/parser/classes/LiveChatHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatHeader.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LiveChatHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatHeader.ts#L11) +[src/parser/classes/LiveChatHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatHeader.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/LiveChatHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatHeader.ts#L10) +[src/parser/classes/LiveChatHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatHeader.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/LiveChatHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatHeader.ts#L12) +[src/parser/classes/LiveChatHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatHeader.ts#L12) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/LiveChatHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatHeader.ts#L8) +[src/parser/classes/LiveChatHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatHeader.ts#L8) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatItemContextMenuEndpoint.md b/docs/api/namespaces/YTNodes/classes/LiveChatItemContextMenuEndpoint.md new file mode 100644 index 00000000..5c8eb6bb --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LiveChatItemContextMenuEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.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/LiveChatItemContextMenuEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/LiveChatItemContextMenuEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatItemList.md b/docs/api/namespaces/YTNodes/classes/LiveChatItemList.md index 9f87edb0..52d06be9 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatItemList.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatItemList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChatItemList.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatItemList.ts#L11) +[src/parser/classes/LiveChatItemList.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatItemList.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LiveChatItemList.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatItemList.ts#L8) +[src/parser/classes/LiveChatItemList.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatItemList.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/LiveChatItemList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatItemList.ts#L9) +[src/parser/classes/LiveChatItemList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatItemList.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/LiveChatItemList.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatItemList.ts#L6) +[src/parser/classes/LiveChatItemList.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatItemList.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md index 8cd03fdd..5c37b123 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatMembershipItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L16) +[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L13) +[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L12) +[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L10) +[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L14) +[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L11) +[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L8) +[src/parser/classes/livechat/items/LiveChatMembershipItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatMembershipItem.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md b/docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md index d2515310..2595f980 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatMessageInput.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChatMessageInput.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatMessageInput.ts#L15) +[src/parser/classes/LiveChatMessageInput.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatMessageInput.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LiveChatMessageInput.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatMessageInput.ts#L10) +[src/parser/classes/LiveChatMessageInput.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatMessageInput.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/LiveChatMessageInput.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatMessageInput.ts#L11) +[src/parser/classes/LiveChatMessageInput.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatMessageInput.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/LiveChatMessageInput.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatMessageInput.ts#L12) +[src/parser/classes/LiveChatMessageInput.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatMessageInput.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/LiveChatMessageInput.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatMessageInput.ts#L13) +[src/parser/classes/LiveChatMessageInput.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatMessageInput.ts#L13) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/LiveChatMessageInput.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatMessageInput.ts#L8) +[src/parser/classes/LiveChatMessageInput.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatMessageInput.ts#L8) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatModeChangeMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatModeChangeMessage.md new file mode 100644 index 00000000..4d233acb --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LiveChatModeChangeMessage.md @@ -0,0 +1,271 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md index 9fedb01c..a8081661 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatPaidMessage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L22) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L22) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L11) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L14) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L15) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L12) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L13) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L20) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L20) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L17) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L10) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L10) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L16) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L16) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L18) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L18) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L19) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L19) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L8) +[src/parser/classes/livechat/items/LiveChatPaidMessage.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidMessage.ts#L8) ## Methods @@ -184,17 +184,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -228,7 +236,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -262,7 +270,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -300,4 +308,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md b/docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md index a0c8fad3..b54f7647 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatPaidSticker.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L23) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L12) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L16) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L15) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L19) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L19) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L11) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L11) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L20) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L20) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L13) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L13) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L14) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L14) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L18) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L18) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L17) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L17) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L21) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L21) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L9) +[src/parser/classes/livechat/items/LiveChatPaidSticker.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPaidSticker.ts#L9) ## Methods @@ -184,17 +184,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -228,7 +236,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -262,7 +270,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -300,4 +308,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md b/docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md index a632dc97..1bd71b4d 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatParticipant.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipant.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipant.ts#L13) +[src/parser/classes/LiveChatParticipant.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipant.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipant.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipant.ts#L11) +[src/parser/classes/LiveChatParticipant.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipant.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipant.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipant.ts#L9) +[src/parser/classes/LiveChatParticipant.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipant.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipant.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipant.ts#L10) +[src/parser/classes/LiveChatParticipant.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipant.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipant.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipant.ts#L7) +[src/parser/classes/LiveChatParticipant.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipant.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatParticipantsList.md b/docs/api/namespaces/YTNodes/classes/LiveChatParticipantsList.md index 78bb78a1..871e543f 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatParticipantsList.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatParticipantsList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipantsList.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipantsList.ts#L12) +[src/parser/classes/LiveChatParticipantsList.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipantsList.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipantsList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipantsList.ts#L10) +[src/parser/classes/LiveChatParticipantsList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipantsList.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipantsList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipantsList.ts#L9) +[src/parser/classes/LiveChatParticipantsList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipantsList.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/LiveChatParticipantsList.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LiveChatParticipantsList.ts#L7) +[src/parser/classes/LiveChatParticipantsList.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LiveChatParticipantsList.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md index c92c51db..e20079ce 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatPlaceholderItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L10) +[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L7) +[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L8) +[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L5) +[src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatPlaceholderItem.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md index f6828e42..05330915 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatProductItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L27) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L27) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L13) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L22) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L22) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L25) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L25) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L20) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L20) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L21) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L21) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L19) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L19) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L17) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L18) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L18) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L23) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L23) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L24) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L24) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L15) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L15) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L14) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L14) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L12) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L12) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L16) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L16) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatProductItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatProductItem.ts#L10) +[src/parser/classes/livechat/items/LiveChatProductItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatProductItem.ts#L10) ## Methods @@ -214,17 +214,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -258,7 +266,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -292,7 +300,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -330,4 +338,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md b/docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md index 6794aea1..73706f52 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatRestrictedParticipation.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L11) +[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L9) +[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L8) +[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L6) +[src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatRestrictedParticipation.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md new file mode 100644 index 00000000..219388f3 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md @@ -0,0 +1,241 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md new file mode 100644 index 00000000..d5149d93 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md @@ -0,0 +1,271 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsHeader.md b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsHeader.md new file mode 100644 index 00000000..6c087445 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/LiveChatSponsorshipsHeader.md @@ -0,0 +1,271 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatSponsorshipsHeader.ts#L21) + +## Properties + +### author\_badges + +> **author\_badges**: `null` \| [`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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md index f3f337db..ceef0eaf 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatTextMessage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L32) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L32) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L29) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L29) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L15) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L15) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L13) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L13) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L30) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L30) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L12) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L12) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L14) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L14) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L27) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L27) ## Methods @@ -150,17 +150,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from `LiveChatMessageBase.as` #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -194,7 +202,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -228,7 +236,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -266,4 +274,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md index d1b01bcb..fd10f3b3 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidMessageItem.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L20) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L20) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L13) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L13) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L12) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L12) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L14) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L14) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L15) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L15) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L18) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L18) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L16) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L16) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L17) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L17) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L10) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L10) ## Methods @@ -148,17 +148,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -192,7 +200,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -226,7 +234,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -264,4 +272,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md index 730e3b38..b3c5e376 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatTickerPaidStickerItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L20) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L20) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L13) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L13) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L12) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L12) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L14) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L14) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L15) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L15) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L18) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L18) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L16) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L16) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L17) +[src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidMessageItem.ts#L17) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:4](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L4) +[src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts:4](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerPaidStickerItem.ts#L4) ## Methods @@ -172,17 +172,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`LiveChatTickerPaidMessageItem`](LiveChatTickerPaidMessageItem.md).[`as`](LiveChatTickerPaidMessageItem.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -216,7 +224,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -250,7 +258,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -288,4 +296,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md b/docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md index 1f4228f4..8eeb0964 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatTickerSponsorItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L14) +[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L11) +[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L10) +[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L12) +[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L9) +[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L9) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L7) +[src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTickerSponsorItem.ts#L7) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md b/docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md index 215ac5eb..f56a79bc 100644 --- a/docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md +++ b/docs/api/namespaces/YTNodes/classes/LiveChatViewerEngagementMessage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L12) +[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L10) +[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L9) +[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L15) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L15) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L13) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L13) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L12) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L12) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatTextMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L14) +[src/parser/classes/livechat/items/LiveChatTextMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatTextMessage.ts#L14) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L7) +[src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/LiveChatViewerEngagementMessage.ts#L7) ## Methods @@ -150,17 +150,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from `LiveChatMessageBase.as` #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -194,7 +202,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -228,7 +236,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -266,4 +274,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LockupMetadataView.md b/docs/api/namespaces/YTNodes/classes/LockupMetadataView.md index 1a2cdf86..8a17f6d0 100644 --- a/docs/api/namespaces/YTNodes/classes/LockupMetadataView.md +++ b/docs/api/namespaces/YTNodes/classes/LockupMetadataView.md @@ -26,17 +26,27 @@ #### Defined in -[src/parser/classes/LockupMetadataView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupMetadataView.ts#L12) +[src/parser/classes/LockupMetadataView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupMetadataView.ts#L14) ## Properties +### image + +> **image**: `null` \| [`DecoratedAvatarView`](DecoratedAvatarView.md) + +#### Defined in + +[src/parser/classes/LockupMetadataView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupMetadataView.ts#L12) + +*** + ### metadata > **metadata**: `null` \| [`ContentMetadataView`](ContentMetadataView.md) #### Defined in -[src/parser/classes/LockupMetadataView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupMetadataView.ts#L10) +[src/parser/classes/LockupMetadataView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupMetadataView.ts#L11) *** @@ -46,7 +56,7 @@ #### Defined in -[src/parser/classes/LockupMetadataView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupMetadataView.ts#L9) +[src/parser/classes/LockupMetadataView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupMetadataView.ts#L10) *** @@ -60,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +84,7 @@ #### Defined in -[src/parser/classes/LockupMetadataView.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupMetadataView.ts#L7) +[src/parser/classes/LockupMetadataView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupMetadataView.ts#L8) ## Methods @@ -94,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/LockupView.md b/docs/api/namespaces/YTNodes/classes/LockupView.md index ae5af134..ff6ebcfa 100644 --- a/docs/api/namespaces/YTNodes/classes/LockupView.md +++ b/docs/api/namespaces/YTNodes/classes/LockupView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/LockupView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupView.ts#L16) +[src/parser/classes/LockupView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupView.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/LockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupView.ts#L12) +[src/parser/classes/LockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupView.ts#L12) *** @@ -46,17 +46,17 @@ #### Defined in -[src/parser/classes/LockupView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupView.ts#L10) +[src/parser/classes/LockupView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupView.ts#L10) *** ### content\_type -> **content\_type**: `"SOURCE"` \| `"PLAYLIST"` \| `"ALBUM"` \| `"PODCAST"` \| `"SHOPPING_COLLECTION"` \| `"SHORT"` \| `"GAME"` \| `"PRODUCT"` +> **content\_type**: `"VIDEO"` \| `"MOVIE"` \| `"CHANNEL"` \| `"CLIP"` \| `"SOURCE"` \| `"PLAYLIST"` \| `"ALBUM"` \| `"PODCAST"` \| `"SHOPPING_COLLECTION"` \| `"SHORT"` \| `"GAME"` \| `"PRODUCT"` #### Defined in -[src/parser/classes/LockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupView.ts#L13) +[src/parser/classes/LockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupView.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/LockupView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupView.ts#L11) +[src/parser/classes/LockupView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupView.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/LockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupView.ts#L14) +[src/parser/classes/LockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupView.ts#L14) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/LockupView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/LockupView.ts#L8) +[src/parser/classes/LockupView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/LockupView.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md b/docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md index d58cefac..97a1d040 100644 --- a/docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md +++ b/docs/api/namespaces/YTNodes/classes/MacroMarkersInfoItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MacroMarkersInfoItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersInfoItem.ts#L12) +[src/parser/classes/MacroMarkersInfoItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersInfoItem.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MacroMarkersInfoItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersInfoItem.ts#L9) +[src/parser/classes/MacroMarkersInfoItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersInfoItem.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MacroMarkersInfoItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersInfoItem.ts#L10) +[src/parser/classes/MacroMarkersInfoItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersInfoItem.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MacroMarkersInfoItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersInfoItem.ts#L7) +[src/parser/classes/MacroMarkersInfoItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersInfoItem.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MacroMarkersList.md b/docs/api/namespaces/YTNodes/classes/MacroMarkersList.md index e011bf09..01111b8e 100644 --- a/docs/api/namespaces/YTNodes/classes/MacroMarkersList.md +++ b/docs/api/namespaces/YTNodes/classes/MacroMarkersList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MacroMarkersList.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersList.ts#L13) +[src/parser/classes/MacroMarkersList.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersList.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MacroMarkersList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersList.ts#L10) +[src/parser/classes/MacroMarkersList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersList.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MacroMarkersList.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersList.ts#L11) +[src/parser/classes/MacroMarkersList.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersList.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MacroMarkersList.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersList.ts#L8) +[src/parser/classes/MacroMarkersList.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersList.ts#L8) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md b/docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md index bfd89d74..4487e579 100644 --- a/docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md +++ b/docs/api/namespaces/YTNodes/classes/MacroMarkersListItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L18) +[src/parser/classes/MacroMarkersListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L16) +[src/parser/classes/MacroMarkersListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L16) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L15) +[src/parser/classes/MacroMarkersListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L14) +[src/parser/classes/MacroMarkersListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L13) +[src/parser/classes/MacroMarkersListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L12) +[src/parser/classes/MacroMarkersListItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L11) +[src/parser/classes/MacroMarkersListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L11) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/MacroMarkersListItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MacroMarkersListItem.ts#L9) +[src/parser/classes/MacroMarkersListItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MacroMarkersListItem.ts#L9) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md b/docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md index 45d19baa..8f195b15 100644 --- a/docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md +++ b/docs/api/namespaces/YTNodes/classes/MarkChatItemAsDeletedAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L11) +[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L8) +[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L9) +[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L6) +[src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemAsDeletedAction.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md b/docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md index 4f89b70f..72b73316 100644 --- a/docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md +++ b/docs/api/namespaces/YTNodes/classes/MarkChatItemsByAuthorAsDeletedAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L11) +[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L8) +[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L9) +[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L6) +[src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/MarkChatItemsByAuthorAsDeletedAction.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Menu.md b/docs/api/namespaces/YTNodes/classes/Menu.md index 9f15ee33..e538715a 100644 --- a/docs/api/namespaces/YTNodes/classes/Menu.md +++ b/docs/api/namespaces/YTNodes/classes/Menu.md @@ -26,17 +26,27 @@ #### Defined in -[src/parser/classes/menus/Menu.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L13) +[src/parser/classes/menus/Menu.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L20) ## Properties +### flexible\_items + +> **flexible\_items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MenuFlexibleItem`](MenuFlexibleItem.md)\> + +#### Defined in + +[src/parser/classes/menus/Menu.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L16) + +*** + ### items > **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> #### Defined in -[src/parser/classes/menus/Menu.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L9) +[src/parser/classes/menus/Menu.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L15) *** @@ -46,17 +56,17 @@ #### Defined in -[src/parser/classes/menus/Menu.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L11) +[src/parser/classes/menus/Menu.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L18) *** ### top\_level\_buttons -> **top\_level\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> +> **top\_level\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`ButtonView`](ButtonView.md) \| [`SegmentedLikeDislikeButtonView`](SegmentedLikeDislikeButtonView.md) \| [`LikeButton`](LikeButton.md) \| [`ToggleButton`](ToggleButton.md)\> #### Defined in -[src/parser/classes/menus/Menu.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L10) +[src/parser/classes/menus/Menu.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L17) *** @@ -70,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +94,7 @@ #### Defined in -[src/parser/classes/menus/Menu.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L7) +[src/parser/classes/menus/Menu.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L13) ## Accessors @@ -98,7 +108,7 @@ #### Defined in -[src/parser/classes/menus/Menu.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L24) +[src/parser/classes/menus/Menu.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L32) ## Methods @@ -118,17 +128,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +180,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +214,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +252,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MenuFlexibleItem.md b/docs/api/namespaces/YTNodes/classes/MenuFlexibleItem.md new file mode 100644 index 00000000..c4d50eaf --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/MenuFlexibleItem.md @@ -0,0 +1,221 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md b/docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md index c44854ac..a8c7f41a 100644 --- a/docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md +++ b/docs/api/namespaces/YTNodes/classes/MenuNavigationItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MenuNavigationItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuNavigationItem.ts#L7) +[src/parser/classes/menus/MenuNavigationItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuNavigationItem.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L14) +[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L14) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L12) +[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L12) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L13) +[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L13) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L10) +[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L10) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/Button.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L9) +[src/parser/classes/Button.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L9) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L11) +[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L11) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/menus/MenuNavigationItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuNavigationItem.ts#L5) +[src/parser/classes/menus/MenuNavigationItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuNavigationItem.ts#L5) ## Methods @@ -158,17 +158,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -202,7 +210,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -236,7 +244,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -274,4 +282,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MenuPopup.md b/docs/api/namespaces/YTNodes/classes/MenuPopup.md index a95d196d..6800b29d 100644 --- a/docs/api/namespaces/YTNodes/classes/MenuPopup.md +++ b/docs/api/namespaces/YTNodes/classes/MenuPopup.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MenuPopup.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuPopup.ts#L13) +[src/parser/classes/menus/MenuPopup.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuPopup.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/menus/MenuPopup.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuPopup.ts#L11) +[src/parser/classes/menus/MenuPopup.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuPopup.ts#L11) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/menus/MenuPopup.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuPopup.ts#L9) +[src/parser/classes/menus/MenuPopup.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuPopup.ts#L9) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MenuServiceItem.md b/docs/api/namespaces/YTNodes/classes/MenuServiceItem.md index 3f26a6b0..763629e2 100644 --- a/docs/api/namespaces/YTNodes/classes/MenuServiceItem.md +++ b/docs/api/namespaces/YTNodes/classes/MenuServiceItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MenuServiceItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuServiceItem.ts#L7) +[src/parser/classes/menus/MenuServiceItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuServiceItem.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L14) +[src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L14) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L12) +[src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L12) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L13) +[src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L13) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L10) +[src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L10) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/Button.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L9) +[src/parser/classes/Button.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L9) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Button.ts#L11) +[src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Button.ts#L11) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/menus/MenuServiceItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuServiceItem.ts#L5) +[src/parser/classes/menus/MenuServiceItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuServiceItem.ts#L5) ## Methods @@ -158,17 +158,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -202,7 +210,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -236,7 +244,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -274,4 +282,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md b/docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md index 970bf135..afabe19c 100644 --- a/docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md +++ b/docs/api/namespaces/YTNodes/classes/MenuServiceItemDownload.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MenuServiceItemDownload.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuServiceItemDownload.ts#L11) +[src/parser/classes/menus/MenuServiceItemDownload.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuServiceItemDownload.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/menus/MenuServiceItemDownload.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuServiceItemDownload.ts#L9) +[src/parser/classes/menus/MenuServiceItemDownload.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuServiceItemDownload.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/menus/MenuServiceItemDownload.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuServiceItemDownload.ts#L8) +[src/parser/classes/menus/MenuServiceItemDownload.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuServiceItemDownload.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/menus/MenuServiceItemDownload.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MenuServiceItemDownload.ts#L6) +[src/parser/classes/menus/MenuServiceItemDownload.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MenuServiceItemDownload.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MenuTitle.md b/docs/api/namespaces/YTNodes/classes/MenuTitle.md new file mode 100644 index 00000000..c80bde08 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/MenuTitle.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MenuTitle + +# Class: MenuTitle + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new MenuTitle() + +> **new MenuTitle**(`data`): [`MenuTitle`](MenuTitle.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`MenuTitle`](MenuTitle.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/MenuTitle.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MenuTitle.ts#L10) + +## Properties + +### title + +> **title**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/MenuTitle.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MenuTitle.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'MenuTitle'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/MenuTitle.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MenuTitle.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is MenuTitle & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is MenuTitle & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MerchandiseItem.md b/docs/api/namespaces/YTNodes/classes/MerchandiseItem.md index 5dd9754a..a504b84f 100644 --- a/docs/api/namespaces/YTNodes/classes/MerchandiseItem.md +++ b/docs/api/namespaces/YTNodes/classes/MerchandiseItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L21) +[src/parser/classes/MerchandiseItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L17) +[src/parser/classes/MerchandiseItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L17) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L15) +[src/parser/classes/MerchandiseItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L14) +[src/parser/classes/MerchandiseItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L10) +[src/parser/classes/MerchandiseItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L19) +[src/parser/classes/MerchandiseItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L19) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L16) +[src/parser/classes/MerchandiseItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L16) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L12) +[src/parser/classes/MerchandiseItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L12) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L18) +[src/parser/classes/MerchandiseItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L18) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L11) +[src/parser/classes/MerchandiseItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L11) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L9) +[src/parser/classes/MerchandiseItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L9) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L13) +[src/parser/classes/MerchandiseItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L13) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/MerchandiseItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseItem.ts#L7) +[src/parser/classes/MerchandiseItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseItem.ts#L7) ## Methods @@ -184,17 +184,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -228,7 +236,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -262,7 +270,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -300,4 +308,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md b/docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md index 4855a877..01e4cdd7 100644 --- a/docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md +++ b/docs/api/namespaces/YTNodes/classes/MerchandiseShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MerchandiseShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseShelf.ts#L11) +[src/parser/classes/MerchandiseShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseShelf.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MerchandiseShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseShelf.ts#L9) +[src/parser/classes/MerchandiseShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseShelf.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MerchandiseShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseShelf.ts#L8) +[src/parser/classes/MerchandiseShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseShelf.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MerchandiseShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseShelf.ts#L7) +[src/parser/classes/MerchandiseShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseShelf.ts#L7) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/MerchandiseShelf.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseShelf.ts#L5) +[src/parser/classes/MerchandiseShelf.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseShelf.ts#L5) ## Accessors @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/MerchandiseShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MerchandiseShelf.ts#L19) +[src/parser/classes/MerchandiseShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MerchandiseShelf.ts#L19) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Message.md b/docs/api/namespaces/YTNodes/classes/Message.md index f86813f3..78e1a8c5 100644 --- a/docs/api/namespaces/YTNodes/classes/Message.md +++ b/docs/api/namespaces/YTNodes/classes/Message.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Message.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Message.ts#L10) +[src/parser/classes/Message.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Message.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Message.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Message.ts#L8) +[src/parser/classes/Message.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Message.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/Message.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Message.ts#L6) +[src/parser/classes/Message.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Message.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MetadataBadge.md b/docs/api/namespaces/YTNodes/classes/MetadataBadge.md index c921bc8c..e0a137e2 100644 --- a/docs/api/namespaces/YTNodes/classes/MetadataBadge.md +++ b/docs/api/namespaces/YTNodes/classes/MetadataBadge.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L12) +[src/parser/classes/MetadataBadge.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L12) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L7) +[src/parser/classes/MetadataBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L9) +[src/parser/classes/MetadataBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L8) +[src/parser/classes/MetadataBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L8) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L10) +[src/parser/classes/MetadataBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L10) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/MetadataBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataBadge.ts#L5) +[src/parser/classes/MetadataBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataBadge.ts#L5) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MetadataRow.md b/docs/api/namespaces/YTNodes/classes/MetadataRow.md index 093c9658..82b1025d 100644 --- a/docs/api/namespaces/YTNodes/classes/MetadataRow.md +++ b/docs/api/namespaces/YTNodes/classes/MetadataRow.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MetadataRow.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRow.ts#L11) +[src/parser/classes/MetadataRow.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRow.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MetadataRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRow.ts#L9) +[src/parser/classes/MetadataRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRow.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MetadataRow.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRow.ts#L8) +[src/parser/classes/MetadataRow.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRow.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MetadataRow.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRow.ts#L6) +[src/parser/classes/MetadataRow.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRow.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MetadataRowContainer.md b/docs/api/namespaces/YTNodes/classes/MetadataRowContainer.md index 780a9de5..b32fa5d1 100644 --- a/docs/api/namespaces/YTNodes/classes/MetadataRowContainer.md +++ b/docs/api/namespaces/YTNodes/classes/MetadataRowContainer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MetadataRowContainer.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowContainer.ts#L10) +[src/parser/classes/MetadataRowContainer.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowContainer.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MetadataRowContainer.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowContainer.ts#L8) +[src/parser/classes/MetadataRowContainer.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowContainer.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MetadataRowContainer.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowContainer.ts#L7) +[src/parser/classes/MetadataRowContainer.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowContainer.ts#L7) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MetadataRowContainer.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowContainer.ts#L5) +[src/parser/classes/MetadataRowContainer.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowContainer.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md b/docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md index c665b9f9..a0d6fe9e 100644 --- a/docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MetadataRowHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MetadataRowHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowHeader.ts#L11) +[src/parser/classes/MetadataRowHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowHeader.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MetadataRowHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowHeader.ts#L8) +[src/parser/classes/MetadataRowHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowHeader.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MetadataRowHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowHeader.ts#L9) +[src/parser/classes/MetadataRowHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowHeader.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MetadataRowHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataRowHeader.ts#L6) +[src/parser/classes/MetadataRowHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataRowHeader.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MetadataScreen.md b/docs/api/namespaces/YTNodes/classes/MetadataScreen.md index 0bdbccc5..fe08566a 100644 --- a/docs/api/namespaces/YTNodes/classes/MetadataScreen.md +++ b/docs/api/namespaces/YTNodes/classes/MetadataScreen.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MetadataScreen.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataScreen.ts#L9) +[src/parser/classes/MetadataScreen.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataScreen.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MetadataScreen.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataScreen.ts#L7) +[src/parser/classes/MetadataScreen.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataScreen.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MetadataScreen.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MetadataScreen.ts#L5) +[src/parser/classes/MetadataScreen.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MetadataScreen.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MicroformatData.md b/docs/api/namespaces/YTNodes/classes/MicroformatData.md index b7914caa..797dd37a 100644 --- a/docs/api/namespaces/YTNodes/classes/MicroformatData.md +++ b/docs/api/namespaces/YTNodes/classes/MicroformatData.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L32) +[src/parser/classes/MicroformatData.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L32) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L14) +[src/parser/classes/MicroformatData.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L13) +[src/parser/classes/MicroformatData.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L30) +[src/parser/classes/MicroformatData.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L30) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L10) +[src/parser/classes/MicroformatData.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L16) +[src/parser/classes/MicroformatData.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L15) +[src/parser/classes/MicroformatData.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L15) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L28) +[src/parser/classes/MicroformatData.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L28) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L27) +[src/parser/classes/MicroformatData.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L27) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L26) +[src/parser/classes/MicroformatData.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L26) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L17) +[src/parser/classes/MicroformatData.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L17) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L25) +[src/parser/classes/MicroformatData.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L25) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L12) +[src/parser/classes/MicroformatData.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L12) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L29) +[src/parser/classes/MicroformatData.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L29) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L11) +[src/parser/classes/MicroformatData.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L11) *** @@ -176,7 +176,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L9) +[src/parser/classes/MicroformatData.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L9) *** @@ -186,7 +186,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L23) +[src/parser/classes/MicroformatData.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L23) *** @@ -196,7 +196,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L24) +[src/parser/classes/MicroformatData.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L24) *** @@ -210,7 +210,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -220,7 +220,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L20) +[src/parser/classes/MicroformatData.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L20) *** @@ -230,7 +230,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L19) +[src/parser/classes/MicroformatData.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L19) *** @@ -240,7 +240,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L18) +[src/parser/classes/MicroformatData.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L18) *** @@ -250,7 +250,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L8) +[src/parser/classes/MicroformatData.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L8) *** @@ -260,7 +260,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L22) +[src/parser/classes/MicroformatData.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L22) *** @@ -270,7 +270,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L21) +[src/parser/classes/MicroformatData.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L21) *** @@ -284,7 +284,7 @@ #### Defined in -[src/parser/classes/MicroformatData.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MicroformatData.ts#L6) +[src/parser/classes/MicroformatData.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MicroformatData.ts#L6) ## Methods @@ -304,17 +304,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -348,7 +356,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -382,7 +390,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -420,4 +428,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Mix.md b/docs/api/namespaces/YTNodes/classes/Mix.md index dcbdb79e..b62beb42 100644 --- a/docs/api/namespaces/YTNodes/classes/Mix.md +++ b/docs/api/namespaces/YTNodes/classes/Mix.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Mix.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Mix.ts#L7) +[src/parser/classes/Mix.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Mix.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L15) +[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L15) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L23) +[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L23) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L24) +[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L24) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L20) +[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L20) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L13) +[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L13) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L22) +[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L22) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L21) +[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L21) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L25) +[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L25) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L17) +[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L17) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L16) +[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L16) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L14) +[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L14) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L18) +[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L18) *** @@ -222,7 +222,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L19) +[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L19) *** @@ -236,7 +236,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L26) +[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L26) *** @@ -250,7 +250,7 @@ #### Defined in -[src/parser/classes/Mix.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Mix.ts#L5) +[src/parser/classes/Mix.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Mix.ts#L5) ## Methods @@ -270,17 +270,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`Playlist`](Playlist.md).[`as`](Playlist.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -314,7 +322,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -348,7 +356,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -386,4 +394,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md b/docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md index 0993b939..78fd0217 100644 --- a/docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md +++ b/docs/api/namespaces/YTNodes/classes/ModalWithTitleAndButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ModalWithTitleAndButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ModalWithTitleAndButton.ts#L13) +[src/parser/classes/ModalWithTitleAndButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ModalWithTitleAndButton.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ModalWithTitleAndButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ModalWithTitleAndButton.ts#L11) +[src/parser/classes/ModalWithTitleAndButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ModalWithTitleAndButton.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ModalWithTitleAndButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ModalWithTitleAndButton.ts#L10) +[src/parser/classes/ModalWithTitleAndButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ModalWithTitleAndButton.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ModalWithTitleAndButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ModalWithTitleAndButton.ts#L9) +[src/parser/classes/ModalWithTitleAndButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ModalWithTitleAndButton.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ModalWithTitleAndButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ModalWithTitleAndButton.ts#L7) +[src/parser/classes/ModalWithTitleAndButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ModalWithTitleAndButton.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md b/docs/api/namespaces/YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md new file mode 100644 index 00000000..556de251 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.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/ModifyChannelNotificationPreferenceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ModifyChannelNotificationPreferenceEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Movie.md b/docs/api/namespaces/YTNodes/classes/Movie.md index b05ec145..2c3d8955 100644 --- a/docs/api/namespaces/YTNodes/classes/Movie.md +++ b/docs/api/namespaces/YTNodes/classes/Movie.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Movie.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L32) +[src/parser/classes/Movie.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L32) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Movie.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L19) +[src/parser/classes/Movie.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L19) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Movie.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L27) +[src/parser/classes/Movie.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L27) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Movie.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L15) +[src/parser/classes/Movie.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L15) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/Movie.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L21) +[src/parser/classes/Movie.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L21) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/Movie.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L26) +[src/parser/classes/Movie.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L26) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/Movie.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L13) +[src/parser/classes/Movie.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L13) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/Movie.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L30) +[src/parser/classes/Movie.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L30) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/Movie.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L29) +[src/parser/classes/Movie.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L29) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/Movie.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L18) +[src/parser/classes/Movie.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L18) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/Movie.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L17) +[src/parser/classes/Movie.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L17) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/Movie.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L14) +[src/parser/classes/Movie.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L14) *** @@ -154,7 +154,7 @@ #### Defined in -[src/parser/classes/Movie.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L16) +[src/parser/classes/Movie.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L16) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -178,7 +178,7 @@ #### Defined in -[src/parser/classes/Movie.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L28) +[src/parser/classes/Movie.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L28) *** @@ -192,7 +192,7 @@ #### Defined in -[src/parser/classes/Movie.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Movie.ts#L11) +[src/parser/classes/Movie.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Movie.ts#L11) ## Methods @@ -212,17 +212,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -256,7 +264,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -290,7 +298,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -328,4 +336,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MovingThumbnail.md b/docs/api/namespaces/YTNodes/classes/MovingThumbnail.md index 973bff10..6ba69673 100644 --- a/docs/api/namespaces/YTNodes/classes/MovingThumbnail.md +++ b/docs/api/namespaces/YTNodes/classes/MovingThumbnail.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MovingThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MovingThumbnail.ts#L8) +[src/parser/classes/MovingThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MovingThumbnail.ts#L8) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/MovingThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MovingThumbnail.ts#L6) +[src/parser/classes/MovingThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MovingThumbnail.ts#L6) ## Methods @@ -74,17 +74,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -118,7 +126,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -152,7 +160,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -190,4 +198,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MultiMarkersPlayerBar.md b/docs/api/namespaces/YTNodes/classes/MultiMarkersPlayerBar.md index 39d7449f..074d3d5e 100644 --- a/docs/api/namespaces/YTNodes/classes/MultiMarkersPlayerBar.md +++ b/docs/api/namespaces/YTNodes/classes/MultiMarkersPlayerBar.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MultiMarkersPlayerBar.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MultiMarkersPlayerBar.ts#L39) +[src/parser/classes/MultiMarkersPlayerBar.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MultiMarkersPlayerBar.ts#L39) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MultiMarkersPlayerBar.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MultiMarkersPlayerBar.ts#L37) +[src/parser/classes/MultiMarkersPlayerBar.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MultiMarkersPlayerBar.ts#L37) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MultiMarkersPlayerBar.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MultiMarkersPlayerBar.ts#L35) +[src/parser/classes/MultiMarkersPlayerBar.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MultiMarkersPlayerBar.ts#L35) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MultiPageMenu.md b/docs/api/namespaces/YTNodes/classes/MultiPageMenu.md index 076a0ec7..8c9ac357 100644 --- a/docs/api/namespaces/YTNodes/classes/MultiPageMenu.md +++ b/docs/api/namespaces/YTNodes/classes/MultiPageMenu.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenu.ts#L13) +[src/parser/classes/menus/MultiPageMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenu.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenu.ts#L9) +[src/parser/classes/menus/MultiPageMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenu.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenu.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenu.ts#L10) +[src/parser/classes/menus/MultiPageMenu.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenu.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenu.ts#L11) +[src/parser/classes/menus/MultiPageMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenu.ts#L11) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenu.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenu.ts#L7) +[src/parser/classes/menus/MultiPageMenu.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenu.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md b/docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md index 585887ea..73eb72c9 100644 --- a/docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md +++ b/docs/api/namespaces/YTNodes/classes/MultiPageMenuNotificationSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L10) +[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L8) +[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L6) +[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L6) ## Accessors @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L16) +[src/parser/classes/menus/MultiPageMenuNotificationSection.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MultiPageMenuNotificationSection.ts#L16) ## Methods @@ -98,17 +98,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -142,7 +150,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -176,7 +184,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -214,4 +222,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md b/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md index 41e8a4ec..f787b021 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md +++ b/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L27) +[src/parser/classes/MusicCardShelf.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L27) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L18) +[src/parser/classes/MusicCardShelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L18) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L25) +[src/parser/classes/MusicCardShelf.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L25) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L22) +[src/parser/classes/MusicCardShelf.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L22) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L21) +[src/parser/classes/MusicCardShelf.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L21) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L19) +[src/parser/classes/MusicCardShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L19) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L20) +[src/parser/classes/MusicCardShelf.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L20) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L17) +[src/parser/classes/MusicCardShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L23) +[src/parser/classes/MusicCardShelf.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L23) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L15) +[src/parser/classes/MusicCardShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L15) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L24) +[src/parser/classes/MusicCardShelf.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L24) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L16) +[src/parser/classes/MusicCardShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L16) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/MusicCardShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelf.ts#L13) +[src/parser/classes/MusicCardShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelf.ts#L13) ## Methods @@ -184,17 +184,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -228,7 +236,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -262,7 +270,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -300,4 +308,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicCardShelfHeaderBasic.md b/docs/api/namespaces/YTNodes/classes/MusicCardShelfHeaderBasic.md index 089ff7af..5a949dc4 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicCardShelfHeaderBasic.md +++ b/docs/api/namespaces/YTNodes/classes/MusicCardShelfHeaderBasic.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicCardShelfHeaderBasic.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelfHeaderBasic.ts#L10) +[src/parser/classes/MusicCardShelfHeaderBasic.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelfHeaderBasic.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicCardShelfHeaderBasic.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelfHeaderBasic.ts#L8) +[src/parser/classes/MusicCardShelfHeaderBasic.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelfHeaderBasic.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MusicCardShelfHeaderBasic.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCardShelfHeaderBasic.ts#L6) +[src/parser/classes/MusicCardShelfHeaderBasic.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCardShelfHeaderBasic.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md b/docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md index fecd5cef..27cefa8b 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md +++ b/docs/api/namespaces/YTNodes/classes/MusicCarouselShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelf.ts#L17) +[src/parser/classes/MusicCarouselShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelf.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelf.ts#L14) +[src/parser/classes/MusicCarouselShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelf.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelf.ts#L13) +[src/parser/classes/MusicCarouselShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelf.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelf.ts#L15) +[src/parser/classes/MusicCarouselShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelf.ts#L15) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelf.ts#L11) +[src/parser/classes/MusicCarouselShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelf.ts#L11) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md b/docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md index fb397e39..358e86ed 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicCarouselShelfBasicHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L17) +[src/parser/classes/MusicCarouselShelfBasicHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L15) +[src/parser/classes/MusicCarouselShelfBasicHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L14) +[src/parser/classes/MusicCarouselShelfBasicHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L12) +[src/parser/classes/MusicCarouselShelfBasicHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L13) +[src/parser/classes/MusicCarouselShelfBasicHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L11) +[src/parser/classes/MusicCarouselShelfBasicHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/MusicCarouselShelfBasicHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L9) +[src/parser/classes/MusicCarouselShelfBasicHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicCarouselShelfBasicHeader.ts#L9) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md b/docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md index 2cb5cd76..91a3602c 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md +++ b/docs/api/namespaces/YTNodes/classes/MusicDescriptionShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicDescriptionShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDescriptionShelf.ts#L13) +[src/parser/classes/MusicDescriptionShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDescriptionShelf.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicDescriptionShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDescriptionShelf.ts#L8) +[src/parser/classes/MusicDescriptionShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDescriptionShelf.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicDescriptionShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDescriptionShelf.ts#L11) +[src/parser/classes/MusicDescriptionShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDescriptionShelf.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicDescriptionShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDescriptionShelf.ts#L9) +[src/parser/classes/MusicDescriptionShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDescriptionShelf.ts#L9) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicDescriptionShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDescriptionShelf.ts#L10) +[src/parser/classes/MusicDescriptionShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDescriptionShelf.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/MusicDescriptionShelf.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDescriptionShelf.ts#L6) +[src/parser/classes/MusicDescriptionShelf.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDescriptionShelf.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md b/docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md index f75a3d6d..1f030c94 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicDetailHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L27) +[src/parser/classes/MusicDetailHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L27) ## Properties @@ -48,7 +48,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L20) +[src/parser/classes/MusicDetailHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L20) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L19) +[src/parser/classes/MusicDetailHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L19) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L12) +[src/parser/classes/MusicDetailHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L12) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L25) +[src/parser/classes/MusicDetailHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L25) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L14) +[src/parser/classes/MusicDetailHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L14) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L16) +[src/parser/classes/MusicDetailHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L16) *** @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L13) +[src/parser/classes/MusicDetailHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L13) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L18) +[src/parser/classes/MusicDetailHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L18) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L11) +[src/parser/classes/MusicDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L11) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L17) +[src/parser/classes/MusicDetailHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L17) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -162,7 +162,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L15) +[src/parser/classes/MusicDetailHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L15) *** @@ -176,7 +176,7 @@ #### Defined in -[src/parser/classes/MusicDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L9) +[src/parser/classes/MusicDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L9) ## Methods @@ -196,17 +196,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -240,7 +248,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -274,7 +282,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -312,4 +320,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md b/docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md index cb0de7d1..e526ea1f 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md +++ b/docs/api/namespaces/YTNodes/classes/MusicDownloadStateBadge.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicDownloadStateBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDownloadStateBadge.ts#L10) +[src/parser/classes/MusicDownloadStateBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDownloadStateBadge.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicDownloadStateBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDownloadStateBadge.ts#L7) +[src/parser/classes/MusicDownloadStateBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDownloadStateBadge.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicDownloadStateBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDownloadStateBadge.ts#L8) +[src/parser/classes/MusicDownloadStateBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDownloadStateBadge.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicDownloadStateBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDownloadStateBadge.ts#L5) +[src/parser/classes/MusicDownloadStateBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDownloadStateBadge.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md b/docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md index 9036d6e7..2ec99051 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicEditablePlaylistDetailHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L11) +[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L8) +[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L7) +[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L7) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L9) +[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L5) +[src/parser/classes/MusicEditablePlaylistDetailHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicEditablePlaylistDetailHeader.ts#L5) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicElementHeader.md b/docs/api/namespaces/YTNodes/classes/MusicElementHeader.md index 24a668cb..5e2dd517 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicElementHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicElementHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicElementHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicElementHeader.ts#L10) +[src/parser/classes/MusicElementHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicElementHeader.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicElementHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicElementHeader.ts#L8) +[src/parser/classes/MusicElementHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicElementHeader.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MusicElementHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicElementHeader.ts#L6) +[src/parser/classes/MusicElementHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicElementHeader.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicHeader.md b/docs/api/namespaces/YTNodes/classes/MusicHeader.md index 47303bb7..39206e82 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicHeader.ts#L11) +[src/parser/classes/MusicHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicHeader.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicHeader.ts#L8) +[src/parser/classes/MusicHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicHeader.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicHeader.ts#L9) +[src/parser/classes/MusicHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicHeader.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicHeader.ts#L6) +[src/parser/classes/MusicHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicHeader.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md b/docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md index b75536ed..05711797 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicImmersiveHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicImmersiveHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicImmersiveHeader.ts#L13) +[src/parser/classes/MusicImmersiveHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicImmersiveHeader.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicImmersiveHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicImmersiveHeader.ts#L10) +[src/parser/classes/MusicImmersiveHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicImmersiveHeader.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicImmersiveHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicImmersiveHeader.ts#L11) +[src/parser/classes/MusicImmersiveHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicImmersiveHeader.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicImmersiveHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicImmersiveHeader.ts#L9) +[src/parser/classes/MusicImmersiveHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicImmersiveHeader.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/MusicImmersiveHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicImmersiveHeader.ts#L7) +[src/parser/classes/MusicImmersiveHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicImmersiveHeader.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md b/docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md index a3bc1f2b..0d435c5f 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md +++ b/docs/api/namespaces/YTNodes/classes/MusicInlineBadge.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicInlineBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicInlineBadge.ts#L10) +[src/parser/classes/MusicInlineBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicInlineBadge.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicInlineBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicInlineBadge.ts#L7) +[src/parser/classes/MusicInlineBadge.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicInlineBadge.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicInlineBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicInlineBadge.ts#L8) +[src/parser/classes/MusicInlineBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicInlineBadge.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicInlineBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicInlineBadge.ts#L5) +[src/parser/classes/MusicInlineBadge.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicInlineBadge.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md b/docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md index 5824084d..0c7e5816 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md +++ b/docs/api/namespaces/YTNodes/classes/MusicItemThumbnailOverlay.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicItemThumbnailOverlay.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicItemThumbnailOverlay.ts#L12) +[src/parser/classes/MusicItemThumbnailOverlay.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicItemThumbnailOverlay.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicItemThumbnailOverlay.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicItemThumbnailOverlay.ts#L8) +[src/parser/classes/MusicItemThumbnailOverlay.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicItemThumbnailOverlay.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicItemThumbnailOverlay.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicItemThumbnailOverlay.ts#L9) +[src/parser/classes/MusicItemThumbnailOverlay.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicItemThumbnailOverlay.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicItemThumbnailOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicItemThumbnailOverlay.ts#L10) +[src/parser/classes/MusicItemThumbnailOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicItemThumbnailOverlay.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/MusicItemThumbnailOverlay.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicItemThumbnailOverlay.ts#L6) +[src/parser/classes/MusicItemThumbnailOverlay.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicItemThumbnailOverlay.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md b/docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md index 21a8f4e9..142900c2 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md +++ b/docs/api/namespaces/YTNodes/classes/MusicLargeCardItemCarousel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicLargeCardItemCarousel.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicLargeCardItemCarousel.ts#L49) +[src/parser/classes/MusicLargeCardItemCarousel.ts:49](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicLargeCardItemCarousel.ts#L49) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicLargeCardItemCarousel.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicLargeCardItemCarousel.ts#L47) +[src/parser/classes/MusicLargeCardItemCarousel.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicLargeCardItemCarousel.ts#L47) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicLargeCardItemCarousel.ts:46](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicLargeCardItemCarousel.ts#L46) +[src/parser/classes/MusicLargeCardItemCarousel.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicLargeCardItemCarousel.ts#L46) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicLargeCardItemCarousel.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicLargeCardItemCarousel.ts#L44) +[src/parser/classes/MusicLargeCardItemCarousel.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicLargeCardItemCarousel.ts#L44) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicMenuItemDivider.md b/docs/api/namespaces/YTNodes/classes/MusicMenuItemDivider.md index 2076c114..00b568dc 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicMenuItemDivider.md +++ b/docs/api/namespaces/YTNodes/classes/MusicMenuItemDivider.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MusicMenuItemDivider.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMenuItemDivider.ts#L8) +[src/parser/classes/menus/MusicMenuItemDivider.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMenuItemDivider.ts#L8) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/menus/MusicMenuItemDivider.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMenuItemDivider.ts#L5) +[src/parser/classes/menus/MusicMenuItemDivider.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMenuItemDivider.ts#L5) ## Methods @@ -74,17 +74,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -118,7 +126,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -152,7 +160,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -190,4 +198,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md b/docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md index 568acdeb..c5eddaba 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md +++ b/docs/api/namespaces/YTNodes/classes/MusicMultiRowListItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L23) +[src/parser/classes/MusicMultiRowListItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L20) +[src/parser/classes/MusicMultiRowListItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L20) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L21) +[src/parser/classes/MusicMultiRowListItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L21) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L16) +[src/parser/classes/MusicMultiRowListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L16) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L15) +[src/parser/classes/MusicMultiRowListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L15) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L14) +[src/parser/classes/MusicMultiRowListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L14) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L19) +[src/parser/classes/MusicMultiRowListItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L19) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L17) +[src/parser/classes/MusicMultiRowListItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L13) +[src/parser/classes/MusicMultiRowListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L13) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L18) +[src/parser/classes/MusicMultiRowListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L18) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/MusicMultiRowListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicMultiRowListItem.ts#L11) +[src/parser/classes/MusicMultiRowListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicMultiRowListItem.ts#L11) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenu.md b/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenu.md index f5f62138..c4820c62 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenu.md +++ b/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenu.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenu.ts#L15) +[src/parser/classes/menus/MusicMultiSelectMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenu.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenu.ts#L13) +[src/parser/classes/menus/MusicMultiSelectMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenu.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenu.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenu.ts#L12) +[src/parser/classes/menus/MusicMultiSelectMenu.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenu.ts#L12) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenu.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenu.ts#L10) +[src/parser/classes/menus/MusicMultiSelectMenu.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenu.ts#L10) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md b/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md index 507c8735..29c1345b 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md +++ b/docs/api/namespaces/YTNodes/classes/MusicMultiSelectMenuItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L15) +[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L12) +[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L10) +[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L13) +[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L11) +[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L9) +[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L9) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L7) +[src/parser/classes/menus/MusicMultiSelectMenuItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/MusicMultiSelectMenuItem.ts#L7) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md b/docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md index 4696f80e..c48ffe59 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md +++ b/docs/api/namespaces/YTNodes/classes/MusicNavigationButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicNavigationButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicNavigationButton.ts#L12) +[src/parser/classes/MusicNavigationButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicNavigationButton.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicNavigationButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicNavigationButton.ts#L9) +[src/parser/classes/MusicNavigationButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicNavigationButton.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicNavigationButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicNavigationButton.ts#L10) +[src/parser/classes/MusicNavigationButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicNavigationButton.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicNavigationButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicNavigationButton.ts#L7) +[src/parser/classes/MusicNavigationButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicNavigationButton.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicPlayButton.md b/docs/api/namespaces/YTNodes/classes/MusicPlayButton.md index 9de339db..ae77279a 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicPlayButton.md +++ b/docs/api/namespaces/YTNodes/classes/MusicPlayButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L15) +[src/parser/classes/MusicPlayButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L8) +[src/parser/classes/MusicPlayButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L13) +[src/parser/classes/MusicPlayButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L10) +[src/parser/classes/MusicPlayButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L12) +[src/parser/classes/MusicPlayButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L9) +[src/parser/classes/MusicPlayButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L9) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L11) +[src/parser/classes/MusicPlayButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L11) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/MusicPlayButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlayButton.ts#L6) +[src/parser/classes/MusicPlayButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlayButton.ts#L6) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md b/docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md index b8a58721..5c419c86 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicPlaylistEditHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L18) +[src/parser/classes/MusicPlaylistEditHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L12) +[src/parser/classes/MusicPlaylistEditHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L11) +[src/parser/classes/MusicPlaylistEditHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L15) +[src/parser/classes/MusicPlaylistEditHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L14) +[src/parser/classes/MusicPlaylistEditHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L13) +[src/parser/classes/MusicPlaylistEditHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L16) +[src/parser/classes/MusicPlaylistEditHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L16) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L10) +[src/parser/classes/MusicPlaylistEditHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L10) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistEditHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistEditHeader.ts#L8) +[src/parser/classes/MusicPlaylistEditHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistEditHeader.ts#L8) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md b/docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md index 73def322..4df3ed49 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md +++ b/docs/api/namespaces/YTNodes/classes/MusicPlaylistShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistShelf.ts#L13) +[src/parser/classes/MusicPlaylistShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistShelf.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistShelf.ts#L10) +[src/parser/classes/MusicPlaylistShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistShelf.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistShelf.ts#L9) +[src/parser/classes/MusicPlaylistShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistShelf.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistShelf.ts#L11) +[src/parser/classes/MusicPlaylistShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistShelf.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistShelf.ts#L8) +[src/parser/classes/MusicPlaylistShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistShelf.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/MusicPlaylistShelf.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicPlaylistShelf.ts#L6) +[src/parser/classes/MusicPlaylistShelf.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicPlaylistShelf.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicQueue.md b/docs/api/namespaces/YTNodes/classes/MusicQueue.md index 5fb36e9c..01665382 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicQueue.md +++ b/docs/api/namespaces/YTNodes/classes/MusicQueue.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicQueue.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicQueue.ts#L10) +[src/parser/classes/MusicQueue.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicQueue.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicQueue.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicQueue.ts#L8) +[src/parser/classes/MusicQueue.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicQueue.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MusicQueue.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicQueue.ts#L6) +[src/parser/classes/MusicQueue.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicQueue.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md index d401ee68..a851efcd 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicResponsiveHeader.md @@ -26,17 +26,17 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L28) +[src/parser/classes/MusicResponsiveHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L28) ## Properties ### buttons -> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`Menu`](Menu.md) \| [`ToggleButton`](ToggleButton.md) \| [`MusicPlayButton`](MusicPlayButton.md) \| [`DownloadButton`](DownloadButton.md)\> +> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`DownloadButton`](DownloadButton.md) \| [`ToggleButton`](ToggleButton.md) \| [`Menu`](Menu.md) \| [`MusicPlayButton`](MusicPlayButton.md)\> #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L19) +[src/parser/classes/MusicResponsiveHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L19) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L26) +[src/parser/classes/MusicResponsiveHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L26) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L24) +[src/parser/classes/MusicResponsiveHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L24) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L22) +[src/parser/classes/MusicResponsiveHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L22) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L23) +[src/parser/classes/MusicResponsiveHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L23) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L21) +[src/parser/classes/MusicResponsiveHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L21) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L25) +[src/parser/classes/MusicResponsiveHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L25) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L18) +[src/parser/classes/MusicResponsiveHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L18) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L20) +[src/parser/classes/MusicResponsiveHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L20) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L16) +[src/parser/classes/MusicResponsiveHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L16) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md index feef69c0..dbb0cd77 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md +++ b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:76](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L76) +[src/parser/classes/MusicResponsiveListItem.ts:76](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L76) ## Properties @@ -48,7 +48,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L43) +[src/parser/classes/MusicResponsiveListItem.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L43) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L49) +[src/parser/classes/MusicResponsiveListItem.ts:49](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L49) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:68](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L68) +[src/parser/classes/MusicResponsiveListItem.ts:68](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L68) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:56](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L56) +[src/parser/classes/MusicResponsiveListItem.ts:56](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L56) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L32) +[src/parser/classes/MusicResponsiveListItem.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L32) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L38) +[src/parser/classes/MusicResponsiveListItem.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L38) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L28) +[src/parser/classes/MusicResponsiveListItem.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L28) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L22) +[src/parser/classes/MusicResponsiveListItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L22) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L21) +[src/parser/classes/MusicResponsiveListItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L21) *** @@ -158,7 +158,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L36) +[src/parser/classes/MusicResponsiveListItem.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L36) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L30) +[src/parser/classes/MusicResponsiveListItem.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L30) *** @@ -178,17 +178,17 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:73](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L73) +[src/parser/classes/MusicResponsiveListItem.ts:73](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L73) *** ### item\_type -> **item\_type**: `undefined` \| `"unknown"` \| `"endpoint"` \| `"video"` \| `"playlist"` \| `"album"` \| `"artist"` \| `"library_artist"` \| `"non_music_track"` \| `"song"` \| `"podcast_show"` +> **item\_type**: `undefined` \| `"unknown"` \| `"endpoint"` \| `"playlist"` \| `"album"` \| `"artist"` \| `"library_artist"` \| `"non_music_track"` \| `"video"` \| `"song"` \| `"podcast_show"` #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L29) +[src/parser/classes/MusicResponsiveListItem.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L29) *** @@ -198,7 +198,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L33) +[src/parser/classes/MusicResponsiveListItem.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L33) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:62](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L62) +[src/parser/classes/MusicResponsiveListItem.ts:62](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L62) *** @@ -218,7 +218,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L34) +[src/parser/classes/MusicResponsiveListItem.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L34) *** @@ -228,7 +228,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:65](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L65) +[src/parser/classes/MusicResponsiveListItem.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L65) *** @@ -238,7 +238,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:64](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L64) +[src/parser/classes/MusicResponsiveListItem.ts:64](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L64) *** @@ -248,7 +248,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L63) +[src/parser/classes/MusicResponsiveListItem.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L63) *** @@ -258,7 +258,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L31) +[src/parser/classes/MusicResponsiveListItem.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L31) *** @@ -268,7 +268,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L37) +[src/parser/classes/MusicResponsiveListItem.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L37) *** @@ -282,7 +282,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -292,7 +292,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:55](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L55) +[src/parser/classes/MusicResponsiveListItem.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L55) *** @@ -302,7 +302,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:74](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L74) +[src/parser/classes/MusicResponsiveListItem.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L74) *** @@ -316,7 +316,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L19) +[src/parser/classes/MusicResponsiveListItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L19) ## Accessors @@ -330,7 +330,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItem.ts:333](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItem.ts#L333) +[src/parser/classes/MusicResponsiveListItem.ts:333](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItem.ts#L333) ## Methods @@ -350,17 +350,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -394,7 +402,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -428,7 +436,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -466,4 +474,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md index ea939734..b1444d87 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md +++ b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFixedColumn.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L11) +[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L9) +[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L8) +[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L6) +[src/parser/classes/MusicResponsiveListItemFixedColumn.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFixedColumn.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md index 12d1b099..84d9da47 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md +++ b/docs/api/namespaces/YTNodes/classes/MusicResponsiveListItemFlexColumn.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L11) +[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L9) +[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L8) +[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L6) +[src/parser/classes/MusicResponsiveListItemFlexColumn.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveListItemFlexColumn.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicShelf.md b/docs/api/namespaces/YTNodes/classes/MusicShelf.md index 48ee30ed..3713460b 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicShelf.md +++ b/docs/api/namespaces/YTNodes/classes/MusicShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L19) +[src/parser/classes/MusicShelf.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L19) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L16) +[src/parser/classes/MusicShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L16) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L15) +[src/parser/classes/MusicShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L12) +[src/parser/classes/MusicShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L14) +[src/parser/classes/MusicShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L13) +[src/parser/classes/MusicShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L17) +[src/parser/classes/MusicShelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L17) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L11) +[src/parser/classes/MusicShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L11) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/MusicShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicShelf.ts#L9) +[src/parser/classes/MusicShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicShelf.ts#L9) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicSideAlignedItem.md b/docs/api/namespaces/YTNodes/classes/MusicSideAlignedItem.md index a691c5e8..3d630f04 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicSideAlignedItem.md +++ b/docs/api/namespaces/YTNodes/classes/MusicSideAlignedItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicSideAlignedItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSideAlignedItem.ts#L10) +[src/parser/classes/MusicSideAlignedItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSideAlignedItem.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicSideAlignedItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSideAlignedItem.ts#L8) +[src/parser/classes/MusicSideAlignedItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSideAlignedItem.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicSideAlignedItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSideAlignedItem.ts#L7) +[src/parser/classes/MusicSideAlignedItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSideAlignedItem.ts#L7) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/MusicSideAlignedItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSideAlignedItem.ts#L5) +[src/parser/classes/MusicSideAlignedItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSideAlignedItem.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md b/docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md index 46138369..addd792a 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md +++ b/docs/api/namespaces/YTNodes/classes/MusicSortFilterButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicSortFilterButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSortFilterButton.ts#L13) +[src/parser/classes/MusicSortFilterButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSortFilterButton.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicSortFilterButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSortFilterButton.ts#L10) +[src/parser/classes/MusicSortFilterButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSortFilterButton.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicSortFilterButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSortFilterButton.ts#L11) +[src/parser/classes/MusicSortFilterButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSortFilterButton.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicSortFilterButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSortFilterButton.ts#L9) +[src/parser/classes/MusicSortFilterButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSortFilterButton.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/MusicSortFilterButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicSortFilterButton.ts#L7) +[src/parser/classes/MusicSortFilterButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicSortFilterButton.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md b/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md index 88411414..cdae1723 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md +++ b/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelf.ts#L18) +[src/parser/classes/MusicTastebuilderShelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelf.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelf.ts#L15) +[src/parser/classes/MusicTastebuilderShelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelf.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelf.ts#L16) +[src/parser/classes/MusicTastebuilderShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelf.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelf.ts#L13) +[src/parser/classes/MusicTastebuilderShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelf.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelf.ts#L14) +[src/parser/classes/MusicTastebuilderShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelf.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelf.ts#L12) +[src/parser/classes/MusicTastebuilderShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelf.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelf.ts#L10) +[src/parser/classes/MusicTastebuilderShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelf.ts#L10) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelfThumbnail.md b/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelfThumbnail.md index 726c5f27..f43f8e0f 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelfThumbnail.md +++ b/docs/api/namespaces/YTNodes/classes/MusicTastebuilderShelfThumbnail.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelfThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelfThumbnail.ts#L10) +[src/parser/classes/MusicTastebuilderShelfThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelfThumbnail.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelfThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelfThumbnail.ts#L8) +[src/parser/classes/MusicTastebuilderShelfThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelfThumbnail.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MusicTastebuilderShelfThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTastebuilderShelfThumbnail.ts#L6) +[src/parser/classes/MusicTastebuilderShelfThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTastebuilderShelfThumbnail.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicThumbnail.md b/docs/api/namespaces/YTNodes/classes/MusicThumbnail.md index 8c37233f..fe84210c 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicThumbnail.md +++ b/docs/api/namespaces/YTNodes/classes/MusicThumbnail.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicThumbnail.ts#L10) +[src/parser/classes/MusicThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicThumbnail.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicThumbnail.ts#L8) +[src/parser/classes/MusicThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicThumbnail.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/MusicThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicThumbnail.ts#L6) +[src/parser/classes/MusicThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicThumbnail.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md b/docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md index a0f2afbd..658d5325 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md +++ b/docs/api/namespaces/YTNodes/classes/MusicTwoRowItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L42) +[src/parser/classes/MusicTwoRowItem.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L42) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L26) +[src/parser/classes/MusicTwoRowItem.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L26) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L32) +[src/parser/classes/MusicTwoRowItem.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L32) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L19) +[src/parser/classes/MusicTwoRowItem.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L19) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L16) +[src/parser/classes/MusicTwoRowItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L16) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L17) +[src/parser/classes/MusicTwoRowItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L17) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L22) +[src/parser/classes/MusicTwoRowItem.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L22) *** @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L20) +[src/parser/classes/MusicTwoRowItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L20) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L40) +[src/parser/classes/MusicTwoRowItem.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L40) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L21) +[src/parser/classes/MusicTwoRowItem.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L21) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L18) +[src/parser/classes/MusicTwoRowItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L18) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L38) +[src/parser/classes/MusicTwoRowItem.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L38) *** @@ -158,7 +158,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L39) +[src/parser/classes/MusicTwoRowItem.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L39) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L15) +[src/parser/classes/MusicTwoRowItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L15) *** @@ -182,7 +182,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -192,7 +192,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L24) +[src/parser/classes/MusicTwoRowItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L24) *** @@ -202,7 +202,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L23) +[src/parser/classes/MusicTwoRowItem.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L23) *** @@ -216,7 +216,7 @@ #### Defined in -[src/parser/classes/MusicTwoRowItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicTwoRowItem.ts#L13) +[src/parser/classes/MusicTwoRowItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicTwoRowItem.ts#L13) ## Methods @@ -236,17 +236,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -280,7 +288,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -314,7 +322,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -352,4 +360,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md b/docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md index 2e3ff21f..0bec6d7e 100644 --- a/docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md +++ b/docs/api/namespaces/YTNodes/classes/MusicVisualHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/MusicVisualHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicVisualHeader.ts#L15) +[src/parser/classes/MusicVisualHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicVisualHeader.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/MusicVisualHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicVisualHeader.ts#L13) +[src/parser/classes/MusicVisualHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicVisualHeader.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/MusicVisualHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicVisualHeader.ts#L12) +[src/parser/classes/MusicVisualHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicVisualHeader.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/MusicVisualHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicVisualHeader.ts#L11) +[src/parser/classes/MusicVisualHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicVisualHeader.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/MusicVisualHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicVisualHeader.ts#L10) +[src/parser/classes/MusicVisualHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicVisualHeader.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/MusicVisualHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicVisualHeader.ts#L8) +[src/parser/classes/MusicVisualHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicVisualHeader.ts#L8) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md b/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md index 8cf70352..57c01259 100644 --- a/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md +++ b/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md @@ -26,43 +26,47 @@ #### Defined in -[src/parser/classes/NavigationEndpoint.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L27) +[src/parser/classes/NavigationEndpoint.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L31) ## 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:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L28) + +*** + +### commands? + +> `optional` **commands**: [`NavigationEndpoint`](NavigationEndpoint.md)[] + +#### Defined in + +[src/parser/classes/NavigationEndpoint.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L29) + +*** + ### dialog? > `optional` **dialog**: `null` \| [`YTNode`](../../Helpers/classes/YTNode.md) \| [`CreatePlaylistDialog`](CreatePlaylistDialog.md) #### Defined in -[src/parser/classes/NavigationEndpoint.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L14) +[src/parser/classes/NavigationEndpoint.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L23) *** ### metadata -> **metadata**: `object` - -#### api\_url? - -> `optional` **api\_url**: `string` - -#### page\_type? - -> `optional` **page\_type**: `string` - -#### send\_post? - -> `optional` **send\_post**: `boolean` - -#### url? - -> `optional` **url**: `string` +> **metadata**: `Metadata` #### Defined in -[src/parser/classes/NavigationEndpoint.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L20) +[src/parser/classes/NavigationEndpoint.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L27) *** @@ -72,7 +76,17 @@ #### Defined in -[src/parser/classes/NavigationEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L15) +[src/parser/classes/NavigationEndpoint.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L24) + +*** + +### name? + +> `optional` **name**: `string` + +#### Defined in + +[src/parser/classes/NavigationEndpoint.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L21) *** @@ -82,7 +96,7 @@ #### Defined in -[src/parser/classes/NavigationEndpoint.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L18) +[src/parser/classes/NavigationEndpoint.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L26) *** @@ -92,7 +106,7 @@ #### Defined in -[src/parser/classes/NavigationEndpoint.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L16) +[src/parser/classes/NavigationEndpoint.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L25) *** @@ -102,7 +116,7 @@ #### Defined in -[src/parser/classes/NavigationEndpoint.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L13) +[src/parser/classes/NavigationEndpoint.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L22) *** @@ -116,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +144,7 @@ #### Defined in -[src/parser/classes/NavigationEndpoint.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L11) +[src/parser/classes/NavigationEndpoint.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L19) ## Methods @@ -150,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +210,7 @@ Cast to one of the given types. ##### Defined in -[src/parser/classes/NavigationEndpoint.ts:106](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L106) +[src/parser/classes/NavigationEndpoint.ts:120](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L120) #### call(actions, args) @@ -208,13 +230,13 @@ Cast to one of the given types. ##### Defined in -[src/parser/classes/NavigationEndpoint.ts:107](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L107) +[src/parser/classes/NavigationEndpoint.ts:121](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L121) *** -### getEndpoint() +### ~~getPath()~~ -> **getEndpoint**(`name`): `undefined` \| `"/browse"` \| `"/player"` \| `"/search"` \| `"/next"` \| `"/live_chat/get_item_context_menu"` +> **getPath**(`name`): `undefined` \| `"/player"` \| `"/search"` \| `"/browse"` \| `"/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. @@ -224,11 +246,15 @@ Sometimes InnerTube does not return an API url, in that case the library should #### Returns -`undefined` \| `"/browse"` \| `"/player"` \| `"/search"` \| `"/next"` \| `"/live_chat/get_item_context_menu"` +`undefined` \| `"/player"` \| `"/search"` \| `"/browse"` \| `"/next"` \| `"/live_chat/get_item_context_menu"` + +#### Deprecated + +This should be removed in the future. #### Defined in -[src/parser/classes/NavigationEndpoint.ts:90](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L90) +[src/parser/classes/NavigationEndpoint.ts:104](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L104) *** @@ -262,7 +288,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -296,7 +322,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -334,7 +360,7 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) *** @@ -348,4 +374,4 @@ If the node does not have the key #### Defined in -[src/parser/classes/NavigationEndpoint.ts:116](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/NavigationEndpoint.ts#L116) +[src/parser/classes/NavigationEndpoint.ts:137](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NavigationEndpoint.ts#L137) diff --git a/docs/api/namespaces/YTNodes/classes/Notification.md b/docs/api/namespaces/YTNodes/classes/Notification.md index 5505922d..8c873924 100644 --- a/docs/api/namespaces/YTNodes/classes/Notification.md +++ b/docs/api/namespaces/YTNodes/classes/Notification.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Notification.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L20) +[src/parser/classes/Notification.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Notification.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L15) +[src/parser/classes/Notification.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Notification.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L17) +[src/parser/classes/Notification.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L17) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Notification.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L14) +[src/parser/classes/Notification.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Notification.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L18) +[src/parser/classes/Notification.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L18) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/Notification.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L16) +[src/parser/classes/Notification.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/Notification.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L13) +[src/parser/classes/Notification.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L13) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/Notification.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L12) +[src/parser/classes/Notification.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L12) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/Notification.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L10) +[src/parser/classes/Notification.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L10) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/Notification.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L11) +[src/parser/classes/Notification.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L11) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/Notification.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Notification.ts#L8) +[src/parser/classes/Notification.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Notification.ts#L8) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/NotificationAction.md b/docs/api/namespaces/YTNodes/classes/NotificationAction.md new file mode 100644 index 00000000..7e0701f1 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/NotificationAction.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / NotificationAction + +# Class: NotificationAction + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new NotificationAction() + +> **new NotificationAction**(`data`): [`NotificationAction`](NotificationAction.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`NotificationAction`](NotificationAction.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/NotificationAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NotificationAction.ts#L10) + +## Properties + +### response\_text + +> **response\_text**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/NotificationAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NotificationAction.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'NotificationAction'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/NotificationAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/NotificationAction.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is NotificationAction & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is NotificationAction & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/OpenPopupAction.md b/docs/api/namespaces/YTNodes/classes/OpenPopupAction.md index 68c1accf..b7d1146a 100644 --- a/docs/api/namespaces/YTNodes/classes/OpenPopupAction.md +++ b/docs/api/namespaces/YTNodes/classes/OpenPopupAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/actions/OpenPopupAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/OpenPopupAction.ts#L11) +[src/parser/classes/actions/OpenPopupAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/OpenPopupAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/actions/OpenPopupAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/OpenPopupAction.ts#L8) +[src/parser/classes/actions/OpenPopupAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/OpenPopupAction.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/actions/OpenPopupAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/OpenPopupAction.ts#L9) +[src/parser/classes/actions/OpenPopupAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/OpenPopupAction.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/actions/OpenPopupAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/OpenPopupAction.ts#L6) +[src/parser/classes/actions/OpenPopupAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/OpenPopupAction.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PageHeader.md b/docs/api/namespaces/YTNodes/classes/PageHeader.md index 6eb38b3e..3929d63e 100644 --- a/docs/api/namespaces/YTNodes/classes/PageHeader.md +++ b/docs/api/namespaces/YTNodes/classes/PageHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PageHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeader.ts#L11) +[src/parser/classes/PageHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeader.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PageHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeader.ts#L9) +[src/parser/classes/PageHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeader.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PageHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeader.ts#L8) +[src/parser/classes/PageHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeader.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/PageHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeader.ts#L6) +[src/parser/classes/PageHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeader.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PageHeaderView.md b/docs/api/namespaces/YTNodes/classes/PageHeaderView.md index 1479b8eb..aff1352c 100644 --- a/docs/api/namespaces/YTNodes/classes/PageHeaderView.md +++ b/docs/api/namespaces/YTNodes/classes/PageHeaderView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L23) +[src/parser/classes/PageHeaderView.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L18) +[src/parser/classes/PageHeaderView.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L18) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L20) +[src/parser/classes/PageHeaderView.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L20) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L21) +[src/parser/classes/PageHeaderView.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L21) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L19) +[src/parser/classes/PageHeaderView.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L19) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L16) +[src/parser/classes/PageHeaderView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L17) +[src/parser/classes/PageHeaderView.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L17) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L15) +[src/parser/classes/PageHeaderView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L15) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/PageHeaderView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageHeaderView.ts#L13) +[src/parser/classes/PageHeaderView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageHeaderView.ts#L13) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PageIntroduction.md b/docs/api/namespaces/YTNodes/classes/PageIntroduction.md index c86c6e91..c1c3a67e 100644 --- a/docs/api/namespaces/YTNodes/classes/PageIntroduction.md +++ b/docs/api/namespaces/YTNodes/classes/PageIntroduction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PageIntroduction.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageIntroduction.ts#L13) +[src/parser/classes/PageIntroduction.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageIntroduction.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PageIntroduction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageIntroduction.ts#L9) +[src/parser/classes/PageIntroduction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageIntroduction.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PageIntroduction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageIntroduction.ts#L11) +[src/parser/classes/PageIntroduction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageIntroduction.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PageIntroduction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageIntroduction.ts#L8) +[src/parser/classes/PageIntroduction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageIntroduction.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PageIntroduction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageIntroduction.ts#L10) +[src/parser/classes/PageIntroduction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageIntroduction.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/PageIntroduction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PageIntroduction.ts#L6) +[src/parser/classes/PageIntroduction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PageIntroduction.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PanelFooterView.md b/docs/api/namespaces/YTNodes/classes/PanelFooterView.md new file mode 100644 index 00000000..6f496178 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/PanelFooterView.md @@ -0,0 +1,231 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PdgCommentChip.md b/docs/api/namespaces/YTNodes/classes/PdgCommentChip.md index 52817da9..57eb8a40 100644 --- a/docs/api/namespaces/YTNodes/classes/PdgCommentChip.md +++ b/docs/api/namespaces/YTNodes/classes/PdgCommentChip.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/PdgCommentChip.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/PdgCommentChip.ts#L15) +[src/parser/classes/comments/PdgCommentChip.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/PdgCommentChip.ts#L15) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/comments/PdgCommentChip.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/PdgCommentChip.ts#L9) +[src/parser/classes/comments/PdgCommentChip.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/PdgCommentChip.ts#L9) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/comments/PdgCommentChip.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/PdgCommentChip.ts#L13) +[src/parser/classes/comments/PdgCommentChip.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/PdgCommentChip.ts#L13) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/comments/PdgCommentChip.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/PdgCommentChip.ts#L8) +[src/parser/classes/comments/PdgCommentChip.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/PdgCommentChip.ts#L8) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/comments/PdgCommentChip.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/PdgCommentChip.ts#L6) +[src/parser/classes/comments/PdgCommentChip.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/PdgCommentChip.ts#L6) ## Methods @@ -112,17 +112,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -156,7 +164,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -190,7 +198,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -228,4 +236,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PerformCommentActionEndpoint.md b/docs/api/namespaces/YTNodes/classes/PerformCommentActionEndpoint.md new file mode 100644 index 00000000..c38327d2 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/PerformCommentActionEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PerformCommentActionEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PerformCommentActionEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PerformCommentActionEndpoint.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/PerformCommentActionEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PerformCommentActionEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PivotButton.md b/docs/api/namespaces/YTNodes/classes/PivotButton.md index 06d1b543..da2a7bb5 100644 --- a/docs/api/namespaces/YTNodes/classes/PivotButton.md +++ b/docs/api/namespaces/YTNodes/classes/PivotButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L18) +[src/parser/classes/PivotButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L16) +[src/parser/classes/PivotButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L16) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L12) +[src/parser/classes/PivotButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L11) +[src/parser/classes/PivotButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L14) +[src/parser/classes/PivotButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L13) +[src/parser/classes/PivotButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L10) +[src/parser/classes/PivotButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L10) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L15) +[src/parser/classes/PivotButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L15) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/PivotButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PivotButton.ts#L8) +[src/parser/classes/PivotButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PivotButton.ts#L8) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerAnnotationsExpanded.md b/docs/api/namespaces/YTNodes/classes/PlayerAnnotationsExpanded.md index 60d46a83..7c14eb76 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerAnnotationsExpanded.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerAnnotationsExpanded.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerAnnotationsExpanded.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerAnnotationsExpanded.ts#L21) +[src/parser/classes/PlayerAnnotationsExpanded.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerAnnotationsExpanded.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerAnnotationsExpanded.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerAnnotationsExpanded.ts#L18) +[src/parser/classes/PlayerAnnotationsExpanded.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerAnnotationsExpanded.ts#L18) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerAnnotationsExpanded.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerAnnotationsExpanded.ts#L19) +[src/parser/classes/PlayerAnnotationsExpanded.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerAnnotationsExpanded.ts#L19) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/PlayerAnnotationsExpanded.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerAnnotationsExpanded.ts#L9) +[src/parser/classes/PlayerAnnotationsExpanded.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerAnnotationsExpanded.ts#L9) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/PlayerAnnotationsExpanded.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerAnnotationsExpanded.ts#L7) +[src/parser/classes/PlayerAnnotationsExpanded.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerAnnotationsExpanded.ts#L7) ## Methods @@ -128,17 +128,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -172,7 +180,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -206,7 +214,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -244,4 +252,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md b/docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md index 8e9f4454..528029fe 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerCaptionsTracklist.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerCaptionsTracklist.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerCaptionsTracklist.ts#L35) +[src/parser/classes/PlayerCaptionsTracklist.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerCaptionsTracklist.ts#L35) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerCaptionsTracklist.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerCaptionsTracklist.ts#L19) +[src/parser/classes/PlayerCaptionsTracklist.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerCaptionsTracklist.ts#L19) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerCaptionsTracklist.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerCaptionsTracklist.ts#L17) +[src/parser/classes/PlayerCaptionsTracklist.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerCaptionsTracklist.ts#L17) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlayerCaptionsTracklist.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerCaptionsTracklist.ts#L28) +[src/parser/classes/PlayerCaptionsTracklist.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerCaptionsTracklist.ts#L28) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlayerCaptionsTracklist.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerCaptionsTracklist.ts#L30) +[src/parser/classes/PlayerCaptionsTracklist.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerCaptionsTracklist.ts#L30) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/PlayerCaptionsTracklist.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerCaptionsTracklist.ts#L15) +[src/parser/classes/PlayerCaptionsTracklist.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerCaptionsTracklist.ts#L15) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md b/docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md index 179866f1..41879250 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerControlsOverlay.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerControlsOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerControlsOverlay.ts#L10) +[src/parser/classes/PlayerControlsOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerControlsOverlay.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerControlsOverlay.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerControlsOverlay.ts#L8) +[src/parser/classes/PlayerControlsOverlay.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerControlsOverlay.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PlayerControlsOverlay.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerControlsOverlay.ts#L6) +[src/parser/classes/PlayerControlsOverlay.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerControlsOverlay.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md b/docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md index 96c81adc..7113de08 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerErrorMessage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerErrorMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerErrorMessage.ts#L16) +[src/parser/classes/PlayerErrorMessage.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerErrorMessage.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerErrorMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerErrorMessage.ts#L14) +[src/parser/classes/PlayerErrorMessage.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerErrorMessage.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerErrorMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerErrorMessage.ts#L12) +[src/parser/classes/PlayerErrorMessage.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerErrorMessage.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlayerErrorMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerErrorMessage.ts#L11) +[src/parser/classes/PlayerErrorMessage.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerErrorMessage.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlayerErrorMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerErrorMessage.ts#L10) +[src/parser/classes/PlayerErrorMessage.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerErrorMessage.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PlayerErrorMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerErrorMessage.ts#L13) +[src/parser/classes/PlayerErrorMessage.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerErrorMessage.ts#L13) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/PlayerErrorMessage.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerErrorMessage.ts#L8) +[src/parser/classes/PlayerErrorMessage.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerErrorMessage.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md b/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md index 2293cf59..20330a70 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcOffer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L12) +[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L9) +[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L10) +[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L8) +[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L7) +[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L7) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L5) +[src/parser/classes/PlayerLegacyDesktopYpcOffer.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcOffer.ts#L5) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md b/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md index 316f3613..be1eb80e 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerLegacyDesktopYpcTrailer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L18) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L14) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L12) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L11) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L13) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L10) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L10) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L9) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L9) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L16) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L16) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L8) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L15) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L15) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L6) +[src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLegacyDesktopYpcTrailer.ts#L6) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerLiveStoryboardSpec.md b/docs/api/namespaces/YTNodes/classes/PlayerLiveStoryboardSpec.md index a05ffd5e..ee10ac9b 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerLiveStoryboardSpec.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerLiveStoryboardSpec.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerLiveStoryboardSpec.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLiveStoryboardSpec.ts#L18) +[src/parser/classes/PlayerLiveStoryboardSpec.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLiveStoryboardSpec.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerLiveStoryboardSpec.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLiveStoryboardSpec.ts#L16) +[src/parser/classes/PlayerLiveStoryboardSpec.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLiveStoryboardSpec.ts#L16) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PlayerLiveStoryboardSpec.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerLiveStoryboardSpec.ts#L14) +[src/parser/classes/PlayerLiveStoryboardSpec.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerLiveStoryboardSpec.ts#L14) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md b/docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md index 86c878d7..948c1477 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerMicroformat.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L41) +[src/parser/classes/PlayerMicroformat.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L41) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L37) +[src/parser/classes/PlayerMicroformat.ts:37](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L37) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L34) +[src/parser/classes/PlayerMicroformat.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L34) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L24) +[src/parser/classes/PlayerMicroformat.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L24) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L10) +[src/parser/classes/PlayerMicroformat.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L10) *** @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L13) +[src/parser/classes/PlayerMicroformat.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L13) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L39) +[src/parser/classes/PlayerMicroformat.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L39) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L32) +[src/parser/classes/PlayerMicroformat.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L32) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L30) +[src/parser/classes/PlayerMicroformat.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L30) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L31) +[src/parser/classes/PlayerMicroformat.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L31) *** @@ -158,7 +158,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L22) +[src/parser/classes/PlayerMicroformat.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L22) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L35) +[src/parser/classes/PlayerMicroformat.ts:35](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L35) *** @@ -178,7 +178,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L38) +[src/parser/classes/PlayerMicroformat.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L38) *** @@ -188,7 +188,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L11) +[src/parser/classes/PlayerMicroformat.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L11) *** @@ -198,7 +198,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L9) +[src/parser/classes/PlayerMicroformat.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L9) *** @@ -212,7 +212,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -222,7 +222,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L36) +[src/parser/classes/PlayerMicroformat.ts:36](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L36) *** @@ -232,7 +232,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L33) +[src/parser/classes/PlayerMicroformat.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L33) *** @@ -246,7 +246,7 @@ #### Defined in -[src/parser/classes/PlayerMicroformat.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerMicroformat.ts#L7) +[src/parser/classes/PlayerMicroformat.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerMicroformat.ts#L7) ## Methods @@ -266,17 +266,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -310,7 +318,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -344,7 +352,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -382,4 +390,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerOverflow.md b/docs/api/namespaces/YTNodes/classes/PlayerOverflow.md index 71e91847..e69ccb58 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerOverflow.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerOverflow.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerOverflow.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverflow.ts#L11) +[src/parser/classes/PlayerOverflow.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverflow.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerOverflow.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverflow.ts#L9) +[src/parser/classes/PlayerOverflow.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverflow.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerOverflow.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverflow.ts#L8) +[src/parser/classes/PlayerOverflow.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverflow.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/PlayerOverflow.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverflow.ts#L6) +[src/parser/classes/PlayerOverflow.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverflow.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerOverlay.md b/docs/api/namespaces/YTNodes/classes/PlayerOverlay.md index e1ab90a8..389f2ebd 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerOverlay.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerOverlay.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L21) +[src/parser/classes/PlayerOverlay.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L17) +[src/parser/classes/PlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L18) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L15) +[src/parser/classes/PlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L13) +[src/parser/classes/PlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L18) +[src/parser/classes/PlayerOverlay.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L19) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L19) +[src/parser/classes/PlayerOverlay.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L20) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L12) +[src/parser/classes/PlayerOverlay.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L13) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L16) +[src/parser/classes/PlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L14) +[src/parser/classes/PlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L15) *** @@ -120,7 +120,17 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L21) *** @@ -134,7 +144,7 @@ #### Defined in -[src/parser/classes/PlayerOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlay.ts#L10) +[src/parser/classes/PlayerOverlay.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlay.ts#L11) ## Methods @@ -154,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -198,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -232,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -270,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md b/docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md index 531da1e1..387d972e 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L28) +[src/parser/classes/PlayerOverlayAutoplay.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L28) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L23) +[src/parser/classes/PlayerOverlayAutoplay.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L23) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L21) +[src/parser/classes/PlayerOverlayAutoplay.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L21) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L24) +[src/parser/classes/PlayerOverlayAutoplay.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L24) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L26) +[src/parser/classes/PlayerOverlayAutoplay.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L26) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L18) +[src/parser/classes/PlayerOverlayAutoplay.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L18) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L25) +[src/parser/classes/PlayerOverlayAutoplay.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L25) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L17) +[src/parser/classes/PlayerOverlayAutoplay.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L20) +[src/parser/classes/PlayerOverlayAutoplay.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L20) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L14) +[src/parser/classes/PlayerOverlayAutoplay.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L14) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L22) +[src/parser/classes/PlayerOverlayAutoplay.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L22) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L11) +[src/parser/classes/PlayerOverlayAutoplay.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L11) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L12) +[src/parser/classes/PlayerOverlayAutoplay.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L12) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L13) +[src/parser/classes/PlayerOverlayAutoplay.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L13) *** @@ -184,7 +184,7 @@ #### Defined in -[src/parser/classes/PlayerOverlayAutoplay.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerOverlayAutoplay.ts#L9) +[src/parser/classes/PlayerOverlayAutoplay.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerOverlayAutoplay.ts#L9) ## Methods @@ -204,17 +204,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -248,7 +256,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -282,7 +290,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -320,4 +328,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerOverlayVideoDetails.md b/docs/api/namespaces/YTNodes/classes/PlayerOverlayVideoDetails.md new file mode 100644 index 00000000..99d49c01 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/PlayerOverlayVideoDetails.md @@ -0,0 +1,221 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlayerStoryboardSpec.md b/docs/api/namespaces/YTNodes/classes/PlayerStoryboardSpec.md index 03816da5..91be1104 100644 --- a/docs/api/namespaces/YTNodes/classes/PlayerStoryboardSpec.md +++ b/docs/api/namespaces/YTNodes/classes/PlayerStoryboardSpec.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlayerStoryboardSpec.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerStoryboardSpec.ts#L21) +[src/parser/classes/PlayerStoryboardSpec.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerStoryboardSpec.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlayerStoryboardSpec.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerStoryboardSpec.ts#L19) +[src/parser/classes/PlayerStoryboardSpec.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerStoryboardSpec.ts#L19) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PlayerStoryboardSpec.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlayerStoryboardSpec.ts#L17) +[src/parser/classes/PlayerStoryboardSpec.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlayerStoryboardSpec.ts#L17) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Playlist.md b/docs/api/namespaces/YTNodes/classes/Playlist.md index c96b241f..9c7b5493 100644 --- a/docs/api/namespaces/YTNodes/classes/Playlist.md +++ b/docs/api/namespaces/YTNodes/classes/Playlist.md @@ -32,7 +32,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L28) +[src/parser/classes/Playlist.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L28) ## Properties @@ -42,7 +42,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L15) +[src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L15) *** @@ -52,7 +52,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L23) +[src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L23) *** @@ -62,7 +62,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L24) +[src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L24) *** @@ -72,7 +72,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L20) +[src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L20) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L13) +[src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L13) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L22) +[src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L22) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L21) +[src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L21) *** @@ -112,7 +112,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L25) +[src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L25) *** @@ -122,7 +122,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L17) +[src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L17) *** @@ -132,7 +132,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L16) +[src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L16) *** @@ -142,7 +142,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L14) +[src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L14) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L18) +[src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L18) *** @@ -176,7 +176,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L19) +[src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L19) *** @@ -186,7 +186,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L26) +[src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L26) *** @@ -200,7 +200,7 @@ #### Defined in -[src/parser/classes/Playlist.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Playlist.ts#L11) +[src/parser/classes/Playlist.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Playlist.ts#L11) ## Methods @@ -220,17 +220,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -264,7 +272,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -298,7 +306,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -336,4 +344,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistAddToOption.md b/docs/api/namespaces/YTNodes/classes/PlaylistAddToOption.md new file mode 100644 index 00000000..4a01ab4f --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/PlaylistAddToOption.md @@ -0,0 +1,271 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistAddToOption.ts#L15) + +*** + +### privacy + +> **privacy**: `string` + +#### Defined in + +[src/parser/classes/PlaylistAddToOption.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistCustomThumbnail.md b/docs/api/namespaces/YTNodes/classes/PlaylistCustomThumbnail.md index 965f4734..9dd49018 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistCustomThumbnail.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistCustomThumbnail.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistCustomThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistCustomThumbnail.ts#L10) +[src/parser/classes/PlaylistCustomThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistCustomThumbnail.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistCustomThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistCustomThumbnail.ts#L8) +[src/parser/classes/PlaylistCustomThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistCustomThumbnail.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PlaylistCustomThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistCustomThumbnail.ts#L6) +[src/parser/classes/PlaylistCustomThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistCustomThumbnail.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistEditEndpoint.md b/docs/api/namespaces/YTNodes/classes/PlaylistEditEndpoint.md new file mode 100644 index 00000000..502dbee9 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/PlaylistEditEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PlaylistEditEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PlaylistEditEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PlaylistEditEndpoint.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/PlaylistEditEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/PlaylistEditEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistHeader.md b/docs/api/namespaces/YTNodes/classes/PlaylistHeader.md index d1f6f1cd..06a53ea0 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistHeader.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L27) +[src/parser/classes/PlaylistHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L27) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L14) +[src/parser/classes/PlaylistHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L25) +[src/parser/classes/PlaylistHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L25) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L13) +[src/parser/classes/PlaylistHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L19) +[src/parser/classes/PlaylistHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L19) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L18) +[src/parser/classes/PlaylistHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L18) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L15) +[src/parser/classes/PlaylistHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L15) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L9) +[src/parser/classes/PlaylistHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L9) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L20) +[src/parser/classes/PlaylistHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L20) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L24) +[src/parser/classes/PlaylistHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L24) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L16) +[src/parser/classes/PlaylistHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L16) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L21) +[src/parser/classes/PlaylistHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L21) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L22) +[src/parser/classes/PlaylistHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L22) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L23) +[src/parser/classes/PlaylistHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L23) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L12) +[src/parser/classes/PlaylistHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L12) *** @@ -176,7 +176,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L11) +[src/parser/classes/PlaylistHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L11) *** @@ -186,7 +186,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L10) +[src/parser/classes/PlaylistHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L10) *** @@ -200,7 +200,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -210,7 +210,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L17) +[src/parser/classes/PlaylistHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L17) *** @@ -224,7 +224,7 @@ #### Defined in -[src/parser/classes/PlaylistHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistHeader.ts#L7) +[src/parser/classes/PlaylistHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistHeader.ts#L7) ## Methods @@ -244,17 +244,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -288,7 +296,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -322,7 +330,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -360,4 +368,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md b/docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md index 8d2c737e..7c103924 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistInfoCardContent.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistInfoCardContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistInfoCardContent.ts#L16) +[src/parser/classes/PlaylistInfoCardContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistInfoCardContent.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistInfoCardContent.ts#L13) +[src/parser/classes/PlaylistInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistInfoCardContent.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistInfoCardContent.ts#L14) +[src/parser/classes/PlaylistInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistInfoCardContent.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlaylistInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistInfoCardContent.ts#L11) +[src/parser/classes/PlaylistInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistInfoCardContent.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlaylistInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistInfoCardContent.ts#L10) +[src/parser/classes/PlaylistInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistInfoCardContent.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/PlaylistInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistInfoCardContent.ts#L12) +[src/parser/classes/PlaylistInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistInfoCardContent.ts#L12) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/PlaylistInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistInfoCardContent.ts#L8) +[src/parser/classes/PlaylistInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistInfoCardContent.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md b/docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md index 7e26a0ee..9c76754e 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistMetadata.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistMetadata.ts#L10) +[src/parser/classes/PlaylistMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistMetadata.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistMetadata.ts#L8) +[src/parser/classes/PlaylistMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistMetadata.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistMetadata.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistMetadata.ts#L7) +[src/parser/classes/PlaylistMetadata.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistMetadata.ts#L7) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/PlaylistMetadata.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistMetadata.ts#L5) +[src/parser/classes/PlaylistMetadata.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistMetadata.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistPanel.md b/docs/api/namespaces/YTNodes/classes/PlaylistPanel.md index 8953cfdd..d7f7581b 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistPanel.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistPanel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L21) +[src/parser/classes/PlaylistPanel.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L13) +[src/parser/classes/PlaylistPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L16) +[src/parser/classes/PlaylistPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L16) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L17) +[src/parser/classes/PlaylistPanel.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L17) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L15) +[src/parser/classes/PlaylistPanel.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L15) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L19) +[src/parser/classes/PlaylistPanel.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L19) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L14) +[src/parser/classes/PlaylistPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L14) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L18) +[src/parser/classes/PlaylistPanel.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L18) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L11) +[src/parser/classes/PlaylistPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L11) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L12) +[src/parser/classes/PlaylistPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L12) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/PlaylistPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanel.ts#L9) +[src/parser/classes/PlaylistPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanel.ts#L9) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md b/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md index 2a2cc581..4fa1e9e3 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L42) +[src/parser/classes/PlaylistPanelVideo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L42) ## Properties @@ -52,7 +52,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L25) +[src/parser/classes/PlaylistPanelVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L25) *** @@ -62,7 +62,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L32) +[src/parser/classes/PlaylistPanelVideo.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L32) *** @@ -72,7 +72,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L23) +[src/parser/classes/PlaylistPanelVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L23) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L38) +[src/parser/classes/PlaylistPanelVideo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L38) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L18) +[src/parser/classes/PlaylistPanelVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L18) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L14) +[src/parser/classes/PlaylistPanelVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L14) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L39) +[src/parser/classes/PlaylistPanelVideo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L39) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L15) +[src/parser/classes/PlaylistPanelVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L15) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L40) +[src/parser/classes/PlaylistPanelVideo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L40) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L13) +[src/parser/classes/PlaylistPanelVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L13) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L12) +[src/parser/classes/PlaylistPanelVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L12) *** @@ -174,7 +174,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -184,7 +184,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L16) +[src/parser/classes/PlaylistPanelVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L16) *** @@ -198,7 +198,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideo.ts#L10) +[src/parser/classes/PlaylistPanelVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideo.ts#L10) ## Methods @@ -218,17 +218,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -262,7 +270,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -296,7 +304,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -334,4 +342,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md b/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md index b3e91821..a46fe347 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistPanelVideoWrapper.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideoWrapper.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideoWrapper.ts#L11) +[src/parser/classes/PlaylistPanelVideoWrapper.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideoWrapper.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideoWrapper.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideoWrapper.ts#L9) +[src/parser/classes/PlaylistPanelVideoWrapper.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideoWrapper.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideoWrapper.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideoWrapper.ts#L8) +[src/parser/classes/PlaylistPanelVideoWrapper.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideoWrapper.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/PlaylistPanelVideoWrapper.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistPanelVideoWrapper.ts#L6) +[src/parser/classes/PlaylistPanelVideoWrapper.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistPanelVideoWrapper.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md b/docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md index 5981de56..a4a5695f 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistSidebar.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebar.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebar.ts#L9) +[src/parser/classes/PlaylistSidebar.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebar.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebar.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebar.ts#L7) +[src/parser/classes/PlaylistSidebar.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebar.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebar.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebar.ts#L5) +[src/parser/classes/PlaylistSidebar.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebar.ts#L5) ## Accessors @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebar.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebar.ts#L15) +[src/parser/classes/PlaylistSidebar.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebar.ts#L15) ## Methods @@ -98,17 +98,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -142,7 +150,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -176,7 +184,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -214,4 +222,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md b/docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md index 3be27043..38b15ab0 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistSidebarPrimaryInfo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L16) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L14) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L13) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L12) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L9) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L9) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L10) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L10) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L11) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L11) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L7) +[src/parser/classes/PlaylistSidebarPrimaryInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarPrimaryInfo.ts#L7) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md b/docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md index 886d169c..0e7f214f 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistSidebarSecondaryInfo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L10) +[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L8) +[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L7) +[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L7) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L5) +[src/parser/classes/PlaylistSidebarSecondaryInfo.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistSidebarSecondaryInfo.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistVideo.md b/docs/api/namespaces/YTNodes/classes/PlaylistVideo.md index 07b0fb4c..a8a45c03 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistVideo.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L33) +[src/parser/classes/PlaylistVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L33) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L25) +[src/parser/classes/PlaylistVideo.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L25) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L16) +[src/parser/classes/PlaylistVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L16) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L28) +[src/parser/classes/PlaylistVideo.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L28) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L20) +[src/parser/classes/PlaylistVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L20) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L13) +[src/parser/classes/PlaylistVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L13) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L14) +[src/parser/classes/PlaylistVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L14) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L21) +[src/parser/classes/PlaylistVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L21) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L22) +[src/parser/classes/PlaylistVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L22) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L19) +[src/parser/classes/PlaylistVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L19) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L26) +[src/parser/classes/PlaylistVideo.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L26) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L18) +[src/parser/classes/PlaylistVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L18) *** @@ -154,7 +154,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L17) +[src/parser/classes/PlaylistVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L17) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L15) +[src/parser/classes/PlaylistVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L15) *** @@ -178,7 +178,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -188,7 +188,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L23) +[src/parser/classes/PlaylistVideo.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L23) *** @@ -198,7 +198,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L24) +[src/parser/classes/PlaylistVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L24) *** @@ -212,7 +212,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L11) +[src/parser/classes/PlaylistVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L11) ## Accessors @@ -226,7 +226,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L63) +[src/parser/classes/PlaylistVideo.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L63) *** @@ -240,7 +240,7 @@ #### Defined in -[src/parser/classes/PlaylistVideo.ts:67](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideo.ts#L67) +[src/parser/classes/PlaylistVideo.ts:67](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideo.ts#L67) ## Methods @@ -260,17 +260,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -304,7 +312,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -338,7 +346,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -376,4 +384,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md b/docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md index 36fc1196..7c240571 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistVideoList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoList.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoList.ts#L12) +[src/parser/classes/PlaylistVideoList.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoList.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoList.ts#L9) +[src/parser/classes/PlaylistVideoList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoList.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoList.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoList.ts#L7) +[src/parser/classes/PlaylistVideoList.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoList.ts#L7) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoList.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoList.ts#L8) +[src/parser/classes/PlaylistVideoList.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoList.ts#L8) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoList.ts#L10) +[src/parser/classes/PlaylistVideoList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoList.ts#L10) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoList.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoList.ts#L5) +[src/parser/classes/PlaylistVideoList.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoList.ts#L5) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PlaylistVideoThumbnail.md b/docs/api/namespaces/YTNodes/classes/PlaylistVideoThumbnail.md index 8b65ca24..95a4a561 100644 --- a/docs/api/namespaces/YTNodes/classes/PlaylistVideoThumbnail.md +++ b/docs/api/namespaces/YTNodes/classes/PlaylistVideoThumbnail.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoThumbnail.ts#L10) +[src/parser/classes/PlaylistVideoThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoThumbnail.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoThumbnail.ts#L8) +[src/parser/classes/PlaylistVideoThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoThumbnail.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PlaylistVideoThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PlaylistVideoThumbnail.ts#L6) +[src/parser/classes/PlaylistVideoThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PlaylistVideoThumbnail.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Poll.md b/docs/api/namespaces/YTNodes/classes/Poll.md index 96718ed3..30301525 100644 --- a/docs/api/namespaces/YTNodes/classes/Poll.md +++ b/docs/api/namespaces/YTNodes/classes/Poll.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Poll.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Poll.ts#L25) +[src/parser/classes/Poll.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Poll.ts#L25) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Poll.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Poll.ts#L10) +[src/parser/classes/Poll.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Poll.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Poll.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Poll.ts#L23) +[src/parser/classes/Poll.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Poll.ts#L23) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Poll.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Poll.ts#L21) +[src/parser/classes/Poll.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Poll.ts#L21) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Poll.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Poll.ts#L22) +[src/parser/classes/Poll.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Poll.ts#L22) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/Poll.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Poll.ts#L8) +[src/parser/classes/Poll.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Poll.ts#L8) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PollHeader.md b/docs/api/namespaces/YTNodes/classes/PollHeader.md index faecc63a..d1c73b77 100644 --- a/docs/api/namespaces/YTNodes/classes/PollHeader.md +++ b/docs/api/namespaces/YTNodes/classes/PollHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/items/PollHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/PollHeader.ts#L17) +[src/parser/classes/livechat/items/PollHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/PollHeader.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/items/PollHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/PollHeader.ts#L15) +[src/parser/classes/livechat/items/PollHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/PollHeader.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/items/PollHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/PollHeader.ts#L14) +[src/parser/classes/livechat/items/PollHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/PollHeader.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/items/PollHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/PollHeader.ts#L13) +[src/parser/classes/livechat/items/PollHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/PollHeader.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/livechat/items/PollHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/PollHeader.ts#L11) +[src/parser/classes/livechat/items/PollHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/PollHeader.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/livechat/items/PollHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/PollHeader.ts#L12) +[src/parser/classes/livechat/items/PollHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/PollHeader.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/livechat/items/PollHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/items/PollHeader.ts#L9) +[src/parser/classes/livechat/items/PollHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/items/PollHeader.ts#L9) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Post.md b/docs/api/namespaces/YTNodes/classes/Post.md index 142d1b71..cb0668cb 100644 --- a/docs/api/namespaces/YTNodes/classes/Post.md +++ b/docs/api/namespaces/YTNodes/classes/Post.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Post.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Post.ts#L7) +[src/parser/classes/Post.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Post.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L21) +[src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L21) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L25) +[src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L25) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L14) +[src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L14) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L15) +[src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L15) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L24) +[src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L24) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L13) +[src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L13) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L20) +[src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L20) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L17) +[src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L17) *** @@ -152,7 +152,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L16) +[src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L16) *** @@ -166,7 +166,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L23) +[src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L23) *** @@ -180,7 +180,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -194,7 +194,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L22) +[src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L22) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L19) +[src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L19) *** @@ -222,7 +222,7 @@ #### Defined in -[src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/BackstagePost.ts#L18) +[src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/BackstagePost.ts#L18) *** @@ -236,7 +236,7 @@ #### Defined in -[src/parser/classes/Post.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Post.ts#L5) +[src/parser/classes/Post.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Post.ts#L5) ## Methods @@ -256,17 +256,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -300,7 +308,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -334,7 +342,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -372,4 +380,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PostMultiImage.md b/docs/api/namespaces/YTNodes/classes/PostMultiImage.md index 27c2147f..ee1410e5 100644 --- a/docs/api/namespaces/YTNodes/classes/PostMultiImage.md +++ b/docs/api/namespaces/YTNodes/classes/PostMultiImage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/PostMultiImage.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PostMultiImage.ts#L10) +[src/parser/classes/PostMultiImage.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PostMultiImage.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/PostMultiImage.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PostMultiImage.ts#L8) +[src/parser/classes/PostMultiImage.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PostMultiImage.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/PostMultiImage.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/PostMultiImage.ts#L6) +[src/parser/classes/PostMultiImage.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PostMultiImage.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PrefetchWatchCommand.md b/docs/api/namespaces/YTNodes/classes/PrefetchWatchCommand.md new file mode 100644 index 00000000..5c39cf99 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/PrefetchWatchCommand.md @@ -0,0 +1,237 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchEndpoint.ts#L19) + +*** + +### getApiPath() + +> **getApiPath**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`WatchEndpoint`](WatchEndpoint.md).[`getApiPath`](WatchEndpoint.md#getapipath) + +#### Defined in + +[src/parser/classes/endpoints/WatchEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/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:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../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:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/PremiereTrailerBadge.md b/docs/api/namespaces/YTNodes/classes/PremiereTrailerBadge.md new file mode 100644 index 00000000..ebaf3d06 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/PremiereTrailerBadge.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PremiereTrailerBadge + +# Class: PremiereTrailerBadge + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new PremiereTrailerBadge() + +> **new PremiereTrailerBadge**(`data`): [`PremiereTrailerBadge`](PremiereTrailerBadge.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`PremiereTrailerBadge`](PremiereTrailerBadge.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/PremiereTrailerBadge.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PremiereTrailerBadge.ts#L10) + +## Properties + +### label + +> **label**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/PremiereTrailerBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PremiereTrailerBadge.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'PremiereTrailerBadge'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/PremiereTrailerBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/PremiereTrailerBadge.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is PremiereTrailerBadge & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is PremiereTrailerBadge & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ProductList.md b/docs/api/namespaces/YTNodes/classes/ProductList.md index d2d721dd..643b450b 100644 --- a/docs/api/namespaces/YTNodes/classes/ProductList.md +++ b/docs/api/namespaces/YTNodes/classes/ProductList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ProductList.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductList.ts#L11) +[src/parser/classes/ProductList.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductList.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ProductList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductList.ts#L9) +[src/parser/classes/ProductList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductList.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ProductList.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductList.ts#L7) +[src/parser/classes/ProductList.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductList.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ProductListHeader.md b/docs/api/namespaces/YTNodes/classes/ProductListHeader.md index 105e1c3d..74b7183e 100644 --- a/docs/api/namespaces/YTNodes/classes/ProductListHeader.md +++ b/docs/api/namespaces/YTNodes/classes/ProductListHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ProductListHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListHeader.ts#L11) +[src/parser/classes/ProductListHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListHeader.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ProductListHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListHeader.ts#L9) +[src/parser/classes/ProductListHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListHeader.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ProductListHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListHeader.ts#L8) +[src/parser/classes/ProductListHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListHeader.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ProductListHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListHeader.ts#L6) +[src/parser/classes/ProductListHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListHeader.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ProductListItem.md b/docs/api/namespaces/YTNodes/classes/ProductListItem.md index 0c528ed7..2e190436 100644 --- a/docs/api/namespaces/YTNodes/classes/ProductListItem.md +++ b/docs/api/namespaces/YTNodes/classes/ProductListItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L20) +[src/parser/classes/ProductListItem.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L12) +[src/parser/classes/ProductListItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L15) +[src/parser/classes/ProductListItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L16) +[src/parser/classes/ProductListItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L16) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L14) +[src/parser/classes/ProductListItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L17) +[src/parser/classes/ProductListItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L17) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L13) +[src/parser/classes/ProductListItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L13) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L11) +[src/parser/classes/ProductListItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L11) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L18) +[src/parser/classes/ProductListItem.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L18) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/ProductListItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProductListItem.ts#L9) +[src/parser/classes/ProductListItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProductListItem.ts#L9) ## Methods @@ -154,17 +154,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -198,7 +206,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -232,7 +240,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -270,4 +278,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ProfileColumn.md b/docs/api/namespaces/YTNodes/classes/ProfileColumn.md index ac4d4a6a..e65446b1 100644 --- a/docs/api/namespaces/YTNodes/classes/ProfileColumn.md +++ b/docs/api/namespaces/YTNodes/classes/ProfileColumn.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ProfileColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumn.ts#L9) +[src/parser/classes/ProfileColumn.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumn.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ProfileColumn.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumn.ts#L7) +[src/parser/classes/ProfileColumn.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumn.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ProfileColumn.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumn.ts#L5) +[src/parser/classes/ProfileColumn.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumn.ts#L5) ## Accessors @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/ProfileColumn.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumn.ts#L15) +[src/parser/classes/ProfileColumn.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumn.ts#L15) ## Methods @@ -98,17 +98,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -142,7 +150,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -176,7 +184,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -214,4 +222,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md b/docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md index a1909872..cc355c9a 100644 --- a/docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md +++ b/docs/api/namespaces/YTNodes/classes/ProfileColumnStats.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStats.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStats.ts#L9) +[src/parser/classes/ProfileColumnStats.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStats.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStats.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStats.ts#L7) +[src/parser/classes/ProfileColumnStats.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStats.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStats.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStats.ts#L5) +[src/parser/classes/ProfileColumnStats.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStats.ts#L5) ## Accessors @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStats.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStats.ts#L15) +[src/parser/classes/ProfileColumnStats.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStats.ts#L15) ## Methods @@ -98,17 +98,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -142,7 +150,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -176,7 +184,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -214,4 +222,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md b/docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md index cd63dfb3..e57d951a 100644 --- a/docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md +++ b/docs/api/namespaces/YTNodes/classes/ProfileColumnStatsEntry.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStatsEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStatsEntry.ts#L11) +[src/parser/classes/ProfileColumnStatsEntry.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStatsEntry.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStatsEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStatsEntry.ts#L8) +[src/parser/classes/ProfileColumnStatsEntry.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStatsEntry.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStatsEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStatsEntry.ts#L9) +[src/parser/classes/ProfileColumnStatsEntry.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStatsEntry.ts#L9) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ProfileColumnStatsEntry.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnStatsEntry.ts#L6) +[src/parser/classes/ProfileColumnStatsEntry.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnStatsEntry.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md b/docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md index ee9e769f..63ff5980 100644 --- a/docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md +++ b/docs/api/namespaces/YTNodes/classes/ProfileColumnUserInfo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ProfileColumnUserInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnUserInfo.ts#L12) +[src/parser/classes/ProfileColumnUserInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnUserInfo.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ProfileColumnUserInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnUserInfo.ts#L10) +[src/parser/classes/ProfileColumnUserInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnUserInfo.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ProfileColumnUserInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnUserInfo.ts#L9) +[src/parser/classes/ProfileColumnUserInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnUserInfo.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ProfileColumnUserInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ProfileColumnUserInfo.ts#L7) +[src/parser/classes/ProfileColumnUserInfo.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ProfileColumnUserInfo.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Quiz.md b/docs/api/namespaces/YTNodes/classes/Quiz.md index 4d4bd9e6..b26666e5 100644 --- a/docs/api/namespaces/YTNodes/classes/Quiz.md +++ b/docs/api/namespaces/YTNodes/classes/Quiz.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Quiz.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Quiz.ts#L15) +[src/parser/classes/Quiz.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Quiz.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Quiz.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Quiz.ts#L8) +[src/parser/classes/Quiz.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Quiz.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Quiz.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Quiz.ts#L13) +[src/parser/classes/Quiz.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Quiz.ts#L13) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/Quiz.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Quiz.ts#L6) +[src/parser/classes/Quiz.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Quiz.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RecognitionShelf.md b/docs/api/namespaces/YTNodes/classes/RecognitionShelf.md index a8717c18..7b4e46e5 100644 --- a/docs/api/namespaces/YTNodes/classes/RecognitionShelf.md +++ b/docs/api/namespaces/YTNodes/classes/RecognitionShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RecognitionShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RecognitionShelf.ts#L16) +[src/parser/classes/RecognitionShelf.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RecognitionShelf.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RecognitionShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RecognitionShelf.ts#L12) +[src/parser/classes/RecognitionShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RecognitionShelf.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/RecognitionShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RecognitionShelf.ts#L13) +[src/parser/classes/RecognitionShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RecognitionShelf.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/RecognitionShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RecognitionShelf.ts#L11) +[src/parser/classes/RecognitionShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RecognitionShelf.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/RecognitionShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RecognitionShelf.ts#L14) +[src/parser/classes/RecognitionShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RecognitionShelf.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/RecognitionShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RecognitionShelf.ts#L10) +[src/parser/classes/RecognitionShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RecognitionShelf.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/RecognitionShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RecognitionShelf.ts#L8) +[src/parser/classes/RecognitionShelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RecognitionShelf.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ReelItem.md b/docs/api/namespaces/YTNodes/classes/ReelItem.md index d36a9bd8..fb11a8bc 100644 --- a/docs/api/namespaces/YTNodes/classes/ReelItem.md +++ b/docs/api/namespaces/YTNodes/classes/ReelItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L17) +[src/parser/classes/ReelItem.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L15) +[src/parser/classes/ReelItem.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L14) +[src/parser/classes/ReelItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L10) +[src/parser/classes/ReelItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L12) +[src/parser/classes/ReelItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L11) +[src/parser/classes/ReelItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L13) +[src/parser/classes/ReelItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L13) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/ReelItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelItem.ts#L8) +[src/parser/classes/ReelItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelItem.ts#L8) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md b/docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md index 11497154..5f46078e 100644 --- a/docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md +++ b/docs/api/namespaces/YTNodes/classes/ReelPlayerHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ReelPlayerHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerHeader.ts#L16) +[src/parser/classes/ReelPlayerHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerHeader.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ReelPlayerHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerHeader.ts#L14) +[src/parser/classes/ReelPlayerHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerHeader.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ReelPlayerHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerHeader.ts#L13) +[src/parser/classes/ReelPlayerHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerHeader.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ReelPlayerHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerHeader.ts#L12) +[src/parser/classes/ReelPlayerHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerHeader.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ReelPlayerHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerHeader.ts#L10) +[src/parser/classes/ReelPlayerHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerHeader.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ReelPlayerHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerHeader.ts#L11) +[src/parser/classes/ReelPlayerHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerHeader.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/ReelPlayerHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerHeader.ts#L8) +[src/parser/classes/ReelPlayerHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerHeader.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md b/docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md index cf4d7bc6..b28405bb 100644 --- a/docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md +++ b/docs/api/namespaces/YTNodes/classes/ReelPlayerOverlay.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L26) +[src/parser/classes/ReelPlayerOverlay.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L26) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L24) +[src/parser/classes/ReelPlayerOverlay.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L24) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L14) +[src/parser/classes/ReelPlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L16) +[src/parser/classes/ReelPlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L16) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L17) +[src/parser/classes/ReelPlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L17) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L23) +[src/parser/classes/ReelPlayerOverlay.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L23) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L18) +[src/parser/classes/ReelPlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L18) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L15) +[src/parser/classes/ReelPlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L15) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L22) +[src/parser/classes/ReelPlayerOverlay.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L22) *** @@ -116,17 +116,17 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L20) +[src/parser/classes/ReelPlayerOverlay.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L20) *** ### subscribe\_button\_renderer -> **subscribe\_button\_renderer**: `null` \| [`Button`](Button.md) +> **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/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L19) +[src/parser/classes/ReelPlayerOverlay.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L19) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -150,7 +150,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L21) +[src/parser/classes/ReelPlayerOverlay.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L21) *** @@ -164,7 +164,7 @@ #### Defined in -[src/parser/classes/ReelPlayerOverlay.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelPlayerOverlay.ts#L12) +[src/parser/classes/ReelPlayerOverlay.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelPlayerOverlay.ts#L12) ## Methods @@ -184,17 +184,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -228,7 +236,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -262,7 +270,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -300,4 +308,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ReelShelf.md b/docs/api/namespaces/YTNodes/classes/ReelShelf.md index ca22abb3..30c8f2d2 100644 --- a/docs/api/namespaces/YTNodes/classes/ReelShelf.md +++ b/docs/api/namespaces/YTNodes/classes/ReelShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ReelShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelShelf.ts#L13) +[src/parser/classes/ReelShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelShelf.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ReelShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelShelf.ts#L11) +[src/parser/classes/ReelShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelShelf.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ReelShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelShelf.ts#L10) +[src/parser/classes/ReelShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelShelf.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ReelShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelShelf.ts#L9) +[src/parser/classes/ReelShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelShelf.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ReelShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelShelf.ts#L7) +[src/parser/classes/ReelShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelShelf.ts#L7) ## Accessors @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/ReelShelf.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ReelShelf.ts#L24) +[src/parser/classes/ReelShelf.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ReelShelf.ts#L24) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ReelWatchEndpoint.md b/docs/api/namespaces/YTNodes/classes/ReelWatchEndpoint.md new file mode 100644 index 00000000..812a6986 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ReelWatchEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ReelWatchEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ReelWatchEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ReelWatchEndpoint.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/ReelWatchEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ReelWatchEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RelatedChipCloud.md b/docs/api/namespaces/YTNodes/classes/RelatedChipCloud.md index 54e74ab1..a0837c30 100644 --- a/docs/api/namespaces/YTNodes/classes/RelatedChipCloud.md +++ b/docs/api/namespaces/YTNodes/classes/RelatedChipCloud.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RelatedChipCloud.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RelatedChipCloud.ts#L9) +[src/parser/classes/RelatedChipCloud.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RelatedChipCloud.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RelatedChipCloud.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RelatedChipCloud.ts#L7) +[src/parser/classes/RelatedChipCloud.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RelatedChipCloud.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/RelatedChipCloud.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RelatedChipCloud.ts#L5) +[src/parser/classes/RelatedChipCloud.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RelatedChipCloud.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md b/docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md index 102d3cbc..25b48d5a 100644 --- a/docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md +++ b/docs/api/namespaces/YTNodes/classes/RemoveBannerForLiveChatCommand.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L9) +[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L7) +[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L5) +[src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveBannerForLiveChatCommand.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md b/docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md index 217c4f7a..9ff1570c 100644 --- a/docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md +++ b/docs/api/namespaces/YTNodes/classes/RemoveChatItemAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveChatItemAction.ts#L9) +[src/parser/classes/livechat/RemoveChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveChatItemAction.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveChatItemAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveChatItemAction.ts#L7) +[src/parser/classes/livechat/RemoveChatItemAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveChatItemAction.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveChatItemAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveChatItemAction.ts#L5) +[src/parser/classes/livechat/RemoveChatItemAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveChatItemAction.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md b/docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md index 99737555..260f508a 100644 --- a/docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md +++ b/docs/api/namespaces/YTNodes/classes/RemoveChatItemByAuthorAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L9) +[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L7) +[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L5) +[src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/RemoveChatItemByAuthorAction.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md b/docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md index 7483093c..1142a8e5 100644 --- a/docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md +++ b/docs/api/namespaces/YTNodes/classes/ReplaceChatItemAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/ReplaceChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplaceChatItemAction.ts#L11) +[src/parser/classes/livechat/ReplaceChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplaceChatItemAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/ReplaceChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplaceChatItemAction.ts#L9) +[src/parser/classes/livechat/ReplaceChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplaceChatItemAction.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/ReplaceChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplaceChatItemAction.ts#L8) +[src/parser/classes/livechat/ReplaceChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplaceChatItemAction.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/ReplaceChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplaceChatItemAction.ts#L6) +[src/parser/classes/livechat/ReplaceChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplaceChatItemAction.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md b/docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md index bade40c3..b8f87a1e 100644 --- a/docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md +++ b/docs/api/namespaces/YTNodes/classes/ReplayChatItemAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/ReplayChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplayChatItemAction.ts#L11) +[src/parser/classes/livechat/ReplayChatItemAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplayChatItemAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/ReplayChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplayChatItemAction.ts#L8) +[src/parser/classes/livechat/ReplayChatItemAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplayChatItemAction.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/livechat/ReplayChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplayChatItemAction.ts#L9) +[src/parser/classes/livechat/ReplayChatItemAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplayChatItemAction.ts#L9) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/livechat/ReplayChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ReplayChatItemAction.ts#L6) +[src/parser/classes/livechat/ReplayChatItemAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ReplayChatItemAction.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RichGrid.md b/docs/api/namespaces/YTNodes/classes/RichGrid.md index 040d7d5b..c436fafc 100644 --- a/docs/api/namespaces/YTNodes/classes/RichGrid.md +++ b/docs/api/namespaces/YTNodes/classes/RichGrid.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RichGrid.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichGrid.ts#L10) +[src/parser/classes/RichGrid.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichGrid.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RichGrid.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichGrid.ts#L8) +[src/parser/classes/RichGrid.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichGrid.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/RichGrid.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichGrid.ts#L7) +[src/parser/classes/RichGrid.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichGrid.ts#L7) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/RichGrid.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichGrid.ts#L5) +[src/parser/classes/RichGrid.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichGrid.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RichItem.md b/docs/api/namespaces/YTNodes/classes/RichItem.md index b795a747..0070f9ae 100644 --- a/docs/api/namespaces/YTNodes/classes/RichItem.md +++ b/docs/api/namespaces/YTNodes/classes/RichItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RichItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichItem.ts#L9) +[src/parser/classes/RichItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichItem.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RichItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichItem.ts#L7) +[src/parser/classes/RichItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichItem.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/RichItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichItem.ts#L5) +[src/parser/classes/RichItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichItem.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RichListHeader.md b/docs/api/namespaces/YTNodes/classes/RichListHeader.md index a61e6615..096ad75e 100644 --- a/docs/api/namespaces/YTNodes/classes/RichListHeader.md +++ b/docs/api/namespaces/YTNodes/classes/RichListHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RichListHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichListHeader.ts#L13) +[src/parser/classes/RichListHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichListHeader.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RichListHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichListHeader.ts#L11) +[src/parser/classes/RichListHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichListHeader.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/RichListHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichListHeader.ts#L9) +[src/parser/classes/RichListHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichListHeader.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/RichListHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichListHeader.ts#L8) +[src/parser/classes/RichListHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichListHeader.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/RichListHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichListHeader.ts#L10) +[src/parser/classes/RichListHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichListHeader.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/RichListHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichListHeader.ts#L6) +[src/parser/classes/RichListHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichListHeader.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RichMetadata.md b/docs/api/namespaces/YTNodes/classes/RichMetadata.md index 908ea996..d1f60177 100644 --- a/docs/api/namespaces/YTNodes/classes/RichMetadata.md +++ b/docs/api/namespaces/YTNodes/classes/RichMetadata.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L17) +[src/parser/classes/RichMetadata.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L13) +[src/parser/classes/RichMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L15) +[src/parser/classes/RichMetadata.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L14) +[src/parser/classes/RichMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L12) +[src/parser/classes/RichMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L10) +[src/parser/classes/RichMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L10) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L11) +[src/parser/classes/RichMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L11) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/RichMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadata.ts#L8) +[src/parser/classes/RichMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadata.ts#L8) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RichMetadataRow.md b/docs/api/namespaces/YTNodes/classes/RichMetadataRow.md index bfc88e8c..fd3eeb9d 100644 --- a/docs/api/namespaces/YTNodes/classes/RichMetadataRow.md +++ b/docs/api/namespaces/YTNodes/classes/RichMetadataRow.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RichMetadataRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadataRow.ts#L9) +[src/parser/classes/RichMetadataRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadataRow.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RichMetadataRow.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadataRow.ts#L7) +[src/parser/classes/RichMetadataRow.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadataRow.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/RichMetadataRow.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichMetadataRow.ts#L5) +[src/parser/classes/RichMetadataRow.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichMetadataRow.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RichSection.md b/docs/api/namespaces/YTNodes/classes/RichSection.md index 23b022f4..1a323b0f 100644 --- a/docs/api/namespaces/YTNodes/classes/RichSection.md +++ b/docs/api/namespaces/YTNodes/classes/RichSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RichSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichSection.ts#L9) +[src/parser/classes/RichSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichSection.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RichSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichSection.ts#L7) +[src/parser/classes/RichSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichSection.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/RichSection.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichSection.ts#L5) +[src/parser/classes/RichSection.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichSection.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/RichShelf.md b/docs/api/namespaces/YTNodes/classes/RichShelf.md index 4d6e558d..534ffc97 100644 --- a/docs/api/namespaces/YTNodes/classes/RichShelf.md +++ b/docs/api/namespaces/YTNodes/classes/RichShelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/RichShelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichShelf.ts#L13) +[src/parser/classes/RichShelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichShelf.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/RichShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichShelf.ts#L10) +[src/parser/classes/RichShelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichShelf.ts#L10) *** @@ -46,7 +46,17 @@ #### Defined in -[src/parser/classes/RichShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichShelf.ts#L11) +[src/parser/classes/RichShelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichShelf.ts#L11) + +*** + +### subtitle? + +> `optional` **subtitle**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/RichShelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichShelf.ts#L12) *** @@ -56,7 +66,7 @@ #### Defined in -[src/parser/classes/RichShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichShelf.ts#L9) +[src/parser/classes/RichShelf.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichShelf.ts#L9) *** @@ -70,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +94,7 @@ #### Defined in -[src/parser/classes/RichShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/RichShelf.ts#L7) +[src/parser/classes/RichShelf.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/RichShelf.ts#L7) ## Methods @@ -104,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchBox.md b/docs/api/namespaces/YTNodes/classes/SearchBox.md index 4d4a8c1c..bd51768c 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchBox.md +++ b/docs/api/namespaces/YTNodes/classes/SearchBox.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchBox.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchBox.ts#L15) +[src/parser/classes/SearchBox.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchBox.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchBox.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchBox.ts#L12) +[src/parser/classes/SearchBox.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchBox.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SearchBox.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchBox.ts#L10) +[src/parser/classes/SearchBox.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchBox.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SearchBox.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchBox.ts#L13) +[src/parser/classes/SearchBox.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchBox.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SearchBox.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchBox.ts#L11) +[src/parser/classes/SearchBox.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchBox.ts#L11) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/SearchBox.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchBox.ts#L8) +[src/parser/classes/SearchBox.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchBox.ts#L8) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchEndpoint.md b/docs/api/namespaces/YTNodes/classes/SearchEndpoint.md new file mode 100644 index 00000000..ab18bd4c --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/SearchEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SearchEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SearchEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SearchEndpoint.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/SearchEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SearchEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchFilter.md b/docs/api/namespaces/YTNodes/classes/SearchFilter.md index fb1bb13c..c1e783c8 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchFilter.md +++ b/docs/api/namespaces/YTNodes/classes/SearchFilter.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L14) +[src/parser/classes/SearchFilter.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L10) +[src/parser/classes/SearchFilter.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L9) +[src/parser/classes/SearchFilter.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L12) +[src/parser/classes/SearchFilter.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L11) +[src/parser/classes/SearchFilter.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L11) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L7) +[src/parser/classes/SearchFilter.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L7) ## Accessors @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L25) +[src/parser/classes/SearchFilter.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L25) *** @@ -122,7 +122,7 @@ #### Defined in -[src/parser/classes/SearchFilter.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilter.ts#L29) +[src/parser/classes/SearchFilter.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilter.ts#L29) ## Methods @@ -142,17 +142,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -186,7 +194,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -220,7 +228,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -258,4 +266,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchFilterGroup.md b/docs/api/namespaces/YTNodes/classes/SearchFilterGroup.md index 96dbbd25..e24acb50 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchFilterGroup.md +++ b/docs/api/namespaces/YTNodes/classes/SearchFilterGroup.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchFilterGroup.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterGroup.ts#L13) +[src/parser/classes/SearchFilterGroup.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterGroup.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchFilterGroup.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterGroup.ts#L11) +[src/parser/classes/SearchFilterGroup.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterGroup.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SearchFilterGroup.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterGroup.ts#L10) +[src/parser/classes/SearchFilterGroup.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterGroup.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SearchFilterGroup.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterGroup.ts#L8) +[src/parser/classes/SearchFilterGroup.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterGroup.ts#L8) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md b/docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md index a0b3dc02..c24f0ce0 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md +++ b/docs/api/namespaces/YTNodes/classes/SearchFilterOptionsDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchFilterOptionsDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterOptionsDialog.ts#L13) +[src/parser/classes/SearchFilterOptionsDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterOptionsDialog.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchFilterOptionsDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterOptionsDialog.ts#L11) +[src/parser/classes/SearchFilterOptionsDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterOptionsDialog.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SearchFilterOptionsDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterOptionsDialog.ts#L10) +[src/parser/classes/SearchFilterOptionsDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterOptionsDialog.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SearchFilterOptionsDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchFilterOptionsDialog.ts#L8) +[src/parser/classes/SearchFilterOptionsDialog.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchFilterOptionsDialog.ts#L8) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchHeader.md b/docs/api/namespaces/YTNodes/classes/SearchHeader.md index 4b95b279..c5ea13ac 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchHeader.md +++ b/docs/api/namespaces/YTNodes/classes/SearchHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchHeader.ts#L12) +[src/parser/classes/SearchHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchHeader.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchHeader.ts#L9) +[src/parser/classes/SearchHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchHeader.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SearchHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchHeader.ts#L10) +[src/parser/classes/SearchHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchHeader.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SearchHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchHeader.ts#L7) +[src/parser/classes/SearchHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchHeader.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md b/docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md index 6621e8d5..cbee94b9 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md +++ b/docs/api/namespaces/YTNodes/classes/SearchRefinementCard.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchRefinementCard.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchRefinementCard.ts#L14) +[src/parser/classes/SearchRefinementCard.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchRefinementCard.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchRefinementCard.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchRefinementCard.ts#L11) +[src/parser/classes/SearchRefinementCard.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchRefinementCard.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SearchRefinementCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchRefinementCard.ts#L12) +[src/parser/classes/SearchRefinementCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchRefinementCard.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SearchRefinementCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchRefinementCard.ts#L10) +[src/parser/classes/SearchRefinementCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchRefinementCard.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/SearchRefinementCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchRefinementCard.ts#L8) +[src/parser/classes/SearchRefinementCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchRefinementCard.ts#L8) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchSubMenu.md b/docs/api/namespaces/YTNodes/classes/SearchSubMenu.md index aef703c0..9a445cee 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchSubMenu.md +++ b/docs/api/namespaces/YTNodes/classes/SearchSubMenu.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchSubMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSubMenu.ts#L15) +[src/parser/classes/SearchSubMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSubMenu.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchSubMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSubMenu.ts#L13) +[src/parser/classes/SearchSubMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSubMenu.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SearchSubMenu.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSubMenu.ts#L12) +[src/parser/classes/SearchSubMenu.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSubMenu.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SearchSubMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSubMenu.ts#L11) +[src/parser/classes/SearchSubMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSubMenu.ts#L11) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/SearchSubMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSubMenu.ts#L9) +[src/parser/classes/SearchSubMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSubMenu.ts#L9) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchSuggestion.md b/docs/api/namespaces/YTNodes/classes/SearchSuggestion.md index 98827b1c..592c306e 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchSuggestion.md +++ b/docs/api/namespaces/YTNodes/classes/SearchSuggestion.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L14) +[src/parser/classes/SearchSuggestion.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L14) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L10) +[src/parser/classes/SearchSuggestion.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L10) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L11) +[src/parser/classes/SearchSuggestion.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L12) +[src/parser/classes/SearchSuggestion.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L12) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L9) +[src/parser/classes/SearchSuggestion.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L9) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/SearchSuggestion.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestion.ts#L7) +[src/parser/classes/SearchSuggestion.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestion.ts#L7) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SearchSuggestionsSection.md b/docs/api/namespaces/YTNodes/classes/SearchSuggestionsSection.md index 77d9f9e9..55f2030e 100644 --- a/docs/api/namespaces/YTNodes/classes/SearchSuggestionsSection.md +++ b/docs/api/namespaces/YTNodes/classes/SearchSuggestionsSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SearchSuggestionsSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestionsSection.ts#L9) +[src/parser/classes/SearchSuggestionsSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestionsSection.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SearchSuggestionsSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestionsSection.ts#L7) +[src/parser/classes/SearchSuggestionsSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestionsSection.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/SearchSuggestionsSection.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SearchSuggestionsSection.ts#L5) +[src/parser/classes/SearchSuggestionsSection.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SearchSuggestionsSection.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md b/docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md index 2461795e..8a594632 100644 --- a/docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md +++ b/docs/api/namespaces/YTNodes/classes/SecondarySearchContainer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SecondarySearchContainer.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SecondarySearchContainer.ts#L9) +[src/parser/classes/SecondarySearchContainer.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SecondarySearchContainer.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SecondarySearchContainer.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SecondarySearchContainer.ts#L7) +[src/parser/classes/SecondarySearchContainer.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SecondarySearchContainer.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/SecondarySearchContainer.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SecondarySearchContainer.ts#L5) +[src/parser/classes/SecondarySearchContainer.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SecondarySearchContainer.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SectionList.md b/docs/api/namespaces/YTNodes/classes/SectionList.md index 8e2545b6..4638a56b 100644 --- a/docs/api/namespaces/YTNodes/classes/SectionList.md +++ b/docs/api/namespaces/YTNodes/classes/SectionList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SectionList.ts#L13) +[src/parser/classes/SectionList.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SectionList.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SectionList.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SectionList.ts#L7) +[src/parser/classes/SectionList.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SectionList.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SectionList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SectionList.ts#L9) +[src/parser/classes/SectionList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SectionList.ts#L9) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SectionList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SectionList.ts#L10) +[src/parser/classes/SectionList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SectionList.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SectionList.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SectionList.ts#L11) +[src/parser/classes/SectionList.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SectionList.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SectionList.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SectionList.ts#L8) +[src/parser/classes/SectionList.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SectionList.ts#L8) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/SectionList.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SectionList.ts#L5) +[src/parser/classes/SectionList.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SectionList.ts#L5) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md b/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md index 1604a8e6..c97f7cff 100644 --- a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md +++ b/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButton.ts#L13) +[src/parser/classes/SegmentedLikeDislikeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButton.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButton.ts#L11) +[src/parser/classes/SegmentedLikeDislikeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButton.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButton.ts#L10) +[src/parser/classes/SegmentedLikeDislikeButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButton.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButton.ts#L8) +[src/parser/classes/SegmentedLikeDislikeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButton.ts#L8) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md b/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md index 2274eb15..4795f872 100644 --- a/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md +++ b/docs/api/namespaces/YTNodes/classes/SegmentedLikeDislikeButtonView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L25) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L25) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L10) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L10) *** @@ -62,7 +62,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L15) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L15) *** @@ -72,7 +72,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L11) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L11) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L9) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L9) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L22) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L22) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L12) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L12) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L23) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L23) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/SegmentedLikeDislikeButtonView.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L7) +[src/parser/classes/SegmentedLikeDislikeButtonView.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SegmentedLikeDislikeButtonView.ts#L7) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SendFeedbackAction.md b/docs/api/namespaces/YTNodes/classes/SendFeedbackAction.md new file mode 100644 index 00000000..bdda89be --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/SendFeedbackAction.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SendFeedbackAction + +# Class: SendFeedbackAction + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new SendFeedbackAction() + +> **new SendFeedbackAction**(`data`): [`SendFeedbackAction`](SendFeedbackAction.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`SendFeedbackAction`](SendFeedbackAction.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/actions/SendFeedbackAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/SendFeedbackAction.ts#L9) + +## Properties + +### bucket + +> **bucket**: `string` + +#### Defined in + +[src/parser/classes/actions/SendFeedbackAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/SendFeedbackAction.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'SendFeedbackAction'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/actions/SendFeedbackAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/SendFeedbackAction.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is SendFeedbackAction & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is SendFeedbackAction & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SettingBoolean.md b/docs/api/namespaces/YTNodes/classes/SettingBoolean.md index 6d75e21b..2269c1b1 100644 --- a/docs/api/namespaces/YTNodes/classes/SettingBoolean.md +++ b/docs/api/namespaces/YTNodes/classes/SettingBoolean.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SettingBoolean.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingBoolean.ts#L15) +[src/parser/classes/SettingBoolean.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingBoolean.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SettingBoolean.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingBoolean.ts#L12) +[src/parser/classes/SettingBoolean.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingBoolean.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SettingBoolean.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingBoolean.ts#L11) +[src/parser/classes/SettingBoolean.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingBoolean.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SettingBoolean.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingBoolean.ts#L13) +[src/parser/classes/SettingBoolean.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingBoolean.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SettingBoolean.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingBoolean.ts#L10) +[src/parser/classes/SettingBoolean.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingBoolean.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SettingBoolean.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingBoolean.ts#L9) +[src/parser/classes/SettingBoolean.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingBoolean.ts#L9) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/SettingBoolean.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingBoolean.ts#L7) +[src/parser/classes/SettingBoolean.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingBoolean.ts#L7) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md b/docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md index 5879ab1e..217d6ba3 100644 --- a/docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md +++ b/docs/api/namespaces/YTNodes/classes/SettingsCheckbox.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SettingsCheckbox.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsCheckbox.ts#L14) +[src/parser/classes/SettingsCheckbox.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsCheckbox.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SettingsCheckbox.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsCheckbox.ts#L11) +[src/parser/classes/SettingsCheckbox.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsCheckbox.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SettingsCheckbox.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsCheckbox.ts#L10) +[src/parser/classes/SettingsCheckbox.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsCheckbox.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SettingsCheckbox.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsCheckbox.ts#L9) +[src/parser/classes/SettingsCheckbox.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsCheckbox.ts#L9) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SettingsCheckbox.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsCheckbox.ts#L12) +[src/parser/classes/SettingsCheckbox.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsCheckbox.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SettingsCheckbox.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsCheckbox.ts#L8) +[src/parser/classes/SettingsCheckbox.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsCheckbox.ts#L8) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/SettingsCheckbox.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsCheckbox.ts#L6) +[src/parser/classes/SettingsCheckbox.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsCheckbox.ts#L6) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SettingsOptions.md b/docs/api/namespaces/YTNodes/classes/SettingsOptions.md index d6241977..a6346a1f 100644 --- a/docs/api/namespaces/YTNodes/classes/SettingsOptions.md +++ b/docs/api/namespaces/YTNodes/classes/SettingsOptions.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SettingsOptions.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsOptions.ts#L17) +[src/parser/classes/SettingsOptions.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsOptions.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SettingsOptions.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsOptions.ts#L15) +[src/parser/classes/SettingsOptions.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsOptions.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SettingsOptions.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsOptions.ts#L14) +[src/parser/classes/SettingsOptions.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsOptions.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SettingsOptions.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsOptions.ts#L13) +[src/parser/classes/SettingsOptions.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsOptions.ts#L13) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/SettingsOptions.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsOptions.ts#L11) +[src/parser/classes/SettingsOptions.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsOptions.ts#L11) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SettingsSidebar.md b/docs/api/namespaces/YTNodes/classes/SettingsSidebar.md index 7eeab507..894d682a 100644 --- a/docs/api/namespaces/YTNodes/classes/SettingsSidebar.md +++ b/docs/api/namespaces/YTNodes/classes/SettingsSidebar.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SettingsSidebar.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSidebar.ts#L12) +[src/parser/classes/SettingsSidebar.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSidebar.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SettingsSidebar.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSidebar.ts#L10) +[src/parser/classes/SettingsSidebar.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSidebar.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SettingsSidebar.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSidebar.ts#L9) +[src/parser/classes/SettingsSidebar.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSidebar.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SettingsSidebar.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSidebar.ts#L7) +[src/parser/classes/SettingsSidebar.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSidebar.ts#L7) ## Accessors @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/SettingsSidebar.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSidebar.ts#L19) +[src/parser/classes/SettingsSidebar.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSidebar.ts#L19) ## Methods @@ -108,17 +108,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -152,7 +160,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -186,7 +194,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -224,4 +232,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SettingsSwitch.md b/docs/api/namespaces/YTNodes/classes/SettingsSwitch.md index 0a3c5a34..34856ccc 100644 --- a/docs/api/namespaces/YTNodes/classes/SettingsSwitch.md +++ b/docs/api/namespaces/YTNodes/classes/SettingsSwitch.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SettingsSwitch.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSwitch.ts#L15) +[src/parser/classes/SettingsSwitch.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSwitch.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SettingsSwitch.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSwitch.ts#L13) +[src/parser/classes/SettingsSwitch.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSwitch.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SettingsSwitch.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSwitch.ts#L12) +[src/parser/classes/SettingsSwitch.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSwitch.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SettingsSwitch.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSwitch.ts#L11) +[src/parser/classes/SettingsSwitch.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSwitch.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SettingsSwitch.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSwitch.ts#L10) +[src/parser/classes/SettingsSwitch.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSwitch.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SettingsSwitch.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSwitch.ts#L9) +[src/parser/classes/SettingsSwitch.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSwitch.ts#L9) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/SettingsSwitch.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SettingsSwitch.ts#L7) +[src/parser/classes/SettingsSwitch.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SettingsSwitch.ts#L7) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShareEndpoint.md b/docs/api/namespaces/YTNodes/classes/ShareEndpoint.md new file mode 100644 index 00000000..548914c1 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ShareEndpoint.md @@ -0,0 +1,237 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShareEndpoint + +# Class: ShareEndpoint + +## Extends + +- [`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md) + +## Constructors + +### new ShareEndpoint() + +> **new ShareEndpoint**(`data`): [`ShareEndpoint`](ShareEndpoint.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`ShareEndpoint`](ShareEndpoint.md) + +#### Overrides + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`constructor`](ShareEntityServiceEndpoint.md#constructors) + +#### Defined in + +[src/parser/classes/endpoints/ShareEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEndpoint.ts#L7) + +## Properties + +### type + +> `readonly` **type**: `string` + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`type`](ShareEntityServiceEndpoint.md#type) + +#### Defined in + +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'ShareEndpoint'` + +#### Overrides + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`type`](ShareEntityServiceEndpoint.md#type-1) + +#### Defined in + +[src/parser/classes/endpoints/ShareEndpoint.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEndpoint.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 + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`as`](ShareEntityServiceEndpoint.md#as) + +#### Defined in + +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### buildRequest() + +> **buildRequest**(): [`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md) + +#### Returns + +[`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md) + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`buildRequest`](ShareEntityServiceEndpoint.md#buildrequest) + +#### Defined in + +[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L19) + +*** + +### getApiPath() + +> **getApiPath**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`getApiPath`](ShareEntityServiceEndpoint.md#getapipath) + +#### Defined in + +[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L15) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is ShareEndpoint & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is ShareEndpoint & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`hasKey`](ShareEntityServiceEndpoint.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`is`](ShareEntityServiceEndpoint.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`key`](ShareEntityServiceEndpoint.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShareEntityEndpoint.md b/docs/api/namespaces/YTNodes/classes/ShareEntityEndpoint.md new file mode 100644 index 00000000..b4ca18bc --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ShareEntityEndpoint.md @@ -0,0 +1,237 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShareEntityEndpoint + +# Class: ShareEntityEndpoint + +## Extends + +- [`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md) + +## Constructors + +### new ShareEntityEndpoint() + +> **new ShareEntityEndpoint**(`data`): [`ShareEntityEndpoint`](ShareEntityEndpoint.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`ShareEntityEndpoint`](ShareEntityEndpoint.md) + +#### Overrides + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`constructor`](ShareEntityServiceEndpoint.md#constructors) + +#### Defined in + +[src/parser/classes/endpoints/ShareEntityEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityEndpoint.ts#L7) + +## Properties + +### type + +> `readonly` **type**: `string` + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`type`](ShareEntityServiceEndpoint.md#type) + +#### Defined in + +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'ShareEntityEndpoint'` + +#### Overrides + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`type`](ShareEntityServiceEndpoint.md#type-1) + +#### Defined in + +[src/parser/classes/endpoints/ShareEntityEndpoint.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityEndpoint.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 + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`as`](ShareEntityServiceEndpoint.md#as) + +#### Defined in + +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### buildRequest() + +> **buildRequest**(): [`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md) + +#### Returns + +[`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md) + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`buildRequest`](ShareEntityServiceEndpoint.md#buildrequest) + +#### Defined in + +[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L19) + +*** + +### getApiPath() + +> **getApiPath**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`getApiPath`](ShareEntityServiceEndpoint.md#getapipath) + +#### Defined in + +[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L15) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is ShareEntityEndpoint & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is ShareEntityEndpoint & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`hasKey`](ShareEntityServiceEndpoint.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`is`](ShareEntityServiceEndpoint.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`key`](ShareEntityServiceEndpoint.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShareEntityServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/ShareEntityServiceEndpoint.md new file mode 100644 index 00000000..15e57597 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ShareEntityServiceEndpoint.md @@ -0,0 +1,246 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.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/ShareEntityServiceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SharePanelHeader.md b/docs/api/namespaces/YTNodes/classes/SharePanelHeader.md new file mode 100644 index 00000000..c7d293c0 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/SharePanelHeader.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SharePanelHeader + +# Class: SharePanelHeader + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new SharePanelHeader() + +> **new SharePanelHeader**(`data`): [`SharePanelHeader`](SharePanelHeader.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`SharePanelHeader`](SharePanelHeader.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/SharePanelHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharePanelHeader.ts#L9) + +## Properties + +### title + +> **title**: [`YTNode`](../../Helpers/classes/YTNode.md) + +#### Defined in + +[src/parser/classes/SharePanelHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharePanelHeader.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'SharePanelHeader'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/SharePanelHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharePanelHeader.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is SharePanelHeader & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is SharePanelHeader & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SharePanelTitleV15.md b/docs/api/namespaces/YTNodes/classes/SharePanelTitleV15.md new file mode 100644 index 00000000..2d6ab5e5 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/SharePanelTitleV15.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SharePanelTitleV15 + +# Class: SharePanelTitleV15 + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new SharePanelTitleV15() + +> **new SharePanelTitleV15**(`data`): [`SharePanelTitleV15`](SharePanelTitleV15.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`SharePanelTitleV15`](SharePanelTitleV15.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/SharePanelTitleV15.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharePanelTitleV15.ts#L10) + +## Properties + +### title + +> **title**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/SharePanelTitleV15.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharePanelTitleV15.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'SharePanelTitleV15'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/SharePanelTitleV15.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharePanelTitleV15.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is SharePanelTitleV15 & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is SharePanelTitleV15 & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShareTarget.md b/docs/api/namespaces/YTNodes/classes/ShareTarget.md new file mode 100644 index 00000000..20097720 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ShareTarget.md @@ -0,0 +1,241 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SharedPost.md b/docs/api/namespaces/YTNodes/classes/SharedPost.md index b3cf2dad..ce09f1f7 100644 --- a/docs/api/namespaces/YTNodes/classes/SharedPost.md +++ b/docs/api/namespaces/YTNodes/classes/SharedPost.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L25) +[src/parser/classes/SharedPost.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L26) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L23) +[src/parser/classes/SharedPost.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L24) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L16) +[src/parser/classes/SharedPost.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L17) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L21) +[src/parser/classes/SharedPost.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L22) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L22) +[src/parser/classes/SharedPost.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L23) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L20) +[src/parser/classes/SharedPost.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L21) *** @@ -86,17 +86,17 @@ #### Defined in -[src/parser/classes/SharedPost.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L18) +[src/parser/classes/SharedPost.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L19) *** ### original\_post -> **original\_post**: `null` \| [`BackstagePost`](BackstagePost.md) +> **original\_post**: `null` \| [`BackstagePost`](BackstagePost.md) \| [`Post`](Post.md) #### Defined in -[src/parser/classes/SharedPost.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L19) +[src/parser/classes/SharedPost.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L20) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L17) +[src/parser/classes/SharedPost.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L18) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L15) +[src/parser/classes/SharedPost.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L16) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/SharedPost.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SharedPost.ts#L13) +[src/parser/classes/SharedPost.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SharedPost.ts#L14) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Shelf.md b/docs/api/namespaces/YTNodes/classes/Shelf.md index 9365bf63..459c03e6 100644 --- a/docs/api/namespaces/YTNodes/classes/Shelf.md +++ b/docs/api/namespaces/YTNodes/classes/Shelf.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Shelf.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L17) +[src/parser/classes/Shelf.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L18) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Shelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L12) +[src/parser/classes/Shelf.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Shelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L11) +[src/parser/classes/Shelf.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Shelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L13) +[src/parser/classes/Shelf.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Shelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L14) +[src/parser/classes/Shelf.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L14) *** @@ -76,7 +76,17 @@ #### Defined in -[src/parser/classes/Shelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L15) +[src/parser/classes/Shelf.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L16) *** @@ -86,7 +96,7 @@ #### Defined in -[src/parser/classes/Shelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L10) +[src/parser/classes/Shelf.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L10) *** @@ -100,7 +110,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +124,7 @@ #### Defined in -[src/parser/classes/Shelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Shelf.ts#L8) +[src/parser/classes/Shelf.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Shelf.ts#L8) ## Methods @@ -134,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShortsLockupView.md b/docs/api/namespaces/YTNodes/classes/ShortsLockupView.md index ac1b3e21..e9dc09d6 100644 --- a/docs/api/namespaces/YTNodes/classes/ShortsLockupView.md +++ b/docs/api/namespaces/YTNodes/classes/ShortsLockupView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L26) +[src/parser/classes/ShortsLockupView.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L26) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L13) +[src/parser/classes/ShortsLockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L24) +[src/parser/classes/ShortsLockupView.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L24) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L12) +[src/parser/classes/ShortsLockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L17) +[src/parser/classes/ShortsLockupView.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L17) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L23) +[src/parser/classes/ShortsLockupView.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L23) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L16) +[src/parser/classes/ShortsLockupView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L16) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L18) +[src/parser/classes/ShortsLockupView.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L18) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L15) +[src/parser/classes/ShortsLockupView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L15) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L19) +[src/parser/classes/ShortsLockupView.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L19) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L14) +[src/parser/classes/ShortsLockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L14) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -162,7 +162,7 @@ #### Defined in -[src/parser/classes/ShortsLockupView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShortsLockupView.ts#L10) +[src/parser/classes/ShortsLockupView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShortsLockupView.ts#L10) ## Methods @@ -182,17 +182,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -226,7 +234,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -260,7 +268,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -298,4 +306,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShowCustomThumbnail.md b/docs/api/namespaces/YTNodes/classes/ShowCustomThumbnail.md index c3a687a2..06734e11 100644 --- a/docs/api/namespaces/YTNodes/classes/ShowCustomThumbnail.md +++ b/docs/api/namespaces/YTNodes/classes/ShowCustomThumbnail.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ShowCustomThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowCustomThumbnail.ts#L10) +[src/parser/classes/ShowCustomThumbnail.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowCustomThumbnail.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ShowCustomThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowCustomThumbnail.ts#L8) +[src/parser/classes/ShowCustomThumbnail.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowCustomThumbnail.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ShowCustomThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowCustomThumbnail.ts#L6) +[src/parser/classes/ShowCustomThumbnail.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowCustomThumbnail.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShowDialogCommand.md b/docs/api/namespaces/YTNodes/classes/ShowDialogCommand.md new file mode 100644 index 00000000..108b5594 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ShowDialogCommand.md @@ -0,0 +1,221 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md b/docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md index 44285b48..b8af88b4 100644 --- a/docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md +++ b/docs/api/namespaces/YTNodes/classes/ShowLiveChatActionPanelAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L11) +[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L9) +[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L7) +[src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatActionPanelAction.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md b/docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md index f4a81b5e..5e2738de 100644 --- a/docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md +++ b/docs/api/namespaces/YTNodes/classes/ShowLiveChatDialogAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L10) +[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L8) +[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L6) +[src/parser/classes/livechat/ShowLiveChatDialogAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatDialogAction.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md b/docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md index 13eef195..22dad2ca 100644 --- a/docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md +++ b/docs/api/namespaces/YTNodes/classes/ShowLiveChatTooltipCommand.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L10) +[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L8) +[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L6) +[src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/ShowLiveChatTooltipCommand.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md b/docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md index b564ce37..a28587fe 100644 --- a/docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md +++ b/docs/api/namespaces/YTNodes/classes/ShowingResultsFor.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L16) +[src/parser/classes/ShowingResultsFor.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L9) +[src/parser/classes/ShowingResultsFor.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L11) +[src/parser/classes/ShowingResultsFor.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L10) +[src/parser/classes/ShowingResultsFor.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L12) +[src/parser/classes/ShowingResultsFor.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L13) +[src/parser/classes/ShowingResultsFor.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L14) +[src/parser/classes/ShowingResultsFor.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L14) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/ShowingResultsFor.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ShowingResultsFor.ts#L7) +[src/parser/classes/ShowingResultsFor.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ShowingResultsFor.ts#L7) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SignalAction.md b/docs/api/namespaces/YTNodes/classes/SignalAction.md new file mode 100644 index 00000000..cee3ed17 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/SignalAction.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / SignalAction + +# Class: SignalAction + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new SignalAction() + +> **new SignalAction**(`data`): [`SignalAction`](SignalAction.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`SignalAction`](SignalAction.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/actions/SignalAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/SignalAction.ts#L9) + +## Properties + +### signal + +> **signal**: `string` + +#### Defined in + +[src/parser/classes/actions/SignalAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/SignalAction.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'SignalAction'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/actions/SignalAction.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/SignalAction.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is SignalAction & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is SignalAction & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SignalServiceEndpoint.md b/docs/api/namespaces/YTNodes/classes/SignalServiceEndpoint.md new file mode 100644 index 00000000..fc93395e --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/SignalServiceEndpoint.md @@ -0,0 +1,221 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleCardContent.md b/docs/api/namespaces/YTNodes/classes/SimpleCardContent.md index 46cf0143..6eba224a 100644 --- a/docs/api/namespaces/YTNodes/classes/SimpleCardContent.md +++ b/docs/api/namespaces/YTNodes/classes/SimpleCardContent.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L17) +[src/parser/classes/SimpleCardContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L14) +[src/parser/classes/SimpleCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L12) +[src/parser/classes/SimpleCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L15) +[src/parser/classes/SimpleCardContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L10) +[src/parser/classes/SimpleCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L13) +[src/parser/classes/SimpleCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L11) +[src/parser/classes/SimpleCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L11) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/SimpleCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardContent.ts#L8) +[src/parser/classes/SimpleCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardContent.ts#L8) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md b/docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md index 12f2a0da..6fd6e15b 100644 --- a/docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md +++ b/docs/api/namespaces/YTNodes/classes/SimpleCardTeaser.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SimpleCardTeaser.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardTeaser.ts#L11) +[src/parser/classes/SimpleCardTeaser.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardTeaser.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SimpleCardTeaser.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardTeaser.ts#L8) +[src/parser/classes/SimpleCardTeaser.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardTeaser.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SimpleCardTeaser.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardTeaser.ts#L9) +[src/parser/classes/SimpleCardTeaser.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardTeaser.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SimpleCardTeaser.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleCardTeaser.ts#L6) +[src/parser/classes/SimpleCardTeaser.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleCardTeaser.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md b/docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md index 065a55f8..0e04d477 100644 --- a/docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md +++ b/docs/api/namespaces/YTNodes/classes/SimpleMenuHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/menus/SimpleMenuHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/SimpleMenuHeader.ts#L14) +[src/parser/classes/menus/SimpleMenuHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/SimpleMenuHeader.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/menus/SimpleMenuHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/SimpleMenuHeader.ts#L12) +[src/parser/classes/menus/SimpleMenuHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/SimpleMenuHeader.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/menus/SimpleMenuHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/SimpleMenuHeader.ts#L11) +[src/parser/classes/menus/SimpleMenuHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/SimpleMenuHeader.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/menus/SimpleMenuHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/SimpleMenuHeader.ts#L9) +[src/parser/classes/menus/SimpleMenuHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/SimpleMenuHeader.ts#L9) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SimpleTextSection.md b/docs/api/namespaces/YTNodes/classes/SimpleTextSection.md index d4e8d7cb..4f175985 100644 --- a/docs/api/namespaces/YTNodes/classes/SimpleTextSection.md +++ b/docs/api/namespaces/YTNodes/classes/SimpleTextSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SimpleTextSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleTextSection.ts#L11) +[src/parser/classes/SimpleTextSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleTextSection.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SimpleTextSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleTextSection.ts#L8) +[src/parser/classes/SimpleTextSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleTextSection.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SimpleTextSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleTextSection.ts#L9) +[src/parser/classes/SimpleTextSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleTextSection.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SimpleTextSection.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SimpleTextSection.ts#L6) +[src/parser/classes/SimpleTextSection.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SimpleTextSection.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md b/docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md index a26a39f7..7d9ecd2b 100644 --- a/docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md +++ b/docs/api/namespaces/YTNodes/classes/SingleActionEmergencySupport.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SingleActionEmergencySupport.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleActionEmergencySupport.ts#L15) +[src/parser/classes/SingleActionEmergencySupport.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleActionEmergencySupport.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SingleActionEmergencySupport.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleActionEmergencySupport.ts#L9) +[src/parser/classes/SingleActionEmergencySupport.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleActionEmergencySupport.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SingleActionEmergencySupport.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleActionEmergencySupport.ts#L11) +[src/parser/classes/SingleActionEmergencySupport.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleActionEmergencySupport.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SingleActionEmergencySupport.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleActionEmergencySupport.ts#L13) +[src/parser/classes/SingleActionEmergencySupport.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleActionEmergencySupport.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SingleActionEmergencySupport.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleActionEmergencySupport.ts#L12) +[src/parser/classes/SingleActionEmergencySupport.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleActionEmergencySupport.ts#L12) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SingleActionEmergencySupport.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleActionEmergencySupport.ts#L10) +[src/parser/classes/SingleActionEmergencySupport.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleActionEmergencySupport.ts#L10) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/SingleActionEmergencySupport.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleActionEmergencySupport.ts#L7) +[src/parser/classes/SingleActionEmergencySupport.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleActionEmergencySupport.ts#L7) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SingleColumnBrowseResults.md b/docs/api/namespaces/YTNodes/classes/SingleColumnBrowseResults.md index 2f36634b..7819835b 100644 --- a/docs/api/namespaces/YTNodes/classes/SingleColumnBrowseResults.md +++ b/docs/api/namespaces/YTNodes/classes/SingleColumnBrowseResults.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SingleColumnBrowseResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleColumnBrowseResults.ts#L10) +[src/parser/classes/SingleColumnBrowseResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleColumnBrowseResults.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SingleColumnBrowseResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleColumnBrowseResults.ts#L8) +[src/parser/classes/SingleColumnBrowseResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleColumnBrowseResults.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/SingleColumnBrowseResults.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleColumnBrowseResults.ts#L6) +[src/parser/classes/SingleColumnBrowseResults.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleColumnBrowseResults.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SingleColumnMusicWatchNextResults.md b/docs/api/namespaces/YTNodes/classes/SingleColumnMusicWatchNextResults.md index 3a7ecdf7..19abbfae 100644 --- a/docs/api/namespaces/YTNodes/classes/SingleColumnMusicWatchNextResults.md +++ b/docs/api/namespaces/YTNodes/classes/SingleColumnMusicWatchNextResults.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SingleColumnMusicWatchNextResults.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleColumnMusicWatchNextResults.ts#L9) +[src/parser/classes/SingleColumnMusicWatchNextResults.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleColumnMusicWatchNextResults.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SingleColumnMusicWatchNextResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleColumnMusicWatchNextResults.ts#L7) +[src/parser/classes/SingleColumnMusicWatchNextResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleColumnMusicWatchNextResults.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/SingleColumnMusicWatchNextResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleColumnMusicWatchNextResults.ts#L5) +[src/parser/classes/SingleColumnMusicWatchNextResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleColumnMusicWatchNextResults.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SingleHeroImage.md b/docs/api/namespaces/YTNodes/classes/SingleHeroImage.md index 722e526a..284976d4 100644 --- a/docs/api/namespaces/YTNodes/classes/SingleHeroImage.md +++ b/docs/api/namespaces/YTNodes/classes/SingleHeroImage.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SingleHeroImage.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleHeroImage.ts#L11) +[src/parser/classes/SingleHeroImage.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleHeroImage.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SingleHeroImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleHeroImage.ts#L9) +[src/parser/classes/SingleHeroImage.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleHeroImage.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SingleHeroImage.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleHeroImage.ts#L8) +[src/parser/classes/SingleHeroImage.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleHeroImage.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SingleHeroImage.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SingleHeroImage.ts#L6) +[src/parser/classes/SingleHeroImage.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SingleHeroImage.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SlimOwner.md b/docs/api/namespaces/YTNodes/classes/SlimOwner.md index 4390aadb..5aef2bed 100644 --- a/docs/api/namespaces/YTNodes/classes/SlimOwner.md +++ b/docs/api/namespaces/YTNodes/classes/SlimOwner.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SlimOwner.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimOwner.ts#L16) +[src/parser/classes/SlimOwner.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimOwner.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SlimOwner.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimOwner.ts#L13) +[src/parser/classes/SlimOwner.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimOwner.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SlimOwner.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimOwner.ts#L14) +[src/parser/classes/SlimOwner.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimOwner.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SlimOwner.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimOwner.ts#L11) +[src/parser/classes/SlimOwner.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimOwner.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SlimOwner.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimOwner.ts#L12) +[src/parser/classes/SlimOwner.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimOwner.ts#L12) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/SlimOwner.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimOwner.ts#L9) +[src/parser/classes/SlimOwner.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimOwner.ts#L9) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md b/docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md index 72e3c01e..959fe598 100644 --- a/docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md +++ b/docs/api/namespaces/YTNodes/classes/SlimVideoMetadata.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L16) +[src/parser/classes/SlimVideoMetadata.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L9) +[src/parser/classes/SlimVideoMetadata.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L14) +[src/parser/classes/SlimVideoMetadata.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L12) +[src/parser/classes/SlimVideoMetadata.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L10) +[src/parser/classes/SlimVideoMetadata.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L11) +[src/parser/classes/SlimVideoMetadata.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L11) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L8) +[src/parser/classes/SlimVideoMetadata.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L8) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L13) +[src/parser/classes/SlimVideoMetadata.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L13) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/SlimVideoMetadata.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SlimVideoMetadata.ts#L6) +[src/parser/classes/SlimVideoMetadata.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SlimVideoMetadata.ts#L6) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SortFilterHeader.md b/docs/api/namespaces/YTNodes/classes/SortFilterHeader.md index 1810e36f..22bb1eb6 100644 --- a/docs/api/namespaces/YTNodes/classes/SortFilterHeader.md +++ b/docs/api/namespaces/YTNodes/classes/SortFilterHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SortFilterHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterHeader.ts#L9) +[src/parser/classes/SortFilterHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterHeader.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SortFilterHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterHeader.ts#L7) +[src/parser/classes/SortFilterHeader.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterHeader.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/SortFilterHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterHeader.ts#L5) +[src/parser/classes/SortFilterHeader.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterHeader.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md b/docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md index a81e66fe..501e0952 100644 --- a/docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md +++ b/docs/api/namespaces/YTNodes/classes/SortFilterSubMenu.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SortFilterSubMenu.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterSubMenu.ts#L21) +[src/parser/classes/SortFilterSubMenu.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterSubMenu.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SortFilterSubMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterSubMenu.ts#L9) +[src/parser/classes/SortFilterSubMenu.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterSubMenu.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SortFilterSubMenu.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterSubMenu.ts#L10) +[src/parser/classes/SortFilterSubMenu.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterSubMenu.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SortFilterSubMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterSubMenu.ts#L13) +[src/parser/classes/SortFilterSubMenu.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterSubMenu.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SortFilterSubMenu.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterSubMenu.ts#L8) +[src/parser/classes/SortFilterSubMenu.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterSubMenu.ts#L8) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/SortFilterSubMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterSubMenu.ts#L11) +[src/parser/classes/SortFilterSubMenu.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterSubMenu.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/SortFilterSubMenu.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SortFilterSubMenu.ts#L6) +[src/parser/classes/SortFilterSubMenu.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SortFilterSubMenu.ts#L6) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md b/docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md index 174b5d1e..8479866d 100644 --- a/docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md +++ b/docs/api/namespaces/YTNodes/classes/SponsorCommentBadge.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/comments/SponsorCommentBadge.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/SponsorCommentBadge.ts#L11) +[src/parser/classes/comments/SponsorCommentBadge.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/SponsorCommentBadge.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/comments/SponsorCommentBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/SponsorCommentBadge.ts#L8) +[src/parser/classes/comments/SponsorCommentBadge.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/SponsorCommentBadge.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/comments/SponsorCommentBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/SponsorCommentBadge.ts#L9) +[src/parser/classes/comments/SponsorCommentBadge.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/SponsorCommentBadge.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/comments/SponsorCommentBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/comments/SponsorCommentBadge.ts#L6) +[src/parser/classes/comments/SponsorCommentBadge.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/comments/SponsorCommentBadge.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/StartAt.md b/docs/api/namespaces/YTNodes/classes/StartAt.md new file mode 100644 index 00000000..08634fb0 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/StartAt.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / StartAt + +# Class: StartAt + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new StartAt() + +> **new StartAt**(`data`): [`StartAt`](StartAt.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`StartAt`](StartAt.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/StartAt.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StartAt.ts#L10) + +## Properties + +### start\_at\_option\_label + +> **start\_at\_option\_label**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/StartAt.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StartAt.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'StartAt'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/StartAt.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StartAt.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is StartAt & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is StartAt & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/StatRow.md b/docs/api/namespaces/YTNodes/classes/StatRow.md index e17a916b..b646c408 100644 --- a/docs/api/namespaces/YTNodes/classes/StatRow.md +++ b/docs/api/namespaces/YTNodes/classes/StatRow.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/analytics/StatRow.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/StatRow.ts#L11) +[src/parser/classes/analytics/StatRow.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/StatRow.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/analytics/StatRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/StatRow.ts#L9) +[src/parser/classes/analytics/StatRow.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/StatRow.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/analytics/StatRow.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/StatRow.ts#L8) +[src/parser/classes/analytics/StatRow.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/StatRow.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/analytics/StatRow.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/analytics/StatRow.ts#L6) +[src/parser/classes/analytics/StatRow.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/analytics/StatRow.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/StructuredDescriptionContent.md b/docs/api/namespaces/YTNodes/classes/StructuredDescriptionContent.md index afb361a9..639ed7f0 100644 --- a/docs/api/namespaces/YTNodes/classes/StructuredDescriptionContent.md +++ b/docs/api/namespaces/YTNodes/classes/StructuredDescriptionContent.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionContent.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionContent.ts#L22) +[src/parser/classes/StructuredDescriptionContent.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionContent.ts#L22) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionContent.ts#L16) +[src/parser/classes/StructuredDescriptionContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionContent.ts#L16) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionContent.ts#L14) +[src/parser/classes/StructuredDescriptionContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionContent.ts#L14) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md b/docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md index 29396ce8..4b34fc5e 100644 --- a/docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md +++ b/docs/api/namespaces/YTNodes/classes/StructuredDescriptionPlaylistLockup.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L21) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L16) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L16) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L14) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L18) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L18) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L17) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L17) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L19) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L19) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L12) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L12) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L10) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L10) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L15) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L15) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L11) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L11) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -140,7 +140,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L13) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L13) *** @@ -154,7 +154,7 @@ #### Defined in -[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L8) +[src/parser/classes/StructuredDescriptionPlaylistLockup.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/StructuredDescriptionPlaylistLockup.ts#L8) ## Methods @@ -174,17 +174,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -218,7 +226,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -252,7 +260,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -290,4 +298,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SubFeedOption.md b/docs/api/namespaces/YTNodes/classes/SubFeedOption.md index 5327f682..c301592f 100644 --- a/docs/api/namespaces/YTNodes/classes/SubFeedOption.md +++ b/docs/api/namespaces/YTNodes/classes/SubFeedOption.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SubFeedOption.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedOption.ts#L13) +[src/parser/classes/SubFeedOption.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedOption.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SubFeedOption.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedOption.ts#L11) +[src/parser/classes/SubFeedOption.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedOption.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SubFeedOption.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedOption.ts#L10) +[src/parser/classes/SubFeedOption.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedOption.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/SubFeedOption.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedOption.ts#L9) +[src/parser/classes/SubFeedOption.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedOption.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/SubFeedOption.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedOption.ts#L7) +[src/parser/classes/SubFeedOption.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedOption.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SubFeedSelector.md b/docs/api/namespaces/YTNodes/classes/SubFeedSelector.md index d635eae1..ce63b44a 100644 --- a/docs/api/namespaces/YTNodes/classes/SubFeedSelector.md +++ b/docs/api/namespaces/YTNodes/classes/SubFeedSelector.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SubFeedSelector.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedSelector.ts#L12) +[src/parser/classes/SubFeedSelector.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedSelector.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SubFeedSelector.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedSelector.ts#L10) +[src/parser/classes/SubFeedSelector.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedSelector.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/SubFeedSelector.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedSelector.ts#L9) +[src/parser/classes/SubFeedSelector.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedSelector.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/SubFeedSelector.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubFeedSelector.ts#L7) +[src/parser/classes/SubFeedSelector.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubFeedSelector.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SubscribeButton.md b/docs/api/namespaces/YTNodes/classes/SubscribeButton.md index ec3fcbac..775c38f0 100644 --- a/docs/api/namespaces/YTNodes/classes/SubscribeButton.md +++ b/docs/api/namespaces/YTNodes/classes/SubscribeButton.md @@ -26,17 +26,27 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L21) +[src/parser/classes/SubscribeButton.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L27) ## 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/fc5571629eca037af7de03f4b903da6add1f300b/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/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L14) +[src/parser/classes/SubscribeButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L14) *** @@ -46,17 +56,7 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L12) - -*** - -### endpoint - -> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md) - -#### Defined in - -[src/parser/classes/SubscribeButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L19) +[src/parser/classes/SubscribeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L13) +[src/parser/classes/SubscribeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L13) *** @@ -76,7 +76,37 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L18) +[src/parser/classes/SubscribeButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L18) + +*** + +### on\_subscribe\_endpoints? + +> `optional` **on\_subscribe\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] + +#### Defined in + +[src/parser/classes/SubscribeButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L20) + +*** + +### on\_unsubscribe\_endpoints? + +> `optional` **on\_unsubscribe\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] + +#### Defined in + +[src/parser/classes/SubscribeButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L21) + +*** + +### service\_endpoints? + +> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[] + +#### Defined in + +[src/parser/classes/SubscribeButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L19) *** @@ -86,7 +116,17 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L15) +[src/parser/classes/SubscribeButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L15) + +*** + +### subscribe\_accessibility\_label? + +> `optional` **subscribe\_accessibility\_label**: `string` + +#### Defined in + +[src/parser/classes/SubscribeButton.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L24) *** @@ -96,7 +136,17 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L11) +[src/parser/classes/SubscribeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L11) + +*** + +### subscribed\_entity\_key? + +> `optional` **subscribed\_entity\_key**: `string` + +#### Defined in + +[src/parser/classes/SubscribeButton.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L22) *** @@ -106,17 +156,17 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L16) +[src/parser/classes/SubscribeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L16) *** -### title +### target\_id? -> **title**: [`Text`](../../Misc/classes/Text.md) +> `optional` **target\_id**: `string` #### Defined in -[src/parser/classes/SubscribeButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L10) +[src/parser/classes/SubscribeButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L23) *** @@ -130,7 +180,17 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### unsubscribe\_accessibility\_label? + +> `optional` **unsubscribe\_accessibility\_label**: `string` + +#### Defined in + +[src/parser/classes/SubscribeButton.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L25) *** @@ -140,7 +200,7 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L17) +[src/parser/classes/SubscribeButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L17) *** @@ -154,7 +214,7 @@ #### Defined in -[src/parser/classes/SubscribeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L8) +[src/parser/classes/SubscribeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L8) ## Methods @@ -174,17 +234,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -218,7 +286,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -252,7 +320,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -290,4 +358,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SubscribeEndpoint.md b/docs/api/namespaces/YTNodes/classes/SubscribeEndpoint.md new file mode 100644 index 00000000..033db034 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/SubscribeEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SubscribeEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SubscribeEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SubscribeEndpoint.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/SubscribeEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/SubscribeEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md b/docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md index 9e09d029..e3116b80 100644 --- a/docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md +++ b/docs/api/namespaces/YTNodes/classes/SubscriptionNotificationToggleButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/SubscriptionNotificationToggleButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscriptionNotificationToggleButton.ts#L16) +[src/parser/classes/SubscriptionNotificationToggleButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscriptionNotificationToggleButton.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/SubscriptionNotificationToggleButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscriptionNotificationToggleButton.ts#L13) +[src/parser/classes/SubscriptionNotificationToggleButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscriptionNotificationToggleButton.ts#L13) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/classes/SubscriptionNotificationToggleButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscriptionNotificationToggleButton.ts#L7) +[src/parser/classes/SubscriptionNotificationToggleButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscriptionNotificationToggleButton.ts#L7) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/SubscriptionNotificationToggleButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscriptionNotificationToggleButton.ts#L14) +[src/parser/classes/SubscriptionNotificationToggleButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscriptionNotificationToggleButton.ts#L14) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/SubscriptionNotificationToggleButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscriptionNotificationToggleButton.ts#L5) +[src/parser/classes/SubscriptionNotificationToggleButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscriptionNotificationToggleButton.ts#L5) ## Methods @@ -116,17 +116,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -160,7 +168,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -194,7 +202,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -232,4 +240,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Tab.md b/docs/api/namespaces/YTNodes/classes/Tab.md index 1cf74620..f9b300ba 100644 --- a/docs/api/namespaces/YTNodes/classes/Tab.md +++ b/docs/api/namespaces/YTNodes/classes/Tab.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Tab.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tab.ts#L16) +[src/parser/classes/Tab.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tab.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Tab.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tab.ts#L14) +[src/parser/classes/Tab.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tab.ts#L14) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Tab.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tab.ts#L13) +[src/parser/classes/Tab.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tab.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Tab.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tab.ts#L12) +[src/parser/classes/Tab.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tab.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/Tab.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tab.ts#L11) +[src/parser/classes/Tab.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tab.ts#L11) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/Tab.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tab.ts#L9) +[src/parser/classes/Tab.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tab.ts#L9) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Tabbed.md b/docs/api/namespaces/YTNodes/classes/Tabbed.md index 449cf006..32e73c0f 100644 --- a/docs/api/namespaces/YTNodes/classes/Tabbed.md +++ b/docs/api/namespaces/YTNodes/classes/Tabbed.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Tabbed.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tabbed.ts#L9) +[src/parser/classes/Tabbed.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tabbed.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Tabbed.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tabbed.ts#L7) +[src/parser/classes/Tabbed.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tabbed.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/Tabbed.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tabbed.ts#L5) +[src/parser/classes/Tabbed.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tabbed.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TabbedSearchResults.md b/docs/api/namespaces/YTNodes/classes/TabbedSearchResults.md index 299f5a6e..eb9a10d6 100644 --- a/docs/api/namespaces/YTNodes/classes/TabbedSearchResults.md +++ b/docs/api/namespaces/YTNodes/classes/TabbedSearchResults.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TabbedSearchResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TabbedSearchResults.ts#L10) +[src/parser/classes/TabbedSearchResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TabbedSearchResults.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TabbedSearchResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TabbedSearchResults.ts#L8) +[src/parser/classes/TabbedSearchResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TabbedSearchResults.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/TabbedSearchResults.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TabbedSearchResults.ts#L6) +[src/parser/classes/TabbedSearchResults.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TabbedSearchResults.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TextFieldView.md b/docs/api/namespaces/YTNodes/classes/TextFieldView.md new file mode 100644 index 00000000..4be15fe2 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/TextFieldView.md @@ -0,0 +1,241 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TextHeader.md b/docs/api/namespaces/YTNodes/classes/TextHeader.md index 0a2a80c5..981a812c 100644 --- a/docs/api/namespaces/YTNodes/classes/TextHeader.md +++ b/docs/api/namespaces/YTNodes/classes/TextHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TextHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TextHeader.ts#L11) +[src/parser/classes/TextHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TextHeader.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TextHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TextHeader.ts#L9) +[src/parser/classes/TextHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TextHeader.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TextHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TextHeader.ts#L8) +[src/parser/classes/TextHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TextHeader.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/TextHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TextHeader.ts#L6) +[src/parser/classes/TextHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TextHeader.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThirdPartyShareTargetSection.md b/docs/api/namespaces/YTNodes/classes/ThirdPartyShareTargetSection.md new file mode 100644 index 00000000..6169a23f --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ThirdPartyShareTargetSection.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThirdPartyShareTargetSection + +# Class: ThirdPartyShareTargetSection + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new ThirdPartyShareTargetSection() + +> **new ThirdPartyShareTargetSection**(`data`): [`ThirdPartyShareTargetSection`](ThirdPartyShareTargetSection.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`ThirdPartyShareTargetSection`](ThirdPartyShareTargetSection.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/ThirdPartyShareTargetSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThirdPartyShareTargetSection.ts#L10) + +## Properties + +### share\_targets + +> **share\_targets**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ShareTarget`](ShareTarget.md)\> + +#### Defined in + +[src/parser/classes/ThirdPartyShareTargetSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThirdPartyShareTargetSection.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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'ThirdPartyShareTargetSection'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/ThirdPartyShareTargetSection.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThirdPartyShareTargetSection.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is ThirdPartyShareTargetSection & { [k in string]: R }` + +Check for a key without asserting the type. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +`this is ThirdPartyShareTargetSection & { [k in string]: R }` + +Whether the node has the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey) + +#### Defined in + +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md index 1d9da97e..27256787 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailBadgeView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailBadgeView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailBadgeView.ts#L15) +[src/parser/classes/ThumbnailBadgeView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailBadgeView.ts#L15) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/ThumbnailBadgeView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailBadgeView.ts#L10) +[src/parser/classes/ThumbnailBadgeView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailBadgeView.ts#L10) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/ThumbnailBadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailBadgeView.ts#L9) +[src/parser/classes/ThumbnailBadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailBadgeView.ts#L9) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailBadgeView.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailBadgeView.ts#L7) +[src/parser/classes/ThumbnailBadgeView.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailBadgeView.ts#L7) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailBadgeView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailBadgeView.ts#L8) +[src/parser/classes/ThumbnailBadgeView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailBadgeView.ts#L8) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/ThumbnailBadgeView.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailBadgeView.ts#L5) +[src/parser/classes/ThumbnailBadgeView.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailBadgeView.ts#L5) ## Methods @@ -122,17 +122,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -166,7 +174,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -200,7 +208,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -238,4 +246,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md index c95fa7f2..547cb217 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailHoverOverlayView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailHoverOverlayView.ts#L12) +[src/parser/classes/ThumbnailHoverOverlayView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailHoverOverlayView.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailHoverOverlayView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailHoverOverlayView.ts#L8) +[src/parser/classes/ThumbnailHoverOverlayView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailHoverOverlayView.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailHoverOverlayView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailHoverOverlayView.ts#L10) +[src/parser/classes/ThumbnailHoverOverlayView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailHoverOverlayView.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ThumbnailHoverOverlayView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailHoverOverlayView.ts#L9) +[src/parser/classes/ThumbnailHoverOverlayView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailHoverOverlayView.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ThumbnailHoverOverlayView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailHoverOverlayView.ts#L6) +[src/parser/classes/ThumbnailHoverOverlayView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailHoverOverlayView.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md b/docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md index 8d4005d4..0e5d1d98 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailLandscapePortrait.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailLandscapePortrait.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailLandscapePortrait.ts#L11) +[src/parser/classes/ThumbnailLandscapePortrait.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailLandscapePortrait.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailLandscapePortrait.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailLandscapePortrait.ts#L8) +[src/parser/classes/ThumbnailLandscapePortrait.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailLandscapePortrait.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailLandscapePortrait.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailLandscapePortrait.ts#L9) +[src/parser/classes/ThumbnailLandscapePortrait.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailLandscapePortrait.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailLandscapePortrait.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailLandscapePortrait.ts#L6) +[src/parser/classes/ThumbnailLandscapePortrait.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailLandscapePortrait.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md index 8945f1d6..6f87ada0 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBadgeView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBadgeView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBadgeView.ts#L11) +[src/parser/classes/ThumbnailOverlayBadgeView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBadgeView.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBadgeView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBadgeView.ts#L8) +[src/parser/classes/ThumbnailOverlayBadgeView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBadgeView.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBadgeView.ts#L9) +[src/parser/classes/ThumbnailOverlayBadgeView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBadgeView.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBadgeView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBadgeView.ts#L6) +[src/parser/classes/ThumbnailOverlayBadgeView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBadgeView.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md index 9777b070..aaa55a33 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayBottomPanel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L11) +[src/parser/classes/ThumbnailOverlayBottomPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L9) +[src/parser/classes/ThumbnailOverlayBottomPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L8) +[src/parser/classes/ThumbnailOverlayBottomPanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayBottomPanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L6) +[src/parser/classes/ThumbnailOverlayBottomPanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayBottomPanel.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md index dc08661e..44881cfb 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayEndorsement.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayEndorsement.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayEndorsement.ts#L10) +[src/parser/classes/ThumbnailOverlayEndorsement.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayEndorsement.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayEndorsement.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayEndorsement.ts#L8) +[src/parser/classes/ThumbnailOverlayEndorsement.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayEndorsement.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayEndorsement.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayEndorsement.ts#L6) +[src/parser/classes/ThumbnailOverlayEndorsement.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayEndorsement.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md index 9ffbb60f..3dbf219e 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayHoverText.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayHoverText.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayHoverText.ts#L11) +[src/parser/classes/ThumbnailOverlayHoverText.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayHoverText.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayHoverText.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayHoverText.ts#L9) +[src/parser/classes/ThumbnailOverlayHoverText.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayHoverText.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayHoverText.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayHoverText.ts#L8) +[src/parser/classes/ThumbnailOverlayHoverText.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayHoverText.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayHoverText.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayHoverText.ts#L6) +[src/parser/classes/ThumbnailOverlayHoverText.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayHoverText.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md index d0a1004a..d5f5836c 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayInlineUnplayable.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L11) +[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L9) +[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L8) +[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L6) +[src/parser/classes/ThumbnailOverlayInlineUnplayable.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayInlineUnplayable.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md index 153dbee7..974e8d94 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayLoadingPreview.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L10) +[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L8) +[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L6) +[src/parser/classes/ThumbnailOverlayLoadingPreview.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayLoadingPreview.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md index 43961619..6dba111a 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayNowPlaying.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayNowPlaying.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L10) +[src/parser/classes/ThumbnailOverlayNowPlaying.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayNowPlaying.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L8) +[src/parser/classes/ThumbnailOverlayNowPlaying.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayNowPlaying.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L6) +[src/parser/classes/ThumbnailOverlayNowPlaying.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayNowPlaying.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPinking.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPinking.md index 528a439a..51261cd5 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPinking.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPinking.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayPinking.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayPinking.ts#L9) +[src/parser/classes/ThumbnailOverlayPinking.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayPinking.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayPinking.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayPinking.ts#L7) +[src/parser/classes/ThumbnailOverlayPinking.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayPinking.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayPinking.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayPinking.ts#L5) +[src/parser/classes/ThumbnailOverlayPinking.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayPinking.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md index fc83b9b0..8b0e13ae 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayPlaybackStatus.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L10) +[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L8) +[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L6) +[src/parser/classes/ThumbnailOverlayPlaybackStatus.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayPlaybackStatus.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayResumePlayback.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayResumePlayback.md index 1f8d4f0a..06fbdd87 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayResumePlayback.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayResumePlayback.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayResumePlayback.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayResumePlayback.ts#L9) +[src/parser/classes/ThumbnailOverlayResumePlayback.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayResumePlayback.ts#L9) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayResumePlayback.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayResumePlayback.ts#L7) +[src/parser/classes/ThumbnailOverlayResumePlayback.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayResumePlayback.ts#L7) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayResumePlayback.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayResumePlayback.ts#L5) +[src/parser/classes/ThumbnailOverlayResumePlayback.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayResumePlayback.ts#L5) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md index 52633b89..da968b10 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlaySidePanel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlaySidePanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlaySidePanel.ts#L11) +[src/parser/classes/ThumbnailOverlaySidePanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlaySidePanel.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlaySidePanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlaySidePanel.ts#L9) +[src/parser/classes/ThumbnailOverlaySidePanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlaySidePanel.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlaySidePanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlaySidePanel.ts#L8) +[src/parser/classes/ThumbnailOverlaySidePanel.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlaySidePanel.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlaySidePanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlaySidePanel.ts#L6) +[src/parser/classes/ThumbnailOverlaySidePanel.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlaySidePanel.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md index 1ca84c68..b3d5ff7a 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayTimeStatus.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L11) +[src/parser/classes/ThumbnailOverlayTimeStatus.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L9) +[src/parser/classes/ThumbnailOverlayTimeStatus.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L8) +[src/parser/classes/ThumbnailOverlayTimeStatus.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayTimeStatus.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L6) +[src/parser/classes/ThumbnailOverlayTimeStatus.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayTimeStatus.ts#L6) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md index 8820b826..70dc71c4 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayToggleButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayToggleButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayToggleButton.ts#L23) +[src/parser/classes/ThumbnailOverlayToggleButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayToggleButton.ts#L23) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayToggleButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayToggleButton.ts#L10) +[src/parser/classes/ThumbnailOverlayToggleButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayToggleButton.ts#L10) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayToggleButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayToggleButton.ts#L8) +[src/parser/classes/ThumbnailOverlayToggleButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayToggleButton.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayToggleButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayToggleButton.ts#L20) +[src/parser/classes/ThumbnailOverlayToggleButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayToggleButton.ts#L20) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayToggleButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayToggleButton.ts#L15) +[src/parser/classes/ThumbnailOverlayToggleButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayToggleButton.ts#L15) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayToggleButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayToggleButton.ts#L21) +[src/parser/classes/ThumbnailOverlayToggleButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayToggleButton.ts#L21) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/ThumbnailOverlayToggleButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailOverlayToggleButton.ts#L6) +[src/parser/classes/ThumbnailOverlayToggleButton.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailOverlayToggleButton.ts#L6) ## Methods @@ -140,17 +140,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -184,7 +192,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -218,7 +226,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -256,4 +264,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailView.md index a448c62d..bef93bb7 100644 --- a/docs/api/namespaces/YTNodes/classes/ThumbnailView.md +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ThumbnailView.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailView.ts#L17) +[src/parser/classes/ThumbnailView.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailView.ts#L17) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/ThumbnailView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailView.ts#L12) +[src/parser/classes/ThumbnailView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailView.ts#L12) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/ThumbnailView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailView.ts#L10) +[src/parser/classes/ThumbnailView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailView.ts#L10) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/ThumbnailView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailView.ts#L11) +[src/parser/classes/ThumbnailView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailView.ts#L11) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/ThumbnailView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ThumbnailView.ts#L8) +[src/parser/classes/ThumbnailView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ThumbnailView.ts#L8) ## Methods @@ -112,17 +112,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -156,7 +164,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -190,7 +198,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -228,4 +236,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md b/docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md index fb89d4aa..9c0db76f 100644 --- a/docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md +++ b/docs/api/namespaces/YTNodes/classes/TimedMarkerDecoration.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TimedMarkerDecoration.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TimedMarkerDecoration.ts#L14) +[src/parser/classes/TimedMarkerDecoration.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TimedMarkerDecoration.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TimedMarkerDecoration.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TimedMarkerDecoration.ts#L10) +[src/parser/classes/TimedMarkerDecoration.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TimedMarkerDecoration.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TimedMarkerDecoration.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TimedMarkerDecoration.ts#L12) +[src/parser/classes/TimedMarkerDecoration.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TimedMarkerDecoration.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/TimedMarkerDecoration.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TimedMarkerDecoration.ts#L11) +[src/parser/classes/TimedMarkerDecoration.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TimedMarkerDecoration.ts#L11) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/TimedMarkerDecoration.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TimedMarkerDecoration.ts#L9) +[src/parser/classes/TimedMarkerDecoration.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TimedMarkerDecoration.ts#L9) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/TimedMarkerDecoration.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TimedMarkerDecoration.ts#L8) +[src/parser/classes/TimedMarkerDecoration.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TimedMarkerDecoration.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/TimedMarkerDecoration.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TimedMarkerDecoration.ts#L6) +[src/parser/classes/TimedMarkerDecoration.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TimedMarkerDecoration.ts#L6) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TitleAndButtonListHeader.md b/docs/api/namespaces/YTNodes/classes/TitleAndButtonListHeader.md index c7ce4756..580c7bd5 100644 --- a/docs/api/namespaces/YTNodes/classes/TitleAndButtonListHeader.md +++ b/docs/api/namespaces/YTNodes/classes/TitleAndButtonListHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TitleAndButtonListHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TitleAndButtonListHeader.ts#L10) +[src/parser/classes/TitleAndButtonListHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TitleAndButtonListHeader.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TitleAndButtonListHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TitleAndButtonListHeader.ts#L8) +[src/parser/classes/TitleAndButtonListHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TitleAndButtonListHeader.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/TitleAndButtonListHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TitleAndButtonListHeader.ts#L6) +[src/parser/classes/TitleAndButtonListHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TitleAndButtonListHeader.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ToggleButton.md b/docs/api/namespaces/YTNodes/classes/ToggleButton.md index bf7745b9..4d22896b 100644 --- a/docs/api/namespaces/YTNodes/classes/ToggleButton.md +++ b/docs/api/namespaces/YTNodes/classes/ToggleButton.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L23) +[src/parser/classes/ToggleButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L23) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L20) +[src/parser/classes/ToggleButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L20) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L18) +[src/parser/classes/ToggleButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L18) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L15) +[src/parser/classes/ToggleButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L14) +[src/parser/classes/ToggleButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L13) +[src/parser/classes/ToggleButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L13) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L16) +[src/parser/classes/ToggleButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L16) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L17) +[src/parser/classes/ToggleButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L17) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L21) +[src/parser/classes/ToggleButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L21) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L9) +[src/parser/classes/ToggleButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L9) *** @@ -126,7 +126,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L19) +[src/parser/classes/ToggleButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L19) *** @@ -136,7 +136,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L10) +[src/parser/classes/ToggleButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L10) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L12) +[src/parser/classes/ToggleButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L12) *** @@ -156,7 +156,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L11) +[src/parser/classes/ToggleButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L11) *** @@ -170,7 +170,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -184,7 +184,7 @@ #### Defined in -[src/parser/classes/ToggleButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButton.ts#L7) +[src/parser/classes/ToggleButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButton.ts#L7) ## Methods @@ -204,17 +204,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -248,7 +256,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -282,7 +290,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -320,4 +328,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ToggleButtonView.md b/docs/api/namespaces/YTNodes/classes/ToggleButtonView.md index 53830931..b5eb3f59 100644 --- a/docs/api/namespaces/YTNodes/classes/ToggleButtonView.md +++ b/docs/api/namespaces/YTNodes/classes/ToggleButtonView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ToggleButtonView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButtonView.ts#L13) +[src/parser/classes/ToggleButtonView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButtonView.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ToggleButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButtonView.ts#L8) +[src/parser/classes/ToggleButtonView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButtonView.ts#L8) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ToggleButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButtonView.ts#L10) +[src/parser/classes/ToggleButtonView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButtonView.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ToggleButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButtonView.ts#L11) +[src/parser/classes/ToggleButtonView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButtonView.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ToggleButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButtonView.ts#L9) +[src/parser/classes/ToggleButtonView.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButtonView.ts#L9) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/ToggleButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleButtonView.ts#L6) +[src/parser/classes/ToggleButtonView.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleButtonView.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md b/docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md index c4c638aa..287c2d8f 100644 --- a/docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md +++ b/docs/api/namespaces/YTNodes/classes/ToggleMenuServiceItem.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L16) +[src/parser/classes/ToggleMenuServiceItem.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L13) +[src/parser/classes/ToggleMenuServiceItem.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L11) +[src/parser/classes/ToggleMenuServiceItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L9) +[src/parser/classes/ToggleMenuServiceItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L9) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L14) +[src/parser/classes/ToggleMenuServiceItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L14) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L12) +[src/parser/classes/ToggleMenuServiceItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L10) +[src/parser/classes/ToggleMenuServiceItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L10) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/ToggleMenuServiceItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ToggleMenuServiceItem.ts#L7) +[src/parser/classes/ToggleMenuServiceItem.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ToggleMenuServiceItem.ts#L7) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Tooltip.md b/docs/api/namespaces/YTNodes/classes/Tooltip.md index a4b7a1f1..7e28d8a3 100644 --- a/docs/api/namespaces/YTNodes/classes/Tooltip.md +++ b/docs/api/namespaces/YTNodes/classes/Tooltip.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L22) +[src/parser/classes/Tooltip.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L22) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L17) +[src/parser/classes/Tooltip.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L17) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L19) +[src/parser/classes/Tooltip.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L19) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L20) +[src/parser/classes/Tooltip.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L20) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L9) +[src/parser/classes/Tooltip.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L9) *** @@ -92,7 +92,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L18) +[src/parser/classes/Tooltip.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L18) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L16) +[src/parser/classes/Tooltip.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L16) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/classes/Tooltip.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Tooltip.ts#L7) +[src/parser/classes/Tooltip.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Tooltip.ts#L7) ## Methods @@ -150,17 +150,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -194,7 +202,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -228,7 +236,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -266,4 +274,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md b/docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md index ed83d366..5a976930 100644 --- a/docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md +++ b/docs/api/namespaces/YTNodes/classes/TopicChannelDetails.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TopicChannelDetails.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TopicChannelDetails.ts#L17) +[src/parser/classes/TopicChannelDetails.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TopicChannelDetails.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TopicChannelDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TopicChannelDetails.ts#L12) +[src/parser/classes/TopicChannelDetails.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TopicChannelDetails.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TopicChannelDetails.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TopicChannelDetails.ts#L15) +[src/parser/classes/TopicChannelDetails.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TopicChannelDetails.ts#L15) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/TopicChannelDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TopicChannelDetails.ts#L14) +[src/parser/classes/TopicChannelDetails.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TopicChannelDetails.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/TopicChannelDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TopicChannelDetails.ts#L13) +[src/parser/classes/TopicChannelDetails.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TopicChannelDetails.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/TopicChannelDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TopicChannelDetails.ts#L11) +[src/parser/classes/TopicChannelDetails.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TopicChannelDetails.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/TopicChannelDetails.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TopicChannelDetails.ts#L9) +[src/parser/classes/TopicChannelDetails.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TopicChannelDetails.ts#L9) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Transcript.md b/docs/api/namespaces/YTNodes/classes/Transcript.md index d75c6a53..77f4a045 100644 --- a/docs/api/namespaces/YTNodes/classes/Transcript.md +++ b/docs/api/namespaces/YTNodes/classes/Transcript.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/Transcript.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Transcript.ts#L11) +[src/parser/classes/Transcript.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Transcript.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/Transcript.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Transcript.ts#L9) +[src/parser/classes/Transcript.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Transcript.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/Transcript.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Transcript.ts#L7) +[src/parser/classes/Transcript.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Transcript.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptFooter.md b/docs/api/namespaces/YTNodes/classes/TranscriptFooter.md index 352152f8..e0e50531 100644 --- a/docs/api/namespaces/YTNodes/classes/TranscriptFooter.md +++ b/docs/api/namespaces/YTNodes/classes/TranscriptFooter.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TranscriptFooter.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptFooter.ts#L11) +[src/parser/classes/TranscriptFooter.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptFooter.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TranscriptFooter.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptFooter.ts#L9) +[src/parser/classes/TranscriptFooter.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptFooter.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/TranscriptFooter.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptFooter.ts#L7) +[src/parser/classes/TranscriptFooter.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptFooter.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md b/docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md index d0a7a342..76932c85 100644 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md +++ b/docs/api/namespaces/YTNodes/classes/TranscriptSearchBox.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchBox.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchBox.ts#L16) +[src/parser/classes/TranscriptSearchBox.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchBox.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchBox.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchBox.ts#L12) +[src/parser/classes/TranscriptSearchBox.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchBox.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchBox.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchBox.ts#L13) +[src/parser/classes/TranscriptSearchBox.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchBox.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchBox.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchBox.ts#L11) +[src/parser/classes/TranscriptSearchBox.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchBox.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchBox.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchBox.ts#L14) +[src/parser/classes/TranscriptSearchBox.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchBox.ts#L14) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchBox.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchBox.ts#L9) +[src/parser/classes/TranscriptSearchBox.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchBox.ts#L9) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md b/docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md index 29eab95c..576ba8b6 100644 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md +++ b/docs/api/namespaces/YTNodes/classes/TranscriptSearchPanel.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchPanel.ts#L16) +[src/parser/classes/TranscriptSearchPanel.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchPanel.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchPanel.ts#L12) +[src/parser/classes/TranscriptSearchPanel.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchPanel.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchPanel.ts#L13) +[src/parser/classes/TranscriptSearchPanel.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchPanel.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchPanel.ts#L11) +[src/parser/classes/TranscriptSearchPanel.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchPanel.ts#L11) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchPanel.ts#L14) +[src/parser/classes/TranscriptSearchPanel.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchPanel.ts#L14) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/TranscriptSearchPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSearchPanel.ts#L9) +[src/parser/classes/TranscriptSearchPanel.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSearchPanel.ts#L9) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md b/docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md index c6b458f2..ef4f0498 100644 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md +++ b/docs/api/namespaces/YTNodes/classes/TranscriptSectionHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TranscriptSectionHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSectionHeader.ts#L12) +[src/parser/classes/TranscriptSectionHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSectionHeader.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TranscriptSectionHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSectionHeader.ts#L9) +[src/parser/classes/TranscriptSectionHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSectionHeader.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TranscriptSectionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSectionHeader.ts#L10) +[src/parser/classes/TranscriptSectionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSectionHeader.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/TranscriptSectionHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSectionHeader.ts#L8) +[src/parser/classes/TranscriptSectionHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSectionHeader.ts#L8) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/TranscriptSectionHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSectionHeader.ts#L6) +[src/parser/classes/TranscriptSectionHeader.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSectionHeader.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSegment.md b/docs/api/namespaces/YTNodes/classes/TranscriptSegment.md index c066ef07..bcf18c9d 100644 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSegment.md +++ b/docs/api/namespaces/YTNodes/classes/TranscriptSegment.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TranscriptSegment.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegment.ts#L14) +[src/parser/classes/TranscriptSegment.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegment.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TranscriptSegment.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegment.ts#L9) +[src/parser/classes/TranscriptSegment.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegment.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TranscriptSegment.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegment.ts#L10) +[src/parser/classes/TranscriptSegment.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegment.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/TranscriptSegment.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegment.ts#L8) +[src/parser/classes/TranscriptSegment.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegment.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/TranscriptSegment.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegment.ts#L11) +[src/parser/classes/TranscriptSegment.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegment.ts#L11) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/TranscriptSegment.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegment.ts#L12) +[src/parser/classes/TranscriptSegment.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegment.ts#L12) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/TranscriptSegment.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegment.ts#L6) +[src/parser/classes/TranscriptSegment.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegment.ts#L6) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md b/docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md index c8f799db..1a3e04be 100644 --- a/docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md +++ b/docs/api/namespaces/YTNodes/classes/TranscriptSegmentList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TranscriptSegmentList.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegmentList.ts#L17) +[src/parser/classes/TranscriptSegmentList.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegmentList.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TranscriptSegmentList.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegmentList.ts#L12) +[src/parser/classes/TranscriptSegmentList.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegmentList.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TranscriptSegmentList.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegmentList.ts#L13) +[src/parser/classes/TranscriptSegmentList.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegmentList.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/TranscriptSegmentList.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegmentList.ts#L14) +[src/parser/classes/TranscriptSegmentList.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegmentList.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/TranscriptSegmentList.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegmentList.ts#L15) +[src/parser/classes/TranscriptSegmentList.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegmentList.ts#L15) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/TranscriptSegmentList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TranscriptSegmentList.ts#L10) +[src/parser/classes/TranscriptSegmentList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TranscriptSegmentList.ts#L10) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md b/docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md index d211e0d5..09bb5788 100644 --- a/docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md +++ b/docs/api/namespaces/YTNodes/classes/TwoColumnBrowseResults.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/TwoColumnBrowseResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnBrowseResults.ts#L10) +[src/parser/classes/TwoColumnBrowseResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnBrowseResults.ts#L10) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/TwoColumnBrowseResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnBrowseResults.ts#L8) +[src/parser/classes/TwoColumnBrowseResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnBrowseResults.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/TwoColumnBrowseResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnBrowseResults.ts#L7) +[src/parser/classes/TwoColumnBrowseResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnBrowseResults.ts#L7) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/TwoColumnBrowseResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnBrowseResults.ts#L5) +[src/parser/classes/TwoColumnBrowseResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnBrowseResults.ts#L5) ## Methods @@ -98,17 +98,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -142,7 +150,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -176,7 +184,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -214,4 +222,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md b/docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md index 3f5667d6..384894a6 100644 --- a/docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md +++ b/docs/api/namespaces/YTNodes/classes/TwoColumnSearchResults.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TwoColumnSearchResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnSearchResults.ts#L10) +[src/parser/classes/TwoColumnSearchResults.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnSearchResults.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/TwoColumnSearchResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnSearchResults.ts#L7) +[src/parser/classes/TwoColumnSearchResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnSearchResults.ts#L7) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/TwoColumnSearchResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnSearchResults.ts#L8) +[src/parser/classes/TwoColumnSearchResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnSearchResults.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/TwoColumnSearchResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnSearchResults.ts#L5) +[src/parser/classes/TwoColumnSearchResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnSearchResults.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/TwoColumnWatchNextResults.md b/docs/api/namespaces/YTNodes/classes/TwoColumnWatchNextResults.md index b0608cdc..81326e0d 100644 --- a/docs/api/namespaces/YTNodes/classes/TwoColumnWatchNextResults.md +++ b/docs/api/namespaces/YTNodes/classes/TwoColumnWatchNextResults.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/TwoColumnWatchNextResults.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnWatchNextResults.ts#L34) +[src/parser/classes/TwoColumnWatchNextResults.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnWatchNextResults.ts#L34) ## Properties @@ -48,7 +48,7 @@ #### Defined in -[src/parser/classes/TwoColumnWatchNextResults.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnWatchNextResults.ts#L28) +[src/parser/classes/TwoColumnWatchNextResults.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnWatchNextResults.ts#L28) *** @@ -58,7 +58,7 @@ #### Defined in -[src/parser/classes/TwoColumnWatchNextResults.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnWatchNextResults.ts#L18) +[src/parser/classes/TwoColumnWatchNextResults.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnWatchNextResults.ts#L18) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/TwoColumnWatchNextResults.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnWatchNextResults.ts#L19) +[src/parser/classes/TwoColumnWatchNextResults.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnWatchNextResults.ts#L19) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/TwoColumnWatchNextResults.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnWatchNextResults.ts#L16) +[src/parser/classes/TwoColumnWatchNextResults.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnWatchNextResults.ts#L16) *** @@ -116,7 +116,7 @@ #### Defined in -[src/parser/classes/TwoColumnWatchNextResults.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnWatchNextResults.ts#L17) +[src/parser/classes/TwoColumnWatchNextResults.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnWatchNextResults.ts#L17) *** @@ -130,7 +130,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -144,7 +144,7 @@ #### Defined in -[src/parser/classes/TwoColumnWatchNextResults.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnWatchNextResults.ts#L14) +[src/parser/classes/TwoColumnWatchNextResults.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnWatchNextResults.ts#L14) ## Methods @@ -164,17 +164,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -208,7 +216,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -242,7 +250,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -280,4 +288,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UnifiedSharePanel.md b/docs/api/namespaces/YTNodes/classes/UnifiedSharePanel.md new file mode 100644 index 00000000..3bda46ff --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/UnifiedSharePanel.md @@ -0,0 +1,241 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md b/docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md index 5875a307..b4a3ad0c 100644 --- a/docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md +++ b/docs/api/namespaces/YTNodes/classes/UniversalWatchCard.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/UniversalWatchCard.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UniversalWatchCard.ts#L13) +[src/parser/classes/UniversalWatchCard.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UniversalWatchCard.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/UniversalWatchCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UniversalWatchCard.ts#L9) +[src/parser/classes/UniversalWatchCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UniversalWatchCard.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/UniversalWatchCard.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UniversalWatchCard.ts#L11) +[src/parser/classes/UniversalWatchCard.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UniversalWatchCard.ts#L11) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/UniversalWatchCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UniversalWatchCard.ts#L8) +[src/parser/classes/UniversalWatchCard.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UniversalWatchCard.ts#L8) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/UniversalWatchCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UniversalWatchCard.ts#L10) +[src/parser/classes/UniversalWatchCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UniversalWatchCard.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/UniversalWatchCard.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UniversalWatchCard.ts#L6) +[src/parser/classes/UniversalWatchCard.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UniversalWatchCard.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UnsubscribeEndpoint.md b/docs/api/namespaces/YTNodes/classes/UnsubscribeEndpoint.md new file mode 100644 index 00000000..8851d7b2 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/UnsubscribeEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/UnsubscribeEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/UnsubscribeEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/UnsubscribeEndpoint.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/UnsubscribeEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/UnsubscribeEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md b/docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md index a8a04f5a..3521295b 100644 --- a/docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md +++ b/docs/api/namespaces/YTNodes/classes/UpdateDateTextAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateDateTextAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateDateTextAction.ts#L10) +[src/parser/classes/livechat/UpdateDateTextAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateDateTextAction.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateDateTextAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateDateTextAction.ts#L8) +[src/parser/classes/livechat/UpdateDateTextAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateDateTextAction.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateDateTextAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateDateTextAction.ts#L6) +[src/parser/classes/livechat/UpdateDateTextAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateDateTextAction.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md b/docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md index e4b9c586..45c6a030 100644 --- a/docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md +++ b/docs/api/namespaces/YTNodes/classes/UpdateDescriptionAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateDescriptionAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateDescriptionAction.ts#L10) +[src/parser/classes/livechat/UpdateDescriptionAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateDescriptionAction.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateDescriptionAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateDescriptionAction.ts#L8) +[src/parser/classes/livechat/UpdateDescriptionAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateDescriptionAction.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateDescriptionAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateDescriptionAction.ts#L6) +[src/parser/classes/livechat/UpdateDescriptionAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateDescriptionAction.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md b/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md index 68971a9e..642d69c8 100644 --- a/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md +++ b/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L12) +[src/parser/classes/actions/UpdateEngagementPanelAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L10) +[src/parser/classes/actions/UpdateEngagementPanelAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L9) +[src/parser/classes/actions/UpdateEngagementPanelAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L9) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/actions/UpdateEngagementPanelAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L7) +[src/parser/classes/actions/UpdateEngagementPanelAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/actions/UpdateEngagementPanelAction.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md b/docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md index 161af094..e35cacad 100644 --- a/docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md +++ b/docs/api/namespaces/YTNodes/classes/UpdateLiveChatPollAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L10) +[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L8) +[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L6) +[src/parser/classes/livechat/UpdateLiveChatPollAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateLiveChatPollAction.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateSubscribeButtonAction.md b/docs/api/namespaces/YTNodes/classes/UpdateSubscribeButtonAction.md new file mode 100644 index 00000000..e33c139b --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/UpdateSubscribeButtonAction.md @@ -0,0 +1,221 @@ +[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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateTitleAction.md b/docs/api/namespaces/YTNodes/classes/UpdateTitleAction.md index 593b16cf..ea78054b 100644 --- a/docs/api/namespaces/YTNodes/classes/UpdateTitleAction.md +++ b/docs/api/namespaces/YTNodes/classes/UpdateTitleAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateTitleAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateTitleAction.ts#L10) +[src/parser/classes/livechat/UpdateTitleAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateTitleAction.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateTitleAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateTitleAction.ts#L8) +[src/parser/classes/livechat/UpdateTitleAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateTitleAction.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateTitleAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateTitleAction.ts#L6) +[src/parser/classes/livechat/UpdateTitleAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateTitleAction.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md b/docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md index 24607116..392fe453 100644 --- a/docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md +++ b/docs/api/namespaces/YTNodes/classes/UpdateToggleButtonTextAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L12) +[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L10) +[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L8) +[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L9) +[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L6) +[src/parser/classes/livechat/UpdateToggleButtonTextAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateToggleButtonTextAction.ts#L6) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md b/docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md index 4114b199..d447e0e7 100644 --- a/docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md +++ b/docs/api/namespaces/YTNodes/classes/UpdateViewershipAction.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateViewershipAction.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateViewershipAction.ts#L14) +[src/parser/classes/livechat/UpdateViewershipAction.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateViewershipAction.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateViewershipAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateViewershipAction.ts#L9) +[src/parser/classes/livechat/UpdateViewershipAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateViewershipAction.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateViewershipAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateViewershipAction.ts#L12) +[src/parser/classes/livechat/UpdateViewershipAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateViewershipAction.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateViewershipAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateViewershipAction.ts#L10) +[src/parser/classes/livechat/UpdateViewershipAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateViewershipAction.ts#L10) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateViewershipAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateViewershipAction.ts#L11) +[src/parser/classes/livechat/UpdateViewershipAction.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateViewershipAction.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateViewershipAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateViewershipAction.ts#L8) +[src/parser/classes/livechat/UpdateViewershipAction.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateViewershipAction.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/livechat/UpdateViewershipAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/livechat/UpdateViewershipAction.ts#L6) +[src/parser/classes/livechat/UpdateViewershipAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/livechat/UpdateViewershipAction.ts#L6) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UploadTimeFactoid.md b/docs/api/namespaces/YTNodes/classes/UploadTimeFactoid.md index 8aa939c5..45341f4b 100644 --- a/docs/api/namespaces/YTNodes/classes/UploadTimeFactoid.md +++ b/docs/api/namespaces/YTNodes/classes/UploadTimeFactoid.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/UploadTimeFactoid.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UploadTimeFactoid.ts#L11) +[src/parser/classes/UploadTimeFactoid.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UploadTimeFactoid.ts#L11) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/UploadTimeFactoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UploadTimeFactoid.ts#L9) +[src/parser/classes/UploadTimeFactoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UploadTimeFactoid.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/UploadTimeFactoid.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UploadTimeFactoid.ts#L7) +[src/parser/classes/UploadTimeFactoid.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UploadTimeFactoid.ts#L7) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/UpsellDialog.md b/docs/api/namespaces/YTNodes/classes/UpsellDialog.md index 15aba1e2..c629ceab 100644 --- a/docs/api/namespaces/YTNodes/classes/UpsellDialog.md +++ b/docs/api/namespaces/YTNodes/classes/UpsellDialog.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/UpsellDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UpsellDialog.ts#L15) +[src/parser/classes/UpsellDialog.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UpsellDialog.ts#L15) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/UpsellDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UpsellDialog.ts#L11) +[src/parser/classes/UpsellDialog.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UpsellDialog.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/UpsellDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UpsellDialog.ts#L12) +[src/parser/classes/UpsellDialog.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UpsellDialog.ts#L12) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/UpsellDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UpsellDialog.ts#L13) +[src/parser/classes/UpsellDialog.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UpsellDialog.ts#L13) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/UpsellDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UpsellDialog.ts#L10) +[src/parser/classes/UpsellDialog.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UpsellDialog.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/UpsellDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UpsellDialog.ts#L9) +[src/parser/classes/UpsellDialog.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UpsellDialog.ts#L9) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/UpsellDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/UpsellDialog.ts#L7) +[src/parser/classes/UpsellDialog.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/UpsellDialog.ts#L7) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VerticalList.md b/docs/api/namespaces/YTNodes/classes/VerticalList.md index 297c92ae..c6a967d7 100644 --- a/docs/api/namespaces/YTNodes/classes/VerticalList.md +++ b/docs/api/namespaces/YTNodes/classes/VerticalList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VerticalList.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalList.ts#L12) +[src/parser/classes/VerticalList.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalList.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VerticalList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalList.ts#L9) +[src/parser/classes/VerticalList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalList.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VerticalList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalList.ts#L10) +[src/parser/classes/VerticalList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalList.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VerticalList.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalList.ts#L8) +[src/parser/classes/VerticalList.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalList.ts#L8) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/VerticalList.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalList.ts#L6) +[src/parser/classes/VerticalList.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalList.ts#L6) ## Accessors @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/VerticalList.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalList.ts#L20) +[src/parser/classes/VerticalList.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalList.ts#L20) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md b/docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md index 4bf7a2d8..d769df97 100644 --- a/docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md +++ b/docs/api/namespaces/YTNodes/classes/VerticalWatchCardList.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VerticalWatchCardList.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalWatchCardList.ts#L13) +[src/parser/classes/VerticalWatchCardList.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalWatchCardList.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VerticalWatchCardList.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalWatchCardList.ts#L9) +[src/parser/classes/VerticalWatchCardList.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalWatchCardList.ts#L9) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/VerticalWatchCardList.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalWatchCardList.ts#L11) +[src/parser/classes/VerticalWatchCardList.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalWatchCardList.ts#L11) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/VerticalWatchCardList.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalWatchCardList.ts#L10) +[src/parser/classes/VerticalWatchCardList.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalWatchCardList.ts#L10) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/VerticalWatchCardList.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalWatchCardList.ts#L7) +[src/parser/classes/VerticalWatchCardList.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalWatchCardList.ts#L7) ## Accessors @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/VerticalWatchCardList.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VerticalWatchCardList.ts#L21) +[src/parser/classes/VerticalWatchCardList.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VerticalWatchCardList.ts#L21) ## Methods @@ -118,17 +118,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -162,7 +170,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -196,7 +204,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -234,4 +242,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/Video.md b/docs/api/namespaces/YTNodes/classes/Video.md index d640caac..2d361ff2 100644 --- a/docs/api/namespaces/YTNodes/classes/Video.md +++ b/docs/api/namespaces/YTNodes/classes/Video.md @@ -30,7 +30,7 @@ #### Defined in -[src/parser/classes/Video.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L43) +[src/parser/classes/Video.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L43) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L27) +[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L27) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L28) +[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L28) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L18) +[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L18) *** @@ -78,7 +78,7 @@ #### Defined in -[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L34) +[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L34) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L29) +[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L29) *** @@ -98,7 +98,7 @@ #### Defined in -[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L23) +[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L23) *** @@ -108,7 +108,7 @@ #### Defined in -[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L16) +[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L16) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L39) +[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L39) *** @@ -128,7 +128,7 @@ #### Defined in -[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L40) +[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L40) *** @@ -138,7 +138,7 @@ #### Defined in -[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L30) +[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L30) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L26) +[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L26) *** @@ -158,7 +158,7 @@ #### Defined in -[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L41) +[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L41) *** @@ -168,7 +168,7 @@ #### Defined in -[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L32) +[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L32) *** @@ -178,7 +178,7 @@ #### Defined in -[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L38) +[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L38) *** @@ -188,7 +188,7 @@ #### Defined in -[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L19) +[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L19) *** @@ -198,7 +198,7 @@ #### Defined in -[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L25) +[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L25) *** @@ -208,7 +208,7 @@ #### Defined in -[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L24) +[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L24) *** @@ -218,7 +218,7 @@ #### Defined in -[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L17) +[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L17) *** @@ -232,7 +232,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -242,7 +242,7 @@ #### Defined in -[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L33) +[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L33) *** @@ -252,7 +252,7 @@ #### Defined in -[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L31) +[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L31) *** @@ -266,7 +266,7 @@ #### Defined in -[src/parser/classes/Video.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L14) +[src/parser/classes/Video.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L14) ## Accessors @@ -280,7 +280,7 @@ #### Defined in -[src/parser/classes/Video.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L127) +[src/parser/classes/Video.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L127) *** @@ -294,7 +294,7 @@ #### Defined in -[src/parser/classes/Video.ts:96](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L96) +[src/parser/classes/Video.ts:96](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L96) *** @@ -308,7 +308,7 @@ #### Defined in -[src/parser/classes/Video.ts:123](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L123) +[src/parser/classes/Video.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L123) *** @@ -322,7 +322,7 @@ #### Defined in -[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L119) +[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L119) *** @@ -336,7 +336,7 @@ #### Defined in -[src/parser/classes/Video.ts:104](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L104) +[src/parser/classes/Video.ts:104](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L104) *** @@ -350,7 +350,7 @@ #### Defined in -[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L115) +[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L115) *** @@ -364,7 +364,7 @@ #### Defined in -[src/parser/classes/Video.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L111) +[src/parser/classes/Video.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L111) ## Methods @@ -384,17 +384,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -428,7 +436,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -462,7 +470,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -500,4 +508,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoAttributeView.md b/docs/api/namespaces/YTNodes/classes/VideoAttributeView.md index 3fbbcbfc..cb937618 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoAttributeView.md +++ b/docs/api/namespaces/YTNodes/classes/VideoAttributeView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L25) +[src/parser/classes/VideoAttributeView.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L25) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L13) +[src/parser/classes/VideoAttributeView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L14) +[src/parser/classes/VideoAttributeView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L20) +[src/parser/classes/VideoAttributeView.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L20) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L23) +[src/parser/classes/VideoAttributeView.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L23) *** @@ -76,13 +76,13 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L22) +[src/parser/classes/VideoAttributeView.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L22) *** -### secondary\_subtitle +### secondary\_subtitle? -> **secondary\_subtitle**: `object` +> `optional` **secondary\_subtitle**: `object` #### content @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L17) +[src/parser/classes/VideoAttributeView.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L17) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L21) +[src/parser/classes/VideoAttributeView.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L21) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L16) +[src/parser/classes/VideoAttributeView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L16) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L15) +[src/parser/classes/VideoAttributeView.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L15) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -148,7 +148,7 @@ #### Defined in -[src/parser/classes/VideoAttributeView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributeView.ts#L11) +[src/parser/classes/VideoAttributeView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributeView.ts#L11) ## Methods @@ -168,17 +168,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -212,7 +220,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -246,7 +254,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -284,4 +292,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md b/docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md index f9918072..8d01b844 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md +++ b/docs/api/namespaces/YTNodes/classes/VideoAttributesSectionView.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoAttributesSectionView.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributesSectionView.ts#L16) +[src/parser/classes/VideoAttributesSectionView.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributesSectionView.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoAttributesSectionView.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributesSectionView.ts#L11) +[src/parser/classes/VideoAttributesSectionView.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributesSectionView.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoAttributesSectionView.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributesSectionView.ts#L10) +[src/parser/classes/VideoAttributesSectionView.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributesSectionView.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoAttributesSectionView.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributesSectionView.ts#L14) +[src/parser/classes/VideoAttributesSectionView.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributesSectionView.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/VideoAttributesSectionView.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributesSectionView.ts#L13) +[src/parser/classes/VideoAttributesSectionView.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributesSectionView.ts#L13) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/VideoAttributesSectionView.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributesSectionView.ts#L12) +[src/parser/classes/VideoAttributesSectionView.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributesSectionView.ts#L12) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/VideoAttributesSectionView.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoAttributesSectionView.ts#L8) +[src/parser/classes/VideoAttributesSectionView.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoAttributesSectionView.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoCard.md b/docs/api/namespaces/YTNodes/classes/VideoCard.md index 446ab2d8..1843c491 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoCard.md +++ b/docs/api/namespaces/YTNodes/classes/VideoCard.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoCard.ts#L7) +[src/parser/classes/VideoCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoCard.ts#L9) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L27) +[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L27) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L28) +[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L28) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L18) +[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L18) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L34) +[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L34) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L29) +[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L29) *** @@ -118,7 +118,7 @@ #### Defined in -[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L23) +[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L23) *** @@ -132,7 +132,7 @@ #### Defined in -[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L16) +[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L16) *** @@ -146,7 +146,7 @@ #### Defined in -[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L39) +[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L39) *** @@ -160,7 +160,7 @@ #### Defined in -[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L40) +[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L40) *** @@ -174,7 +174,7 @@ #### Defined in -[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L30) +[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L30) *** @@ -188,7 +188,7 @@ #### Defined in -[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L26) +[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L26) *** @@ -202,7 +202,7 @@ #### Defined in -[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L41) +[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L41) *** @@ -216,7 +216,7 @@ #### Defined in -[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L32) +[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L32) *** @@ -230,7 +230,7 @@ #### Defined in -[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L38) +[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L38) *** @@ -244,7 +244,7 @@ #### Defined in -[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L19) +[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L19) *** @@ -258,7 +258,7 @@ #### Defined in -[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L25) +[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L25) *** @@ -272,7 +272,7 @@ #### Defined in -[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L24) +[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L24) *** @@ -286,7 +286,7 @@ #### Defined in -[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L17) +[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L17) *** @@ -300,7 +300,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -314,7 +314,7 @@ #### Defined in -[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L33) +[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L33) *** @@ -328,7 +328,7 @@ #### Defined in -[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L31) +[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L31) *** @@ -342,7 +342,7 @@ #### Defined in -[src/parser/classes/VideoCard.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoCard.ts#L5) +[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoCard.ts#L7) ## Accessors @@ -360,7 +360,7 @@ #### Defined in -[src/parser/classes/Video.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L127) +[src/parser/classes/Video.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L127) *** @@ -378,7 +378,7 @@ #### Defined in -[src/parser/classes/Video.ts:96](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L96) +[src/parser/classes/Video.ts:96](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L96) *** @@ -396,7 +396,7 @@ #### Defined in -[src/parser/classes/Video.ts:123](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L123) +[src/parser/classes/Video.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L123) *** @@ -414,7 +414,7 @@ #### Defined in -[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L119) +[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L119) *** @@ -432,7 +432,7 @@ #### Defined in -[src/parser/classes/Video.ts:104](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L104) +[src/parser/classes/Video.ts:104](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L104) *** @@ -450,7 +450,7 @@ #### Defined in -[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L115) +[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L115) *** @@ -468,7 +468,7 @@ #### Defined in -[src/parser/classes/Video.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L111) +[src/parser/classes/Video.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L111) ## Methods @@ -488,17 +488,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `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:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -532,7 +540,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -566,7 +574,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -604,4 +612,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionCourseSection.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionCourseSection.md index 74d55907..74952591 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionCourseSection.md +++ b/docs/api/namespaces/YTNodes/classes/VideoDescriptionCourseSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionCourseSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionCourseSection.ts#L14) +[src/parser/classes/VideoDescriptionCourseSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionCourseSection.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionCourseSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionCourseSection.ts#L12) +[src/parser/classes/VideoDescriptionCourseSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionCourseSection.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionCourseSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionCourseSection.ts#L11) +[src/parser/classes/VideoDescriptionCourseSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionCourseSection.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionCourseSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionCourseSection.ts#L9) +[src/parser/classes/VideoDescriptionCourseSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionCourseSection.ts#L9) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md index d0161c5a..ee24f92e 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md +++ b/docs/api/namespaces/YTNodes/classes/VideoDescriptionHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L20) +[src/parser/classes/VideoDescriptionHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L12) +[src/parser/classes/VideoDescriptionHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L13) +[src/parser/classes/VideoDescriptionHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L14) +[src/parser/classes/VideoDescriptionHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L15) +[src/parser/classes/VideoDescriptionHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L15) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L16) +[src/parser/classes/VideoDescriptionHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L16) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L17) +[src/parser/classes/VideoDescriptionHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L17) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -110,7 +110,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L18) +[src/parser/classes/VideoDescriptionHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L18) *** @@ -124,7 +124,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionHeader.ts#L10) +[src/parser/classes/VideoDescriptionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionHeader.ts#L10) ## Methods @@ -144,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -188,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -222,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -260,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md index 6054b7a1..f11ef5f2 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md +++ b/docs/api/namespaces/YTNodes/classes/VideoDescriptionInfocardsSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L19) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L19) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L16) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L16) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L17) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L17) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L14) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L14) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L13) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L13) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L15) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L15) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L12) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L12) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionInfocardsSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionInfocardsSection.ts#L10) +[src/parser/classes/VideoDescriptionInfocardsSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionInfocardsSection.ts#L10) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md index 9f2f1bc7..e6addeb1 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md +++ b/docs/api/namespaces/YTNodes/classes/VideoDescriptionMusicSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionMusicSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionMusicSection.ts#L12) +[src/parser/classes/VideoDescriptionMusicSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionMusicSection.ts#L12) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionMusicSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionMusicSection.ts#L9) +[src/parser/classes/VideoDescriptionMusicSection.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionMusicSection.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionMusicSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionMusicSection.ts#L10) +[src/parser/classes/VideoDescriptionMusicSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionMusicSection.ts#L10) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionMusicSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionMusicSection.ts#L7) +[src/parser/classes/VideoDescriptionMusicSection.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionMusicSection.ts#L7) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md b/docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md index ad309bee..37ea58d2 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md +++ b/docs/api/namespaces/YTNodes/classes/VideoDescriptionTranscriptSection.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionTranscriptSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionTranscriptSection.ts#L14) +[src/parser/classes/VideoDescriptionTranscriptSection.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionTranscriptSection.ts#L14) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionTranscriptSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionTranscriptSection.ts#L12) +[src/parser/classes/VideoDescriptionTranscriptSection.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionTranscriptSection.ts#L12) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionTranscriptSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionTranscriptSection.ts#L10) +[src/parser/classes/VideoDescriptionTranscriptSection.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionTranscriptSection.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionTranscriptSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionTranscriptSection.ts#L11) +[src/parser/classes/VideoDescriptionTranscriptSection.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionTranscriptSection.ts#L11) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/VideoDescriptionTranscriptSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoDescriptionTranscriptSection.ts#L8) +[src/parser/classes/VideoDescriptionTranscriptSection.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoDescriptionTranscriptSection.ts#L8) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md b/docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md index 776036f2..b5c068d3 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md +++ b/docs/api/namespaces/YTNodes/classes/VideoInfoCardContent.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L17) +[src/parser/classes/VideoInfoCardContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L17) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L11) +[src/parser/classes/VideoInfoCardContent.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L14) +[src/parser/classes/VideoInfoCardContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L15) +[src/parser/classes/VideoInfoCardContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L15) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L10) +[src/parser/classes/VideoInfoCardContent.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L10) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L13) +[src/parser/classes/VideoInfoCardContent.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L13) *** @@ -100,7 +100,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L12) +[src/parser/classes/VideoInfoCardContent.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L12) *** @@ -114,7 +114,7 @@ #### Defined in -[src/parser/classes/VideoInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoInfoCardContent.ts#L8) +[src/parser/classes/VideoInfoCardContent.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoInfoCardContent.ts#L8) ## Methods @@ -134,17 +134,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -178,7 +186,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -212,7 +220,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -250,4 +258,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoOwner.md b/docs/api/namespaces/YTNodes/classes/VideoOwner.md index e2974b0a..821f9f88 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoOwner.md +++ b/docs/api/namespaces/YTNodes/classes/VideoOwner.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoOwner.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoOwner.ts#L13) +[src/parser/classes/VideoOwner.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoOwner.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoOwner.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoOwner.ts#L11) +[src/parser/classes/VideoOwner.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoOwner.ts#L11) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoOwner.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoOwner.ts#L10) +[src/parser/classes/VideoOwner.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoOwner.ts#L10) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoOwner.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoOwner.ts#L9) +[src/parser/classes/VideoOwner.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoOwner.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/VideoOwner.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoOwner.ts#L7) +[src/parser/classes/VideoOwner.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoOwner.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md b/docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md index 6ffcbc0d..489cec23 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md +++ b/docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L21) +[src/parser/classes/VideoPrimaryInfo.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L20) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L16) +[src/parser/classes/VideoPrimaryInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L15) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L19) +[src/parser/classes/VideoPrimaryInfo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L18) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L17) +[src/parser/classes/VideoPrimaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L16) *** @@ -66,17 +66,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L18) - -*** - -### short\_view\_count - -> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md) - -#### Defined in - -[src/parser/classes/VideoPrimaryInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L15) +[src/parser/classes/VideoPrimaryInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L17) *** @@ -86,7 +76,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L13) +[src/parser/classes/VideoPrimaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L13) *** @@ -96,7 +86,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L12) +[src/parser/classes/VideoPrimaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L12) *** @@ -110,17 +100,17 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** ### view\_count -> **view\_count**: [`Text`](../../Misc/classes/Text.md) +> **view\_count**: `null` \| [`VideoViewCount`](VideoViewCount.md) #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L14) +[src/parser/classes/VideoPrimaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L14) *** @@ -134,7 +124,7 @@ #### Defined in -[src/parser/classes/VideoPrimaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoPrimaryInfo.ts#L10) +[src/parser/classes/VideoPrimaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoPrimaryInfo.ts#L10) ## Methods @@ -154,17 +144,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -198,7 +196,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -232,7 +230,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -270,4 +268,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md b/docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md index b84cdab3..47e9dbbf 100644 --- a/docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md +++ b/docs/api/namespaces/YTNodes/classes/VideoSecondaryInfo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L21) +[src/parser/classes/VideoSecondaryInfo.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L21) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L18) +[src/parser/classes/VideoSecondaryInfo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L18) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L13) +[src/parser/classes/VideoSecondaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L13) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L19) +[src/parser/classes/VideoSecondaryInfo.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L19) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L15) +[src/parser/classes/VideoSecondaryInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L15) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L12) +[src/parser/classes/VideoSecondaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L12) *** @@ -86,7 +86,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L17) +[src/parser/classes/VideoSecondaryInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L17) *** @@ -96,7 +96,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L16) +[src/parser/classes/VideoSecondaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L16) *** @@ -106,7 +106,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L14) +[src/parser/classes/VideoSecondaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L14) *** @@ -120,7 +120,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -134,7 +134,7 @@ #### Defined in -[src/parser/classes/VideoSecondaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoSecondaryInfo.ts#L10) +[src/parser/classes/VideoSecondaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoSecondaryInfo.ts#L10) ## Methods @@ -154,17 +154,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -198,7 +206,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -232,7 +240,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -270,4 +278,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/VideoViewCount.md b/docs/api/namespaces/YTNodes/classes/VideoViewCount.md new file mode 100644 index 00000000..6907cdff --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/VideoViewCount.md @@ -0,0 +1,231 @@ +[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:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoViewCount.ts#L12) + +## Properties + +### original\_view\_count + +> **original\_view\_count**: `string` + +#### Defined in + +[src/parser/classes/VideoViewCount.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/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/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) + +*** + +### view\_count + +> **view\_count**: [`Text`](../../Misc/classes/Text.md) + +#### Defined in + +[src/parser/classes/VideoViewCount.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoViewCount.ts#L10) + +*** + +### 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/fc5571629eca037af7de03f4b903da6add1f300b/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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md b/docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md index 55213be8..3231ba58 100644 --- a/docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md +++ b/docs/api/namespaces/YTNodes/classes/ViewCountFactoid.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/ViewCountFactoid.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ViewCountFactoid.ts#L13) +[src/parser/classes/ViewCountFactoid.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ViewCountFactoid.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/ViewCountFactoid.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ViewCountFactoid.ts#L10) +[src/parser/classes/ViewCountFactoid.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ViewCountFactoid.ts#L10) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/ViewCountFactoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ViewCountFactoid.ts#L9) +[src/parser/classes/ViewCountFactoid.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ViewCountFactoid.ts#L9) *** @@ -70,7 +70,7 @@ #### Defined in -[src/parser/classes/ViewCountFactoid.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ViewCountFactoid.ts#L11) +[src/parser/classes/ViewCountFactoid.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ViewCountFactoid.ts#L11) *** @@ -84,7 +84,7 @@ #### Defined in -[src/parser/classes/ViewCountFactoid.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/ViewCountFactoid.ts#L7) +[src/parser/classes/ViewCountFactoid.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/ViewCountFactoid.ts#L7) ## Methods @@ -104,17 +104,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -148,7 +156,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -182,7 +190,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -220,4 +228,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md b/docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md index 657fab5b..b12c1d79 100644 --- a/docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md +++ b/docs/api/namespaces/YTNodes/classes/WatchCardCompactVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/WatchCardCompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardCompactVideo.ts#L17) +[src/parser/classes/WatchCardCompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardCompactVideo.ts#L17) ## Properties @@ -44,7 +44,7 @@ #### Defined in -[src/parser/classes/WatchCardCompactVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardCompactVideo.ts#L11) +[src/parser/classes/WatchCardCompactVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardCompactVideo.ts#L11) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/WatchCardCompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardCompactVideo.ts#L15) +[src/parser/classes/WatchCardCompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardCompactVideo.ts#L15) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/WatchCardCompactVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardCompactVideo.ts#L10) +[src/parser/classes/WatchCardCompactVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardCompactVideo.ts#L10) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/WatchCardCompactVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardCompactVideo.ts#L9) +[src/parser/classes/WatchCardCompactVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardCompactVideo.ts#L9) *** @@ -88,7 +88,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -102,7 +102,7 @@ #### Defined in -[src/parser/classes/WatchCardCompactVideo.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardCompactVideo.ts#L7) +[src/parser/classes/WatchCardCompactVideo.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardCompactVideo.ts#L7) ## Methods @@ -122,17 +122,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -166,7 +174,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -200,7 +208,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -238,4 +246,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md b/docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md index 9d6996a6..46d70863 100644 --- a/docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md +++ b/docs/api/namespaces/YTNodes/classes/WatchCardHeroVideo.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/WatchCardHeroVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardHeroVideo.ts#L13) +[src/parser/classes/WatchCardHeroVideo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardHeroVideo.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/WatchCardHeroVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardHeroVideo.ts#L9) +[src/parser/classes/WatchCardHeroVideo.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardHeroVideo.ts#L9) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/WatchCardHeroVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardHeroVideo.ts#L8) +[src/parser/classes/WatchCardHeroVideo.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardHeroVideo.ts#L8) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/WatchCardHeroVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardHeroVideo.ts#L10) +[src/parser/classes/WatchCardHeroVideo.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardHeroVideo.ts#L10) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/WatchCardHeroVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardHeroVideo.ts#L11) +[src/parser/classes/WatchCardHeroVideo.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardHeroVideo.ts#L11) *** @@ -80,7 +80,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -94,7 +94,7 @@ #### Defined in -[src/parser/classes/WatchCardHeroVideo.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardHeroVideo.ts#L6) +[src/parser/classes/WatchCardHeroVideo.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardHeroVideo.ts#L6) ## Methods @@ -114,17 +114,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -158,7 +166,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -192,7 +200,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -230,4 +238,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md b/docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md index 753ccad5..20a04b5e 100644 --- a/docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md +++ b/docs/api/namespaces/YTNodes/classes/WatchCardRichHeader.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/WatchCardRichHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardRichHeader.ts#L16) +[src/parser/classes/WatchCardRichHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardRichHeader.ts#L16) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/WatchCardRichHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardRichHeader.ts#L13) +[src/parser/classes/WatchCardRichHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardRichHeader.ts#L13) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/WatchCardRichHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardRichHeader.ts#L14) +[src/parser/classes/WatchCardRichHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardRichHeader.ts#L14) *** @@ -56,7 +56,7 @@ #### Defined in -[src/parser/classes/WatchCardRichHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardRichHeader.ts#L12) +[src/parser/classes/WatchCardRichHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardRichHeader.ts#L12) *** @@ -66,7 +66,7 @@ #### Defined in -[src/parser/classes/WatchCardRichHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardRichHeader.ts#L10) +[src/parser/classes/WatchCardRichHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardRichHeader.ts#L10) *** @@ -76,7 +76,7 @@ #### Defined in -[src/parser/classes/WatchCardRichHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardRichHeader.ts#L11) +[src/parser/classes/WatchCardRichHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardRichHeader.ts#L11) *** @@ -90,7 +90,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -104,7 +104,7 @@ #### Defined in -[src/parser/classes/WatchCardRichHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardRichHeader.ts#L8) +[src/parser/classes/WatchCardRichHeader.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardRichHeader.ts#L8) ## Methods @@ -124,17 +124,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -168,7 +176,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -202,7 +210,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -240,4 +248,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchCardSectionSequence.md b/docs/api/namespaces/YTNodes/classes/WatchCardSectionSequence.md index 863012ac..f0df65d6 100644 --- a/docs/api/namespaces/YTNodes/classes/WatchCardSectionSequence.md +++ b/docs/api/namespaces/YTNodes/classes/WatchCardSectionSequence.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/WatchCardSectionSequence.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardSectionSequence.ts#L10) +[src/parser/classes/WatchCardSectionSequence.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardSectionSequence.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/WatchCardSectionSequence.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardSectionSequence.ts#L8) +[src/parser/classes/WatchCardSectionSequence.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardSectionSequence.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -64,7 +64,7 @@ #### Defined in -[src/parser/classes/WatchCardSectionSequence.ts:6](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchCardSectionSequence.ts#L6) +[src/parser/classes/WatchCardSectionSequence.ts:6](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchCardSectionSequence.ts#L6) ## Methods @@ -84,17 +84,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -128,7 +136,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -162,7 +170,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -200,4 +208,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchEndpoint.md b/docs/api/namespaces/YTNodes/classes/WatchEndpoint.md new file mode 100644 index 00000000..1018bf6e --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/WatchEndpoint.md @@ -0,0 +1,245 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchEndpoint.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/WatchEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchNextEndScreen.md b/docs/api/namespaces/YTNodes/classes/WatchNextEndScreen.md index 2682282c..6c14379d 100644 --- a/docs/api/namespaces/YTNodes/classes/WatchNextEndScreen.md +++ b/docs/api/namespaces/YTNodes/classes/WatchNextEndScreen.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/WatchNextEndScreen.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchNextEndScreen.ts#L13) +[src/parser/classes/WatchNextEndScreen.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchNextEndScreen.ts#L13) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/WatchNextEndScreen.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchNextEndScreen.ts#L10) +[src/parser/classes/WatchNextEndScreen.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchNextEndScreen.ts#L10) *** @@ -46,7 +46,7 @@ #### Defined in -[src/parser/classes/WatchNextEndScreen.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchNextEndScreen.ts#L11) +[src/parser/classes/WatchNextEndScreen.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchNextEndScreen.ts#L11) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/WatchNextEndScreen.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchNextEndScreen.ts#L8) +[src/parser/classes/WatchNextEndScreen.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchNextEndScreen.ts#L8) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchNextEndpoint.md b/docs/api/namespaces/YTNodes/classes/WatchNextEndpoint.md new file mode 100644 index 00000000..9f723dc0 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/WatchNextEndpoint.md @@ -0,0 +1,241 @@ +[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:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchNextEndpoint.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/fc5571629eca037af7de03f4b903da6add1f300b/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:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchNextEndpoint.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:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) + +*** + +### 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:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchNextEndpoint.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/WatchNextEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/WatchNextEndpoint.ts#L15) + +*** + +### 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:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +Check if the node is of the given type. + +#### Type Parameters + +• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) + +• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[] + +#### Parameters + +• ...**types**: `K` + +The type to check + +#### Returns + +`this is InstanceType` + +whether the node is of the given type + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is) + +#### Defined in + +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) + +*** + +### key() + +> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md) + +Assert that the node has the given key and return it. + +#### Type Parameters + +• **T** *extends* `string` + +• **R** = `any` + +#### Parameters + +• **key**: `T` + +The key to check + +#### Returns + +[`Maybe`](../../Helpers/classes/Maybe.md) + +The value of the key wrapped in a Maybe + +#### Throws + +If the node does not have the key + +#### Inherited from + +[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key) + +#### Defined in + +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/WatchNextTabbedResults.md b/docs/api/namespaces/YTNodes/classes/WatchNextTabbedResults.md index a94b931b..6d8177a3 100644 --- a/docs/api/namespaces/YTNodes/classes/WatchNextTabbedResults.md +++ b/docs/api/namespaces/YTNodes/classes/WatchNextTabbedResults.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/WatchNextTabbedResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchNextTabbedResults.ts#L7) +[src/parser/classes/WatchNextTabbedResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchNextTabbedResults.ts#L7) ## Properties @@ -40,7 +40,7 @@ #### Defined in -[src/parser/classes/TwoColumnBrowseResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnBrowseResults.ts#L8) +[src/parser/classes/TwoColumnBrowseResults.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnBrowseResults.ts#L8) *** @@ -54,7 +54,7 @@ #### Defined in -[src/parser/classes/TwoColumnBrowseResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/TwoColumnBrowseResults.ts#L7) +[src/parser/classes/TwoColumnBrowseResults.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/TwoColumnBrowseResults.ts#L7) *** @@ -68,7 +68,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -82,7 +82,7 @@ #### Defined in -[src/parser/classes/WatchNextTabbedResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/WatchNextTabbedResults.ts#L5) +[src/parser/classes/WatchNextTabbedResults.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/WatchNextTabbedResults.ts#L5) ## Methods @@ -102,17 +102,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`TwoColumnBrowseResults`](TwoColumnBrowseResults.md).[`as`](TwoColumnBrowseResults.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -146,7 +154,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -180,7 +188,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -218,4 +226,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTNodes/classes/YpcTrailer.md b/docs/api/namespaces/YTNodes/classes/YpcTrailer.md index 91835131..9e9f4e59 100644 --- a/docs/api/namespaces/YTNodes/classes/YpcTrailer.md +++ b/docs/api/namespaces/YTNodes/classes/YpcTrailer.md @@ -26,7 +26,7 @@ #### Defined in -[src/parser/classes/YpcTrailer.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/YpcTrailer.ts#L10) +[src/parser/classes/YpcTrailer.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/YpcTrailer.ts#L10) ## Properties @@ -36,7 +36,7 @@ #### Defined in -[src/parser/classes/YpcTrailer.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/YpcTrailer.ts#L8) +[src/parser/classes/YpcTrailer.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/YpcTrailer.ts#L8) *** @@ -50,7 +50,7 @@ #### Defined in -[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8) +[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8) *** @@ -60,7 +60,7 @@ #### Defined in -[src/parser/classes/YpcTrailer.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/YpcTrailer.ts#L7) +[src/parser/classes/YpcTrailer.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/YpcTrailer.ts#L7) *** @@ -74,7 +74,7 @@ #### Defined in -[src/parser/classes/YpcTrailer.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/YpcTrailer.ts#L5) +[src/parser/classes/YpcTrailer.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/YpcTrailer.ts#L5) ## Methods @@ -94,17 +94,25 @@ Cast to one of the given types. • ...**types**: `K` +The types to cast to + #### Returns `InstanceType`\<`K`\[`number`\]\> +The node cast to one of the given types + +#### Throws + +If the node is not of the given type + #### Inherited from [`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) #### Defined in -[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35) +[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38) *** @@ -138,7 +146,7 @@ Whether the node has the key #### Defined in -[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47) +[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50) *** @@ -172,7 +180,7 @@ whether the node is of the given type #### Defined in -[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28) +[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28) *** @@ -210,4 +218,4 @@ If the node does not have the key #### Defined in -[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57) +[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60) diff --git a/docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md b/docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md index 62876da9..9767adb8 100644 --- a/docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md +++ b/docs/api/namespaces/YTShorts/classes/ShortFormVideoInfo.md @@ -32,7 +32,7 @@ #### Defined in -[src/parser/ytshorts/ShortFormVideoInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytshorts/ShortFormVideoInfo.ts#L16) +[src/parser/ytshorts/ShortFormVideoInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytshorts/ShortFormVideoInfo.ts#L15) ## Properties @@ -46,7 +46,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L31) +[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L39) *** @@ -192,7 +192,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L30) +[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L38) *** @@ -206,7 +206,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L34) +[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L42) *** @@ -220,7 +220,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L35) +[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L43) *** @@ -230,7 +230,7 @@ #### Defined in -[src/parser/ytshorts/ShortFormVideoInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytshorts/ShortFormVideoInfo.ts#L13) +[src/parser/ytshorts/ShortFormVideoInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytshorts/ShortFormVideoInfo.ts#L12) *** @@ -244,7 +244,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L33) +[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L41) *** @@ -258,7 +258,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L37) +[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L45) *** @@ -272,7 +272,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L38) +[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L46) *** @@ -282,13 +282,13 @@ #### Defined in -[src/parser/ytshorts/ShortFormVideoInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytshorts/ShortFormVideoInfo.ts#L14) +[src/parser/ytshorts/ShortFormVideoInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytshorts/ShortFormVideoInfo.ts#L13) *** ### storyboards? -> `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) +> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) #### Inherited from @@ -296,7 +296,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L32) +[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L40) *** @@ -310,7 +310,7 @@ #### Defined in -[src/core/mixins/MediaInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L36) +[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L44) *** @@ -320,7 +320,7 @@ #### Defined in -[src/parser/ytshorts/ShortFormVideoInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytshorts/ShortFormVideoInfo.ts#L12) +[src/parser/ytshorts/ShortFormVideoInfo.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytshorts/ShortFormVideoInfo.ts#L11) ## Accessors @@ -328,8 +328,6 @@ > `get` **actions**(): [`Actions`](../../../classes/Actions.md) -Actions instance. - #### Returns [`Actions`](../../../classes/Actions.md) @@ -340,7 +338,7 @@ Actions instance. #### Defined in -[src/core/mixins/MediaInfo.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L223) +[src/core/mixins/MediaInfo.ts:226](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L226) *** @@ -360,7 +358,7 @@ Content Playback Nonce. #### Defined in -[src/core/mixins/MediaInfo.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L230) +[src/core/mixins/MediaInfo.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L233) *** @@ -368,7 +366,7 @@ Content Playback Nonce. > `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] -Original parsed InnerTube response. +Parsed InnerTube response. #### Returns @@ -380,7 +378,7 @@ Original parsed InnerTube response. #### Defined in -[src/core/mixins/MediaInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L237) +[src/core/mixins/MediaInfo.ts:240](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L240) *** @@ -396,7 +394,7 @@ Checks if continuation is available for the watch next feed. #### Defined in -[src/parser/ytshorts/ShortFormVideoInfo.ts:52](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytshorts/ShortFormVideoInfo.ts#L52) +[src/parser/ytshorts/ShortFormVideoInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytshorts/ShortFormVideoInfo.ts#L47) ## Methods @@ -424,7 +422,7 @@ Adds video to the watch history. #### Defined in -[src/core/mixins/MediaInfo.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L199) +[src/core/mixins/MediaInfo.ts:207](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L207) *** @@ -450,7 +448,7 @@ Options #### Defined in -[src/core/mixins/MediaInfo.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L149) +[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L157) *** @@ -476,7 +474,7 @@ Download options. #### Defined in -[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L157) +[src/core/mixins/MediaInfo.ts:165](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L165) *** @@ -502,7 +500,7 @@ Get a cleaned up representation of the adaptive_formats #### Defined in -[src/core/mixins/MediaInfo.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L132) +[src/core/mixins/MediaInfo.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L140) *** @@ -522,7 +520,7 @@ Retrieves the video's transcript. #### Defined in -[src/core/mixins/MediaInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L170) +[src/core/mixins/MediaInfo.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L178) *** @@ -536,7 +534,7 @@ Retrieves the video's transcript. #### Defined in -[src/parser/ytshorts/ShortFormVideoInfo.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/ytshorts/ShortFormVideoInfo.ts#L28) +[src/parser/ytshorts/ShortFormVideoInfo.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/ytshorts/ShortFormVideoInfo.ts#L27) *** @@ -572,4 +570,4 @@ DASH manifest #### Defined in -[src/core/mixins/MediaInfo.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L97) +[src/core/mixins/MediaInfo.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L105) diff --git a/docs/api/type-aliases/Context.md b/docs/api/type-aliases/Context.md index 9ae25f72..539af8d2 100644 --- a/docs/api/type-aliases/Context.md +++ b/docs/api/type-aliases/Context.md @@ -204,4 +204,4 @@ ## Defined in -[src/core/Session.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L30) +[src/core/Session.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L30) diff --git a/docs/api/type-aliases/DeviceAndUserCode.md b/docs/api/type-aliases/DeviceAndUserCode.md index 6c2a9376..f593834c 100644 --- a/docs/api/type-aliases/DeviceAndUserCode.md +++ b/docs/api/type-aliases/DeviceAndUserCode.md @@ -32,4 +32,4 @@ ## Defined in -[src/core/OAuth2.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L22) +[src/core/OAuth2.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L22) diff --git a/docs/api/type-aliases/InnertubeEndpoint.md b/docs/api/type-aliases/InnertubeEndpoint.md index 87d24b53..8ba2b7f1 100644 --- a/docs/api/type-aliases/InnertubeEndpoint.md +++ b/docs/api/type-aliases/InnertubeEndpoint.md @@ -6,4 +6,4 @@ ## Defined in -[src/core/Actions.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L19) +[src/core/Actions.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L18) diff --git a/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md b/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md index b5c08707..568d4563 100644 --- a/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md +++ b/docs/api/type-aliases/OAuth2AuthErrorEventHandler.md @@ -14,4 +14,4 @@ ## Defined in -[src/core/OAuth2.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L33) +[src/core/OAuth2.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L33) diff --git a/docs/api/type-aliases/OAuth2AuthEventHandler.md b/docs/api/type-aliases/OAuth2AuthEventHandler.md index c58789b0..7d9b9e72 100644 --- a/docs/api/type-aliases/OAuth2AuthEventHandler.md +++ b/docs/api/type-aliases/OAuth2AuthEventHandler.md @@ -16,4 +16,4 @@ ## Defined in -[src/core/OAuth2.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L31) +[src/core/OAuth2.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L31) diff --git a/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md b/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md index 187ffd10..634aeed6 100644 --- a/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md +++ b/docs/api/type-aliases/OAuth2AuthPendingEventHandler.md @@ -14,4 +14,4 @@ ## Defined in -[src/core/OAuth2.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L32) +[src/core/OAuth2.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L32) diff --git a/docs/api/type-aliases/OAuth2ClientID.md b/docs/api/type-aliases/OAuth2ClientID.md index c333f018..a6510a2c 100644 --- a/docs/api/type-aliases/OAuth2ClientID.md +++ b/docs/api/type-aliases/OAuth2ClientID.md @@ -16,4 +16,4 @@ ## Defined in -[src/core/OAuth2.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L7) +[src/core/OAuth2.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L7) diff --git a/docs/api/type-aliases/OAuth2Tokens.md b/docs/api/type-aliases/OAuth2Tokens.md index db0d6fea..d575d734 100644 --- a/docs/api/type-aliases/OAuth2Tokens.md +++ b/docs/api/type-aliases/OAuth2Tokens.md @@ -36,4 +36,4 @@ ## Defined in -[src/core/OAuth2.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/OAuth2.ts#L12) +[src/core/OAuth2.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/OAuth2.ts#L12) diff --git a/docs/api/type-aliases/ParsedResponse.md b/docs/api/type-aliases/ParsedResponse.md index 2cf5f9cf..900a0bbb 100644 --- a/docs/api/type-aliases/ParsedResponse.md +++ b/docs/api/type-aliases/ParsedResponse.md @@ -10,4 +10,4 @@ ## Defined in -[src/core/Actions.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Actions.ts#L21) +[src/core/Actions.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Actions.ts#L20) diff --git a/docs/api/type-aliases/SWSessionData.md b/docs/api/type-aliases/SWSessionData.md index 385a2b2d..57e8f381 100644 --- a/docs/api/type-aliases/SWSessionData.md +++ b/docs/api/type-aliases/SWSessionData.md @@ -20,4 +20,4 @@ ## Defined in -[src/core/Session.ts:193](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L193) +[src/core/Session.ts:193](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L193) diff --git a/docs/api/type-aliases/SessionArgs.md b/docs/api/type-aliases/SessionArgs.md index 5eb19f5c..b8a0f231 100644 --- a/docs/api/type-aliases/SessionArgs.md +++ b/docs/api/type-aliases/SessionArgs.md @@ -40,4 +40,4 @@ ## Defined in -[src/core/Session.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L199) +[src/core/Session.ts:199](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L199) diff --git a/docs/api/type-aliases/SessionData.md b/docs/api/type-aliases/SessionData.md index 97a5c6a1..3ecd13b4 100644 --- a/docs/api/type-aliases/SessionData.md +++ b/docs/api/type-aliases/SessionData.md @@ -20,4 +20,4 @@ ## Defined in -[src/core/Session.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L187) +[src/core/Session.ts:187](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L187) diff --git a/docs/api/type-aliases/SessionOptions.md b/docs/api/type-aliases/SessionOptions.md index 7bf570fc..cb8c349e 100644 --- a/docs/api/type-aliases/SessionOptions.md +++ b/docs/api/type-aliases/SessionOptions.md @@ -113,4 +113,4 @@ A good way to get a valid one is by either grabbing it from a browser or calling ## Defined in -[src/core/Session.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/Session.ts#L111) +[src/core/Session.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/Session.ts#L111) diff --git a/src/core/managers/PlaylistManager.ts b/src/core/managers/PlaylistManager.ts index 5247e2b9..bee62c7d 100644 --- a/src/core/managers/PlaylistManager.ts +++ b/src/core/managers/PlaylistManager.ts @@ -107,10 +107,7 @@ export default class PlaylistManager { if (!this.#actions.session.logged_in) throw new InnertubeError('You must be signed in to perform this operation.'); - const browse_endpoint = new NavigationEndpoint({ browseEndpoint: { browseId: `VL${playlist_id}` } }); - const browse_response = await browse_endpoint.call(this.#actions, { parse: true }); - - const playlist = new Playlist(this.#actions, browse_response, true); + const playlist = await this.#getPlaylist(playlist_id); if (!playlist.info.is_editable) throw new InnertubeError('This playlist cannot be edited.', playlist_id); @@ -160,10 +157,7 @@ export default class PlaylistManager { if (!this.#actions.session.logged_in) throw new InnertubeError('You must be signed in to perform this operation.'); - const browse_endpoint = new NavigationEndpoint({ browseEndpoint: { browseId: `VL${playlist_id}` } }); - const browse_response = await browse_endpoint.call(this.#actions, { parse: true }); - - const playlist = new Playlist(this.#actions, browse_response, true); + const playlist = await this.#getPlaylist(playlist_id); if (!playlist.info.is_editable) throw new InnertubeError('This playlist cannot be edited.', playlist_id); @@ -201,9 +195,21 @@ export default class PlaylistManager { action_result: response.data.actions // TODO: implement actions in the parser }; } + + async #getPlaylist(playlist_id: string): Promise { + let id = playlist_id; + + if (!id.startsWith('VL')) + id = `VL${id}`; + + const browse_endpoint = new NavigationEndpoint({ browseEndpoint: { browseId: `VL${id}` } }); + const browse_response = await browse_endpoint.call(this.#actions, { parse: true }); + + return new Playlist(this.#actions, browse_response, true); + } /** - * Sets the name (title) for the given playlist. + * Sets the name for the given playlist. * @param playlist_id - The playlist ID. * @param name - The name / title to use for the playlist. */ diff --git a/src/core/mixins/Feed.ts b/src/core/mixins/Feed.ts index 485578cc..78360844 100644 --- a/src/core/mixins/Feed.ts +++ b/src/core/mixins/Feed.ts @@ -1,3 +1,4 @@ +import type { IParsedResponse } from '../../parser/index.js'; import { Parser, ReloadContinuationItemsCommand } from '../../parser/index.js'; import { concatMemos, InnertubeError } from '../../utils/Utils.js'; @@ -27,22 +28,19 @@ import TwoColumnBrowseResults from '../../parser/classes/TwoColumnBrowseResults. import TwoColumnSearchResults from '../../parser/classes/TwoColumnSearchResults.js'; import WatchCardCompactVideo from '../../parser/classes/WatchCardCompactVideo.js'; -import type { ApiResponse, Actions } from '../index.js'; -import type { - Memo, ObservedArray, - SuperParsedResult, YTNode -} from '../../parser/helpers.js'; +import type { Actions, ApiResponse } from '../index.js'; +import type { Memo, ObservedArray, SuperParsedResult, YTNode } from '../../parser/helpers.js'; import type MusicQueue from '../../parser/classes/MusicQueue.js'; import type RichGrid from '../../parser/classes/RichGrid.js'; import type SectionList from '../../parser/classes/SectionList.js'; -import type { IParsedResponse } from '../../parser/types/index.js'; export default class Feed { - #page: T; - #continuation?: ObservedArray; - #actions: Actions; - #memo: Memo; + readonly #page: T; + readonly #actions: Actions; + readonly #memo: Memo; + #continuation?: ObservedArray; + constructor(actions: Actions, response: ApiResponse | IParsedResponse, already_parsed = false) { if (this.#isParsed(response) || already_parsed) { this.#page = response as T; @@ -203,9 +201,7 @@ export default class Feed { if (this.#continuation.length === 0) throw new InnertubeError('There are no continuations.'); - const response = await this.#continuation[0].endpoint.call(this.#actions, { parse: true }); - - return response; + return await this.#continuation[0].endpoint.call(this.#actions, { parse: true }); } this.#continuation = this.#getBodyContinuations(); diff --git a/src/core/mixins/FilterableFeed.ts b/src/core/mixins/FilterableFeed.ts index 1ca89246..a78b2f01 100644 --- a/src/core/mixins/FilterableFeed.ts +++ b/src/core/mixins/FilterableFeed.ts @@ -4,7 +4,7 @@ import FeedFilterChipBar from '../../parser/classes/FeedFilterChipBar.js'; import { InnertubeError } from '../../utils/Utils.js'; import type { ObservedArray } from '../../parser/helpers.js'; -import type { IParsedResponse } from '../../parser/types/index.js'; +import type { IParsedResponse } from '../../parser/index.js'; import type { ApiResponse, Actions } from '../index.js'; export default class FilterableFeed extends Feed { diff --git a/src/core/mixins/MediaInfo.ts b/src/core/mixins/MediaInfo.ts index a5623dcd..e06a1fbc 100644 --- a/src/core/mixins/MediaInfo.ts +++ b/src/core/mixins/MediaInfo.ts @@ -2,15 +2,22 @@ import { Constants, FormatUtils } from '../../utils/index.js'; import { InnertubeError } from '../../utils/Utils.js'; import { getStreamingInfo } from '../../utils/StreamingInfo.js'; +import type { + INextResponse, + IPlayabilityStatus, + IPlaybackTracking, + IPlayerConfig, + IPlayerResponse, + IStreamingData +} from '../../parser/index.js'; import { Parser } from '../../parser/index.js'; import { TranscriptInfo } from '../../parser/youtube/index.js'; import ContinuationItem from '../../parser/classes/ContinuationItem.js'; import PlayerMicroformat from '../../parser/classes/PlayerMicroformat.js'; import MicroformatData from '../../parser/classes/MicroformatData.js'; -import type { ApiResponse, Actions } from '../index.js'; -import type { INextResponse, IPlayabilityStatus, IPlaybackTracking, IPlayerConfig, IPlayerResponse, IStreamingData } from '../../parser/index.js'; -import type { DownloadOptions, FormatFilter, FormatOptions, URLTransformer } from '../../types/FormatUtils.js'; +import type { Actions, ApiResponse } from '../index.js'; +import type { DownloadOptions, FormatFilter, FormatOptions, URLTransformer } from '../../types/index.js'; import type Format from '../../parser/classes/misc/Format.js'; import type { DashOptions } from '../../types/DashOptions.js'; import type { ObservedArray } from '../../parser/helpers.js'; @@ -23,10 +30,11 @@ import type PlayerLiveStoryboardSpec from '../../parser/classes/PlayerLiveStoryb import type PlayerStoryboardSpec from '../../parser/classes/PlayerStoryboardSpec.js'; export default class MediaInfo { - #page: [IPlayerResponse, INextResponse?]; - #actions: Actions; - #cpn: string; - #playback_tracking?: IPlaybackTracking; + readonly #page: [IPlayerResponse, INextResponse?]; + readonly #actions: Actions; + readonly #cpn: string; + readonly #playback_tracking?: IPlaybackTracking; + basic_info; annotations?: ObservedArray; storyboards?: PlayerStoryboardSpec | PlayerLiveStoryboardSpec; @@ -209,17 +217,12 @@ export default class MediaInfo { const url = this.#playback_tracking.videostats_playback_url.replace('https://s.', replacement); - const response = await this.#actions.stats(url, { + return await this.#actions.stats(url, { client_name, client_version }, url_params); - - return response; } - /** - * Actions instance. - */ get actions(): Actions { return this.#actions; } @@ -232,7 +235,7 @@ export default class MediaInfo { } /** - * Original parsed InnerTube response. + * Parsed InnerTube response. */ get page(): [IPlayerResponse, INextResponse?] { return this.#page; diff --git a/src/core/mixins/TabbedFeed.ts b/src/core/mixins/TabbedFeed.ts index 3a509f01..d15a3263 100644 --- a/src/core/mixins/TabbedFeed.ts +++ b/src/core/mixins/TabbedFeed.ts @@ -4,11 +4,11 @@ import Tab from '../../parser/classes/Tab.js'; import type { Actions, ApiResponse } from '../index.js'; import type { ObservedArray } from '../../parser/helpers.js'; -import type { IParsedResponse } from '../../parser/types/ParsedResponse.js'; +import type { IParsedResponse } from '../../parser/index.js'; export default class TabbedFeed extends Feed { + readonly #actions: Actions; #tabs?: ObservedArray; - #actions: Actions; constructor(actions: Actions, data: ApiResponse | IParsedResponse, already_parsed = false) { super(actions, data, already_parsed); diff --git a/src/parser/helpers.ts b/src/parser/helpers.ts index dc5dc8d6..09900b7c 100644 --- a/src/parser/helpers.ts +++ b/src/parser/helpers.ts @@ -31,6 +31,9 @@ export class YTNode { /** * Cast to one of the given types. + * @param types - The types to cast to + * @returns The node cast to one of the given types + * @throws {ParsingError} If the node is not of the given type */ as[]>(...types: K): InstanceType { if (!this.is(...types)) { @@ -52,7 +55,7 @@ export class YTNode { * Assert that the node has the given key and return it. * @param key - The key to check * @returns The value of the key wrapped in a Maybe - * @throws If the node does not have the key + * @throws {ParsingError} If the node does not have the key */ key(key: T) { if (!this.hasKey(key)) { @@ -64,6 +67,9 @@ export class YTNode { const MAYBE_TAG = 'Maybe'; +/** + * A wrapper class that provides type-safe access to a value. + */ export class Maybe { readonly #value; @@ -176,7 +182,7 @@ export class Maybe { /** * More typesafe variant of {@link Maybe#array}. * @returns a proxied array which returns all the values as {@link Maybe}. - * @throws If the value is not an array + * @throws {TypeError} If the value is not an array */ arrayOfMaybe(): Maybe[] { const arrayProps: any[] = []; @@ -350,44 +356,79 @@ export class SuperParsedResult { } } +/** + * An extended array type that includes additional utility methods for filtering and manipulating YTNode objects. + */ export type ObservedArray = Array & { - /** - * Returns the first object to match the rule. - */ - get: (rule: object, del_item?: boolean) => T | undefined; - /** - * Returns all objects that match the rule. - */ - getAll: (rule: object, del_items?: boolean) => T[]; - /** - * Returns the first object to match the condition. - */ - matchCondition: (condition: (node: T) => boolean) => T | undefined; - /** - * Removes the item at the given index. - */ - remove: (index: number) => T[]; - /** - * Get all items of a specific type. - */ - filterType[]>(...types: K): ObservedArray>; - /** - * Get the first of a specific type. - */ - firstOfType[]>(...types: K): InstanceType | undefined; - /** - * Get the first item. - */ - first: () => T; - /** - * This is similar to filter but throws if there's a type mismatch. - */ - as[]>(...types: K): ObservedArray>; + /** + * Returns the first object that matches the specified rule object. + * @param rule - An object containing properties to match against + * @param del_item - Optional flag to remove the matched item from the array + * @returns The first matching object or undefined if no match is found + */ + get: (rule: object, del_item?: boolean) => T | undefined; + + /** + * Returns all objects that match the specified rule object. + * @param rule - An object containing properties to match against + * @param del_items - Optional flag to remove all matched items from the array + * @returns An array of all matching objects + */ + getAll: (rule: object, del_items?: boolean) => T[]; + + /** + * Returns the first object that satisfies the provided condition function. + * @param condition - A predicate function that tests each element + * @returns The first element that satisfies the condition or undefined if none found + */ + matchCondition: (condition: (node: T) => boolean) => T | undefined; + + /** + * Removes the item at the specified index. + * @param index - The index of the item to remove + * @returns The modified array after removal + */ + remove: (index: number) => T[]; + + /** + * Filters the array to only include items of the specified YTNode types. + * @template R - Type extending YTNode + * @template K - Array of types (YTNodes) + * @param types - Rest parameter of YTNode constructor types to filter by + * @returns A new ObservedArray containing only items of the specified types + */ + filterType[]>(...types: K): ObservedArray>; + + /** + * Returns the first item in the array that matches any of the specified YTNode types. + * @template R - Type extending YTNode + * @template K - Array of types (YTNodes) + * @param types - Rest parameter of YTNode constructor types to match against + * @returns The first matching item or undefined if none found + */ + firstOfType[]>(...types: K): InstanceType | undefined; + + /** + * Returns the first item in the array. + * @returns The first item in the array + */ + first: () => T; + + /** + * Similar to `filter` but with strict type checking. Filters the array to include only items of the specified types. + * @template R - Type extending YTNode + * @template K - Array of types (YTNodes) + * @param types - Rest parameter of YTNode constructor types to filter by + * @returns A new ObservedArray containing only items of the specified types + * @throws {ParsingError} If an item is not of the specified type + */ + as[]>(...types: K): ObservedArray>; }; /** - * Creates a trap to intercept property access - * and add utilities to an object. + * Creates an observed array that provides additional utility methods for array manipulation and filtering. + * @template T - Type extending YTNode + * @param obj - Array to be observed */ export function observe(obj: Array): ObservedArray { return new Proxy(obj, { @@ -467,37 +508,6 @@ export function observe(obj: Array): ObservedArray { }) as ObservedArray; } -export const WEB_PATHS = { - WEB_UNPLUGGED: '^unplugged/', - WEB_UNPLUGGED_ONBOARDING: '^unplugged/', - WEB_UNPLUGGED_OPS: '^unplugged/', - WEB_UNPLUGGED_PUBLIC: '^unplugged/', - WEB_CREATOR: '^creator/', - WEB_KIDS: '^kids/', - WEB_EXPERIMENTS: '^experiments/', - WEB_MUSIC: '^music/', - WEB_REMIX: '^music/', - WEB_MUSIC_EMBEDDED_PLAYER: '^main_app/|^sfv/' -}; - -export function getApiPath(paths: string[], interface_name?: string): string { - const target_interface_name = interface_name || 'UNKNOWN_INTERFACE'; - - if (paths.length === 1) - return paths[0]; - - const target_interface_reg = WEB_PATHS[target_interface_name as keyof typeof WEB_PATHS]; - if (target_interface_reg) { - for (const path of paths) { - if (new RegExp(target_interface_reg).test(path)) { - return path; - } - } - } - - return paths[0]; -} - export class Memo extends Map { getType[]>(types: K): ObservedArray>; getType[]>(...types: K): ObservedArray> diff --git a/src/utils/ProtoUtils.ts b/src/utils/ProtoUtils.ts index 05a6d3c7..d4e9ad05 100644 --- a/src/utils/ProtoUtils.ts +++ b/src/utils/ProtoUtils.ts @@ -1,6 +1,13 @@ import { base64ToU8, u8ToBase64 } from './Utils.js'; import { NextParams, PeformCommentActionParams, VisitorData } from '../../protos/generated/misc/params.js'; +export type CommentActionParamsArgs = { + comment_id?: string, + video_id?: string, + text?: string, + target_language?: string +} + export function encodeVisitorData(id: string, timestamp: number): string { const writer = VisitorData.encode({ id, timestamp }); return encodeURIComponent(u8ToBase64(writer.finish()).replace(/\+/g, '-').replace(/\//g, '_')); @@ -10,12 +17,7 @@ export function decodeVisitorData(visitor_data: string): VisitorData { return VisitorData.decode(base64ToU8(decodeURIComponent(visitor_data).replace(/-/g, '+').replace(/_/g, '/'))); } -export function encodeCommentActionParams(type: number, args: { - comment_id?: string, - video_id?: string, - text?: string, - target_language?: string -} = {}): string { +export function encodeCommentActionParams(type: number, args: CommentActionParamsArgs = {}): string { const data: PeformCommentActionParams = { type, commentId: args.comment_id || ' ',