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,71 @@
[youtubei.js](../../../README.md) / [YT](../README.md) / NotificationsMenu
# Class: NotificationsMenu
## Constructors
### new NotificationsMenu()
> **new NotificationsMenu**(`actions`, `response`): [`NotificationsMenu`](NotificationsMenu.md)
#### Parameters
**actions**: [`Actions`](../../../classes/Actions.md)
**response**: [`ApiResponse`](../../../interfaces/ApiResponse.md)
#### Returns
[`NotificationsMenu`](NotificationsMenu.md)
#### Defined in
[src/parser/youtube/NotificationsMenu.ts:18](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/NotificationsMenu.ts#L18)
## Properties
### contents
> **contents**: [`Notification`](../../YTNodes/classes/Notification.md)[]
#### Defined in
[src/parser/youtube/NotificationsMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/NotificationsMenu.ts#L16)
***
### header
> **header**: [`SimpleMenuHeader`](../../YTNodes/classes/SimpleMenuHeader.md)
#### Defined in
[src/parser/youtube/NotificationsMenu.ts:15](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/NotificationsMenu.ts#L15)
## Accessors
### page
> `get` **page**(): [`IGetNotificationsMenuResponse`](../../APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md)
#### Returns
[`IGetNotificationsMenuResponse`](../../APIResponseTypes/type-aliases/IGetNotificationsMenuResponse.md)
#### Defined in
[src/parser/youtube/NotificationsMenu.ts:40](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/NotificationsMenu.ts#L40)
## Methods
### getContinuation()
> **getContinuation**(): `Promise`\<[`NotificationsMenu`](NotificationsMenu.md)\>
#### Returns
`Promise`\<[`NotificationsMenu`](NotificationsMenu.md)\>
#### Defined in
[src/parser/youtube/NotificationsMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/NotificationsMenu.ts#L29)