jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-23 14:38:07 +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

125
docs/api/namespaces/Misc/classes/TextRun.md Normal file
View File

@@ -0,0 +1,125 @@
[youtubei.js](../../../README.md) / [Misc](../README.md) / TextRun
# Class: TextRun
## Implements
- `Run`
## Constructors
### new TextRun()
> **new TextRun**(`data`): [`TextRun`](TextRun.md)
#### Parameters
• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
#### Returns
[`TextRun`](TextRun.md)
#### Defined in
[src/parser/classes/misc/TextRun.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L13)
## Properties
### attachment
> **attachment**: `any`
#### Defined in
[src/parser/classes/misc/TextRun.ts:11](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L11)
***
### bold
> **bold**: `boolean`
#### Defined in
[src/parser/classes/misc/TextRun.ts:8](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L8)
***
### endpoint?
> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)
#### Defined in
[src/parser/classes/misc/TextRun.ts:7](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L7)
***
### italics
> **italics**: `boolean`
#### Defined in
[src/parser/classes/misc/TextRun.ts:9](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L9)
***
### strikethrough
> **strikethrough**: `boolean`
#### Defined in
[src/parser/classes/misc/TextRun.ts:10](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L10)
***
### text
> **text**: `string`
#### Implementation of
`Run.text`
#### Defined in
[src/parser/classes/misc/TextRun.ts:6](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L6)
## Methods
### toHTML()
> **toHTML**(): `string`
#### Returns
`string`
#### Implementation of
`Run.toHTML`
#### Defined in
[src/parser/classes/misc/TextRun.ts:30](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L30)
***
### toString()
> **toString**(): `string`
#### Returns
`string`
#### Implementation of
`Run.toString`
#### Defined in
[src/parser/classes/misc/TextRun.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/TextRun.ts#L26)