Files
YouTube.js/docs/api/classes/Actions.md
Luan 74659fd03f chore: add proper documentation (#763)
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
2024-09-23 17:32:50 -03:00

2.3 KiB

youtubei.js / Actions

Class: Actions

Constructors

new Actions()

new Actions(session): Actions

Parameters

session: Session

Returns

Actions

Defined in

src/core/Actions.ts:34

Properties

session

session: Session

Defined in

src/core/Actions.ts:32

Methods

execute()

execute(endpoint, args)

execute<T>(endpoint, args): Promise<ParsedResponse<T>>

Executes an API call.

Type Parameters

T extends string

Parameters

endpoint: T

The endpoint to call.

args

Call arguments

args.parse: true

args.protobuf?: false

args.serialized_data?: any

Returns

Promise<ParsedResponse<T>>

Defined in

src/core/Actions.ts:78

execute(endpoint, args)

execute<T>(endpoint, args?): Promise<ApiResponse>

Type Parameters

T extends string

Parameters

endpoint: T

args?

args.parse?: false

args.protobuf?: true

args.serialized_data?: any

Returns

Promise<ApiResponse>

Defined in

src/core/Actions.ts:79


stats()

stats(url, client, params): Promise<Response>

Makes calls to the playback tracking API.

Parameters

url: string

The URL to call.

client

The client to use.

client.client_name: string

client.client_version: string

params

Call parameters.

Returns

Promise<Response>

Defined in

src/core/Actions.ts:56