jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-25 15:52:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Use latest version of typedoc-plugin-markdown

Browse Source
This commit is contained in:
Luan
2025-10-12 12:03:26 -03:00
parent 41b810629b
commit 0733f60b57
696 changed files with 2256 additions and 131099 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
docs/api/classes/Actions.md
View File

@@ -2,23 +2,25 @@
# Class: Actions
Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L46)
## Constructors
### new Actions()
### Constructor
> **new Actions**(`session`): [`Actions`](Actions.md)
> **new Actions**(`session`): `Actions`
Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L49)
#### Parameters
• **session**: [`Session`](Session.md)
##### session
[`Session`](Session.md)
#### Returns
[`Actions`](Actions.md)
#### Defined in
[src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L49)
`Actions`
## Properties
@@ -26,110 +28,138 @@
> **session**: [`Session`](Session.md)
#### Defined in
[src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L47)
Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L47)
## Methods
### execute()
#### execute(endpoint, args)
#### Call Signature
> **execute**\<`T`\>(`endpoint`, `args`): `Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\>
Defined in: [src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L81)
Executes an API call.
##### Type Parameters
• **T** *extends* `string`
###### T
`T` *extends* `string`
##### Parameters
• **endpoint**: `T`
###### endpoint
`T`
The endpoint to call.
• **args**
###### args
Call arguments
• **args.parse**: `true`
###### parse
• **args.protobuf?**: `false`
`true`
• **args.serialized\_data?**: `any`
###### protobuf?
• **args.skip\_auth\_check?**: `boolean`
`false`
###### serialized_data?
`any`
###### skip_auth_check?
`boolean`
##### Returns
`Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\>
##### Defined in
#### Call Signature
[src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L81)
> **execute**\<`T`\>(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
#### execute(endpoint, args)
Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L88)
> **execute**\<`T`\>(`endpoint`, `args`?): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
Executes an API call.
##### Type Parameters
• **T** *extends* `string`
###### T
`T` *extends* `string`
##### Parameters
• **endpoint**: `T`
###### endpoint
• **args?**
`T`
• **args.parse?**: `false`
The endpoint to call.
• **args.protobuf?**: `true`
###### args?
• **args.serialized\_data?**: `any`
Call arguments
• **args.skip\_auth\_check?**: `boolean`
###### parse?
`false`
###### protobuf?
`true`
###### serialized_data?
`any`
###### skip_auth_check?
`boolean`
##### Returns
`Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
##### Defined in
[src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L88)
***
### stats()
> **stats**(`url`, `client`, `params`): `Promise`\<`Response`\>
Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L59)
Makes calls to the playback tracking API.
#### Parameters
• **url**: `string`
##### url
`string`
The URL to call.
• **client**
##### client
The client to use.
• **client.client\_name**: `string`
###### client_name
• **client.client\_version**: `string`
`string`
• **params**
###### client_version
`string`
##### params
Call parameters.
#### Returns
`Promise`\<`Response`\>
#### Defined in
[src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L59)