Skip to content

Commit

Permalink
chore(docs): Update API ref
Browse files Browse the repository at this point in the history
  • Loading branch information
LuanRT committed Nov 22, 2024
1 parent fc55716 commit 4e9d644
Show file tree
Hide file tree
Showing 927 changed files with 26,015 additions and 9,831 deletions.
177 changes: 175 additions & 2 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
10 changes: 5 additions & 5 deletions docs/api/classes/Actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)
30 changes: 19 additions & 11 deletions docs/api/classes/Continuation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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

Expand All @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)

***

Expand Down Expand Up @@ -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)
Loading

0 comments on commit 4e9d644

Please sign in to comment.