mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-25 07:42:11 +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
273
docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md
Normal file
273
docs/api/namespaces/YTNodes/classes/VideoPrimaryInfo.md
Normal file
@@ -0,0 +1,273 @@
|
||||
[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoPrimaryInfo
|
||||
|
||||
# Class: VideoPrimaryInfo
|
||||
|
||||
## Extends
|
||||
|
||||
- [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
## Constructors
|
||||
|
||||
### new VideoPrimaryInfo()
|
||||
|
||||
> **new VideoPrimaryInfo**(`data`): [`VideoPrimaryInfo`](VideoPrimaryInfo.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`VideoPrimaryInfo`](VideoPrimaryInfo.md)
|
||||
|
||||
#### Overrides
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:21](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L21)
|
||||
|
||||
## Properties
|
||||
|
||||
### badges
|
||||
|
||||
> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MetadataBadge`](MetadataBadge.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:16](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L16)
|
||||
|
||||
***
|
||||
|
||||
### menu
|
||||
|
||||
> **menu**: `null` \| [`Menu`](Menu.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:19](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L19)
|
||||
|
||||
***
|
||||
|
||||
### published
|
||||
|
||||
> **published**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:17](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L17)
|
||||
|
||||
***
|
||||
|
||||
### relative\_date
|
||||
|
||||
> **relative\_date**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:18](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L18)
|
||||
|
||||
***
|
||||
|
||||
### short\_view\_count
|
||||
|
||||
> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L15)
|
||||
|
||||
***
|
||||
|
||||
### super\_title\_link?
|
||||
|
||||
> `optional` **super\_title\_link**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L13)
|
||||
|
||||
***
|
||||
|
||||
### title
|
||||
|
||||
> **title**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L12)
|
||||
|
||||
***
|
||||
|
||||
### 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)
|
||||
|
||||
***
|
||||
|
||||
### view\_count
|
||||
|
||||
> **view\_count**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:14](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L14)
|
||||
|
||||
***
|
||||
|
||||
### type
|
||||
|
||||
> `static` **type**: `string` = `'VideoPrimaryInfo'`
|
||||
|
||||
#### Overrides
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/VideoPrimaryInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/VideoPrimaryInfo.ts#L10)
|
||||
|
||||
## 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 VideoPrimaryInfo & { [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 VideoPrimaryInfo & { [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