jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-25 07:42:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add proper documentation (#763)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

131
docs/api/namespaces/Misc/classes/Author.md Normal file
View File

@@ -0,0 +1,131 @@
[youtubei.js](../../../README.md) / [Misc](../README.md) / Author
# Class: Author
## Constructors
### new Author()
> **new Author**(`item`, `badges`?, `thumbs`?, `id`?): [`Author`](Author.md)
#### Parameters
• **item**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
• **badges?**: `any`
• **thumbs?**: `any`
• **id?**: `string`
#### Returns
[`Author`](Author.md)
#### Defined in
[src/parser/classes/misc/Author.ts:21](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L21)
## Properties
### badges
> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
#### Defined in
[src/parser/classes/misc/Author.ts:15](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L15)
***
### endpoint?
> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)
#### Defined in
[src/parser/classes/misc/Author.ts:14](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L14)
***
### id
> **id**: `string`
#### Defined in
[src/parser/classes/misc/Author.ts:11](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L11)
***
### is\_moderator?
> `optional` **is\_moderator**: `boolean`
#### Defined in
[src/parser/classes/misc/Author.ts:16](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L16)
***
### is\_verified?
> `optional` **is\_verified**: `boolean`
#### Defined in
[src/parser/classes/misc/Author.ts:17](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L17)
***
### is\_verified\_artist?
> `optional` **is\_verified\_artist**: `boolean`
#### Defined in
[src/parser/classes/misc/Author.ts:18](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L18)
***
### name
> **name**: `string`
#### Defined in
[src/parser/classes/misc/Author.ts:12](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L12)
***
### thumbnails
> **thumbnails**: [`Thumbnail`](Thumbnail.md)[]
#### Defined in
[src/parser/classes/misc/Author.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L13)
***
### url
> **url**: `string`
#### Defined in
[src/parser/classes/misc/Author.ts:19](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L19)
## Accessors
### best\_thumbnail
> `get` **best\_thumbnail**(): `undefined` \| [`Thumbnail`](Thumbnail.md)
#### Returns
`undefined` \| [`Thumbnail`](Thumbnail.md)
#### Defined in
[src/parser/classes/misc/Author.ts:51](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Author.ts#L51)