chore: add proper documentation (#763)

* chore: generate API ref using `typedoc`

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

* chore: clean up
This commit is contained in:
Luan
2024-09-23 17:32:50 -03:00
committed by GitHub
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions

View File

@@ -0,0 +1,11 @@
[youtubei.js](../../README.md) / ProtoUtils
# ProtoUtils
## Index
### Functions
- [decodeVisitorData](functions/decodeVisitorData.md)
- [encodeCommentActionParams](functions/encodeCommentActionParams.md)
- [encodeVisitorData](functions/encodeVisitorData.md)

View File

@@ -0,0 +1,17 @@
[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / decodeVisitorData
# Function: decodeVisitorData()
> **decodeVisitorData**(`visitor_data`): `VisitorData`
## Parameters
**visitor\_data**: `string`
## Returns
`VisitorData`
## Defined in
[src/utils/ProtoUtils.ts:9](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/ProtoUtils.ts#L9)

View File

@@ -0,0 +1,27 @@
[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / encodeCommentActionParams
# Function: encodeCommentActionParams()
> **encodeCommentActionParams**(`type`, `args`): `string`
## Parameters
**type**: `number`
**args** = `{}`
**args.comment\_id?**: `string`
**args.target\_language?**: `string`
**args.text?**: `string`
**args.video\_id?**: `string`
## Returns
`string`
## Defined in
[src/utils/ProtoUtils.ts:14](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/ProtoUtils.ts#L14)

View File

@@ -0,0 +1,19 @@
[youtubei.js](../../../README.md) / [ProtoUtils](../README.md) / encodeVisitorData
# Function: encodeVisitorData()
> **encodeVisitorData**(`id`, `timestamp`): `string`
## Parameters
**id**: `string`
**timestamp**: `number`
## Returns
`string`
## Defined in
[src/utils/ProtoUtils.ts:4](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/ProtoUtils.ts#L4)