Skip to content

Commit a9f1915

Browse files
committed
chore: regen docs
1 parent 0733f60 commit a9f1915

File tree

867 files changed

+140121
-7756
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

867 files changed

+140121
-7756
lines changed

docs/api/classes/Actions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
# Class: Actions
44

5-
Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L46)
5+
Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L46)
66

77
## Constructors
88

99
### Constructor
1010

1111
> **new Actions**(`session`): `Actions`
1212
13-
Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L49)
13+
Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L49)
1414

1515
#### Parameters
1616

@@ -28,7 +28,7 @@ Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/4
2828

2929
> **session**: [`Session`](Session.md)
3030
31-
Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L47)
31+
Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L47)
3232

3333
## Methods
3434

@@ -38,7 +38,7 @@ Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/4
3838

3939
> **execute**\<`T`\>(`endpoint`, `args`): `Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\>
4040
41-
Defined in: [src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L81)
41+
Defined in: [src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L81)
4242

4343
Executes an API call.
4444

@@ -84,7 +84,7 @@ Call arguments
8484

8585
> **execute**\<`T`\>(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
8686
87-
Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L88)
87+
Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L88)
8888

8989
Executes an API call.
9090

@@ -132,7 +132,7 @@ Call arguments
132132

133133
> **stats**(`url`, `client`, `params`): `Promise`\<`Response`\>
134134
135-
Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L59)
135+
Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L59)
136136

137137
Makes calls to the playback tracking API.
138138

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
[youtubei.js](../README.md) / AppendContinuationItemsAction
2+
3+
# Class: AppendContinuationItemsAction
4+
5+
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L6)
6+
7+
## Extends
8+
9+
- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)
10+
11+
## Constructors
12+
13+
### Constructor
14+
15+
> **new AppendContinuationItemsAction**(`data`): `AppendContinuationItemsAction`
16+
17+
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L12)
18+
19+
#### Parameters
20+
21+
##### data
22+
23+
[`RawNode`](../type-aliases/RawNode.md)
24+
25+
#### Returns
26+
27+
`AppendContinuationItemsAction`
28+
29+
#### Overrides
30+
31+
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor)
32+
33+
## Properties
34+
35+
### contents
36+
37+
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\>
38+
39+
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L9)
40+
41+
***
42+
43+
### target
44+
45+
> **target**: `string`
46+
47+
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L10)
48+
49+
***
50+
51+
### type
52+
53+
> `readonly` **type**: `string`
54+
55+
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L8)
56+
57+
#### Inherited from
58+
59+
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type)
60+
61+
***
62+
63+
### type
64+
65+
> `static` **type**: `string` = `'AppendContinuationItemsAction'`
66+
67+
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L7)
68+
69+
#### Overrides
70+
71+
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1)
72+
73+
## Methods
74+
75+
### as()
76+
77+
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
78+
79+
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L29)
80+
81+
Cast to one of the given types.
82+
83+
#### Type Parameters
84+
85+
##### T
86+
87+
`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)
88+
89+
##### K
90+
91+
`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
92+
93+
#### Parameters
94+
95+
##### types
96+
97+
...`K`
98+
99+
The types to cast to
100+
101+
#### Returns
102+
103+
`InstanceType`\<`K`\[`number`\]\>
104+
105+
The node cast to one of the given types
106+
107+
#### Throws
108+
109+
If the node is not of the given type
110+
111+
#### Inherited from
112+
113+
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as)
114+
115+
***
116+
117+
### hasKey()
118+
119+
> **hasKey**\<`T`, `R`\>(`key`): `this is AppendContinuationItemsAction & { [k in string]: R }`
120+
121+
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L41)
122+
123+
Check for a key without asserting the type.
124+
125+
#### Type Parameters
126+
127+
##### T
128+
129+
`T` *extends* `string`
130+
131+
##### R
132+
133+
`R` = `any`
134+
135+
#### Parameters
136+
137+
##### key
138+
139+
`T`
140+
141+
The key to check
142+
143+
#### Returns
144+
145+
`this is AppendContinuationItemsAction & { [k in string]: R }`
146+
147+
Whether the node has the key
148+
149+
#### Inherited from
150+
151+
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey)
152+
153+
***
154+
155+
### is()
156+
157+
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
158+
159+
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L19)
160+
161+
Check if the node is of the given type.
162+
163+
#### Type Parameters
164+
165+
##### T
166+
167+
`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)
168+
169+
##### K
170+
171+
`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
172+
173+
#### Parameters
174+
175+
##### types
176+
177+
...`K`
178+
179+
The type to check
180+
181+
#### Returns
182+
183+
`this is InstanceType<K[number]>`
184+
185+
whether the node is of the given type
186+
187+
#### Inherited from
188+
189+
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is)
190+
191+
***
192+
193+
### key()
194+
195+
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md)
196+
197+
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L51)
198+
199+
Assert that the node has the given key and return it.
200+
201+
#### Type Parameters
202+
203+
##### T
204+
205+
`T` *extends* `string`
206+
207+
##### R
208+
209+
`R` = `any`
210+
211+
#### Parameters
212+
213+
##### key
214+
215+
`T`
216+
217+
The key to check
218+
219+
#### Returns
220+
221+
[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md)
222+
223+
The value of the key wrapped in a Maybe
224+
225+
#### Throws
226+
227+
If the node does not have the key
228+
229+
#### Inherited from
230+
231+
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key)

docs/api/classes/Continuation.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Class: Continuation
44

5-
Defined in: [src/parser/continuations.ts:139](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L139)
5+
Defined in: [src/parser/continuations.ts:139](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L139)
66

77
## Extends
88

@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:139](https://github.com/LuanRT/YouTube.
1414

1515
> **new Continuation**(`data`): `Continuation`
1616
17-
Defined in: [src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L147)
17+
Defined in: [src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L147)
1818

1919
#### Parameters
2020

@@ -36,39 +36,39 @@ Defined in: [src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.
3636

3737
> **continuation\_type**: `string`
3838
39-
Defined in: [src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L142)
39+
Defined in: [src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L142)
4040

4141
***
4242

4343
### time\_until\_last\_message\_ms?
4444

4545
> `optional` **time\_until\_last\_message\_ms**: `number`
4646
47-
Defined in: [src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L144)
47+
Defined in: [src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L144)
4848

4949
***
5050

5151
### timeout\_ms?
5252

5353
> `optional` **timeout\_ms**: `number`
5454
55-
Defined in: [src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L143)
55+
Defined in: [src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L143)
5656

5757
***
5858

5959
### token
6060

6161
> **token**: `string`
6262
63-
Defined in: [src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L145)
63+
Defined in: [src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L145)
6464

6565
***
6666

6767
### type
6868

6969
> `readonly` **type**: `string`
7070
71-
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L8)
71+
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L8)
7272

7373
#### Inherited from
7474

@@ -80,7 +80,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
8080

8181
> `readonly` `static` **type**: `"continuation"` = `'continuation'`
8282
83-
Defined in: [src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/continuations.ts#L140)
83+
Defined in: [src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L140)
8484

8585
#### Overrides
8686

@@ -92,7 +92,7 @@ Defined in: [src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.
9292

9393
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
9494
95-
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L29)
95+
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L29)
9696

9797
Cast to one of the given types.
9898

@@ -134,7 +134,7 @@ If the node is not of the given type
134134

135135
> **hasKey**\<`T`, `R`\>(`key`): `this is Continuation & { [k in string]: R }`
136136
137-
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L41)
137+
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L41)
138138

139139
Check for a key without asserting the type.
140140

@@ -172,7 +172,7 @@ Whether the node has the key
172172

173173
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
174174
175-
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L19)
175+
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L19)
176176

177177
Check if the node is of the given type.
178178

@@ -210,7 +210,7 @@ whether the node is of the given type
210210

211211
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md)
212212
213-
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/parser/helpers.ts#L51)
213+
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L51)
214214

215215
Assert that the node has the given key and return it.
216216

0 commit comments

Comments
 (0)