mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-16 19:12:24 +00:00
74659fd03f
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
124 lines
2.5 KiB
Markdown
124 lines
2.5 KiB
Markdown
[youtubei.js](../../../README.md) / [Misc](../README.md) / Text
|
|
|
|
# Class: Text
|
|
|
|
## Constructors
|
|
|
|
### new Text()
|
|
|
|
> **new Text**(`data`): [`Text`](Text.md)
|
|
|
|
#### Parameters
|
|
|
|
• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
|
|
|
|
#### Returns
|
|
|
|
[`Text`](Text.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:31](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L31)
|
|
|
|
## Properties
|
|
|
|
### endpoint?
|
|
|
|
> `optional` **endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:29](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L29)
|
|
|
|
***
|
|
|
|
### runs?
|
|
|
|
> `optional` **runs**: ([`EmojiRun`](EmojiRun.md) \| [`TextRun`](TextRun.md))[]
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L28)
|
|
|
|
***
|
|
|
|
### text?
|
|
|
|
> `optional` **text**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:27](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L27)
|
|
|
|
## Methods
|
|
|
|
### isEmpty()
|
|
|
|
> **isEmpty**(): `boolean`
|
|
|
|
Checks if the text is empty.
|
|
|
|
#### Returns
|
|
|
|
`boolean`
|
|
|
|
Whether the text is empty.
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:197](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L197)
|
|
|
|
***
|
|
|
|
### toHTML()
|
|
|
|
> **toHTML**(): `undefined` \| `string`
|
|
|
|
Converts the text to HTML.
|
|
|
|
#### Returns
|
|
|
|
`undefined` \| `string`
|
|
|
|
The HTML.
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:189](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L189)
|
|
|
|
***
|
|
|
|
### toString()
|
|
|
|
> **toString**(): `string`
|
|
|
|
Converts the text to a string.
|
|
|
|
#### Returns
|
|
|
|
`string`
|
|
|
|
The text.
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:205](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L205)
|
|
|
|
***
|
|
|
|
### fromAttributed()
|
|
|
|
> `static` **fromAttributed**(`data`): [`Text`](Text.md)
|
|
|
|
#### Parameters
|
|
|
|
• **data**: `AttributedText`
|
|
|
|
#### Returns
|
|
|
|
[`Text`](Text.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/classes/misc/Text.ts:54](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/misc/Text.ts#L54)
|