chore(docs): Update API ref

This commit is contained in:
Luan
2024-11-22 04:25:16 -03:00
parent fc5571629e
commit 4e9d64404e
927 changed files with 26023 additions and 9839 deletions

View File

@@ -18,7 +18,7 @@
#### Defined in
[src/core/clients/Kids.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L18)
[src/core/clients/Kids.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L12)
## Methods
@@ -43,7 +43,7 @@ A list of API responses.
#### Defined in
[src/core/clients/Kids.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L91)
[src/core/clients/Kids.ts:65](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L65)
***
@@ -51,21 +51,17 @@ A list of API responses.
> **getChannel**(`channel_id`): `Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\>
Retrieves the contents of the given channel.
#### Parameters
**channel\_id**: `string`
The channel id.
#### Returns
`Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\>
#### Defined in
[src/core/clients/Kids.ts:62](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L62)
[src/core/clients/Kids.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L47)
***
@@ -73,15 +69,13 @@ The channel id.
> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\>
Retrieves the home feed.
#### Returns
`Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\>
#### Defined in
[src/core/clients/Kids.ts:75](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L75)
[src/core/clients/Kids.ts:53](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L53)
***
@@ -89,21 +83,17 @@ Retrieves the home feed.
> **getInfo**(`video_id`): `Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\>
Retrieves video info.
#### Parameters
**video\_id**: `string`
The video id.
#### Returns
`Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\>
#### Defined in
[src/core/clients/Kids.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L37)
[src/core/clients/Kids.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L22)
***
@@ -111,18 +101,14 @@ The video id.
> **search**(`query`): `Promise`\<[`Search`](../../YTKids/classes/Search.md)\>
Searches the given query.
#### Parameters
**query**: `string`
The query.
#### Returns
`Promise`\<[`Search`](../../YTKids/classes/Search.md)\>
#### Defined in
[src/core/clients/Kids.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/clients/Kids.ts#L26)
[src/core/clients/Kids.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/clients/Kids.ts#L16)