mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-19 04:21:35 +00:00
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
267
docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md
Normal file
267
docs/api/namespaces/YTNodes/classes/DescriptionPreviewView.md
Normal file
@@ -0,0 +1,267 @@
|
||||
[youtubei.js](../../../README.md) / [YTNodes](../README.md) / DescriptionPreviewView
|
||||
|
||||
# Class: DescriptionPreviewView
|
||||
|
||||
## Extends
|
||||
|
||||
- [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
## Constructors
|
||||
|
||||
### new DescriptionPreviewView()
|
||||
|
||||
> **new DescriptionPreviewView**(`data`): [`DescriptionPreviewView`](DescriptionPreviewView.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`DescriptionPreviewView`](DescriptionPreviewView.md)
|
||||
|
||||
#### Overrides
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/DescriptionPreviewView.ts:24](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/DescriptionPreviewView.ts#L24)
|
||||
|
||||
## Properties
|
||||
|
||||
### always\_show\_truncation\_text
|
||||
|
||||
> **always\_show\_truncation\_text**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/DescriptionPreviewView.ts:12](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/DescriptionPreviewView.ts#L12)
|
||||
|
||||
***
|
||||
|
||||
### description
|
||||
|
||||
> **description**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/DescriptionPreviewView.ts:9](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/DescriptionPreviewView.ts#L9)
|
||||
|
||||
***
|
||||
|
||||
### max\_lines
|
||||
|
||||
> **max\_lines**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/DescriptionPreviewView.ts:10](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/DescriptionPreviewView.ts#L10)
|
||||
|
||||
***
|
||||
|
||||
### more\_endpoint?
|
||||
|
||||
> `optional` **more\_endpoint**: `object`
|
||||
|
||||
#### show\_engagement\_panel\_endpoint
|
||||
|
||||
> **show\_engagement\_panel\_endpoint**: `object`
|
||||
|
||||
#### show\_engagement\_panel\_endpoint.engagement\_panel
|
||||
|
||||
> **engagement\_panel**: `null` \| [`EngagementPanelSectionList`](EngagementPanelSectionList.md)
|
||||
|
||||
#### show\_engagement\_panel\_endpoint.engagement\_panel\_popup\_type
|
||||
|
||||
> **engagement\_panel\_popup\_type**: `string`
|
||||
|
||||
#### show\_engagement\_panel\_endpoint.identifier
|
||||
|
||||
> **identifier**: `object`
|
||||
|
||||
#### show\_engagement\_panel\_endpoint.identifier.surface
|
||||
|
||||
> **surface**: `string`
|
||||
|
||||
#### show\_engagement\_panel\_endpoint.identifier.tag
|
||||
|
||||
> **tag**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/DescriptionPreviewView.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/DescriptionPreviewView.ts#L13)
|
||||
|
||||
***
|
||||
|
||||
### truncation\_text
|
||||
|
||||
> **truncation\_text**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/DescriptionPreviewView.ts:11](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/DescriptionPreviewView.ts#L11)
|
||||
|
||||
***
|
||||
|
||||
### type
|
||||
|
||||
> `readonly` **type**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L8)
|
||||
|
||||
***
|
||||
|
||||
### type
|
||||
|
||||
> `static` **type**: `string` = `'DescriptionPreviewView'`
|
||||
|
||||
#### Overrides
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/DescriptionPreviewView.ts:7](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/DescriptionPreviewView.ts#L7)
|
||||
|
||||
## Methods
|
||||
|
||||
### as()
|
||||
|
||||
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
|
||||
|
||||
Cast to one of the given types.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
|
||||
|
||||
#### Parameters
|
||||
|
||||
• ...**types**: `K`
|
||||
|
||||
#### Returns
|
||||
|
||||
`InstanceType`\<`K`\[`number`\]\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L35)
|
||||
|
||||
***
|
||||
|
||||
### hasKey()
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is DescriptionPreviewView & { [k in string]: R }`
|
||||
|
||||
Check for a key without asserting the type.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* `string`
|
||||
|
||||
• **R** = `any`
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **key**: `T`
|
||||
|
||||
The key to check
|
||||
|
||||
#### Returns
|
||||
|
||||
`this is DescriptionPreviewView & { [k in string]: R }`
|
||||
|
||||
Whether the node has the key
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L47)
|
||||
|
||||
***
|
||||
|
||||
### is()
|
||||
|
||||
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
|
||||
|
||||
Check if the node is of the given type.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
|
||||
|
||||
#### Parameters
|
||||
|
||||
• ...**types**: `K`
|
||||
|
||||
The type to check
|
||||
|
||||
#### Returns
|
||||
|
||||
`this is InstanceType<K[number]>`
|
||||
|
||||
whether the node is of the given type
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L28)
|
||||
|
||||
***
|
||||
|
||||
### key()
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
|
||||
|
||||
Assert that the node has the given key and return it.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* `string`
|
||||
|
||||
• **R** = `any`
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **key**: `T`
|
||||
|
||||
The key to check
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Maybe`](../../Helpers/classes/Maybe.md)
|
||||
|
||||
The value of the key wrapped in a Maybe
|
||||
|
||||
#### Throws
|
||||
|
||||
If the node does not have the key
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L57)
|
||||
Reference in New Issue
Block a user