Skip to content

Commit 0733f60

Browse files
committed
chore: Use latest version of typedoc-plugin-markdown
1 parent 41b8106 commit 0733f60

File tree

696 files changed

+2217
-131060
lines changed

Some content is hidden

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

696 files changed

+2217
-131060
lines changed

docs/api/README.md

Lines changed: 94 additions & 359 deletions
Large diffs are not rendered by default.

docs/api/classes/Actions.md

Lines changed: 73 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,134 +2,164 @@
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)
6+
57
## Constructors
68

7-
### new Actions()
9+
### Constructor
810

9-
> **new Actions**(`session`): [`Actions`](Actions.md)
11+
> **new Actions**(`session`): `Actions`
1012
11-
#### Parameters
13+
Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L49)
1214

13-
**session**: [`Session`](Session.md)
15+
#### Parameters
1416

15-
#### Returns
17+
##### session
1618

17-
[`Actions`](Actions.md)
19+
[`Session`](Session.md)
1820

19-
#### Defined in
21+
#### Returns
2022

21-
[src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L49)
23+
`Actions`
2224

2325
## Properties
2426

2527
### session
2628

2729
> **session**: [`Session`](Session.md)
2830
29-
#### Defined in
30-
31-
[src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L47)
31+
Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L47)
3232

3333
## Methods
3434

3535
### execute()
3636

37-
#### execute(endpoint, args)
37+
#### Call Signature
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)
42+
4143
Executes an API call.
4244

4345
##### Type Parameters
4446

45-
**T** *extends* `string`
47+
###### T
48+
49+
`T` *extends* `string`
4650

4751
##### Parameters
4852

49-
**endpoint**: `T`
53+
###### endpoint
54+
55+
`T`
5056

5157
The endpoint to call.
5258

53-
**args**
59+
###### args
5460

5561
Call arguments
5662

57-
**args.parse**: `true`
63+
###### parse
64+
65+
`true`
66+
67+
###### protobuf?
68+
69+
`false`
5870

59-
**args.protobuf?**: `false`
71+
###### serialized_data?
6072

61-
**args.serialized\_data?**: `any`
73+
`any`
6274

63-
**args.skip\_auth\_check?**: `boolean`
75+
###### skip_auth_check?
76+
77+
`boolean`
6478

6579
##### Returns
6680

6781
`Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\>
6882

69-
##### Defined in
83+
#### Call Signature
7084

71-
[src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L81)
85+
> **execute**\<`T`\>(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
7286
73-
#### execute(endpoint, args)
87+
Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L88)
7488

75-
> **execute**\<`T`\>(`endpoint`, `args`?): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
89+
Executes an API call.
7690

7791
##### Type Parameters
7892

79-
**T** *extends* `string`
93+
###### T
94+
95+
`T` *extends* `string`
8096

8197
##### Parameters
8298

83-
**endpoint**: `T`
99+
###### endpoint
100+
101+
`T`
84102

85-
**args?**
103+
The endpoint to call.
86104

87-
**args.parse?**: `false`
105+
###### args?
88106

89-
**args.protobuf?**: `true`
107+
Call arguments
90108

91-
**args.serialized\_data?**: `any`
109+
###### parse?
92110

93-
**args.skip\_auth\_check?**: `boolean`
111+
`false`
94112

95-
##### Returns
113+
###### protobuf?
96114

97-
`Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
115+
`true`
116+
117+
###### serialized_data?
118+
119+
`any`
120+
121+
###### skip_auth_check?
122+
123+
`boolean`
98124

99-
##### Defined in
125+
##### Returns
100126

101-
[src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L88)
127+
`Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
102128

103129
***
104130

105131
### stats()
106132

107133
> **stats**(`url`, `client`, `params`): `Promise`\<`Response`\>
108134
135+
Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L59)
136+
109137
Makes calls to the playback tracking API.
110138

111139
#### Parameters
112140

113-
**url**: `string`
141+
##### url
142+
143+
`string`
114144

115145
The URL to call.
116146

117-
**client**
147+
##### client
118148

119149
The client to use.
120150

121-
**client.client\_name**: `string`
151+
###### client_name
122152

123-
**client.client\_version**: `string`
153+
`string`
124154

125-
**params**
155+
###### client_version
156+
157+
`string`
158+
159+
##### params
126160

127161
Call parameters.
128162

129163
#### Returns
130164

131165
`Promise`\<`Response`\>
132-
133-
#### Defined in
134-
135-
[src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L59)

0 commit comments

Comments
 (0)