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,13 @@
[youtubei.js](../../../../README.md) / [Endpoints](../../README.md) / GetNotificationMenuEndpoint
# GetNotificationMenuEndpoint
## Index
### Variables
- [PATH](variables/PATH.md)
### Functions
- [build](functions/build.md)

View File

@@ -0,0 +1,23 @@
[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [GetNotificationMenuEndpoint](../README.md) / build
# Function: build()
> **build**(`opts`): [`IGetNotificationMenuRequest`](../../../../Types/type-aliases/IGetNotificationMenuRequest.md)
Builds a `/get_notification_menu` request payload.
## Parameters
**opts**: [`GetNotificationMenuEndpointOptions`](../../../../Types/type-aliases/GetNotificationMenuEndpointOptions.md)
The options to use.
## Returns
[`IGetNotificationMenuRequest`](../../../../Types/type-aliases/IGetNotificationMenuRequest.md)
The payload.
## Defined in
[src/core/endpoints/GetNotificationMenuEndpoint.ts:10](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/endpoints/GetNotificationMenuEndpoint.ts#L10)

View File

@@ -0,0 +1,9 @@
[youtubei.js](../../../../../README.md) / [Endpoints](../../../README.md) / [GetNotificationMenuEndpoint](../README.md) / PATH
# Variable: PATH
> `const` **PATH**: `"/notification/get_notification_menu"` = `'/notification/get_notification_menu'`
## Defined in
[src/core/endpoints/GetNotificationMenuEndpoint.ts:3](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/endpoints/GetNotificationMenuEndpoint.ts#L3)