chore: regen docs

2026-07-02 21:52:48 +00:00 · 2025-10-12 12:09:24 -03:00
parent 0733f60b57
commit a9f19151b6
867 changed files with 140123 additions and 7758 deletions
--- a/docs/api/youtubei.js/namespaces/YTNodes/classes/PageHeaderView.md
+++ b/docs/api/youtubei.js/namespaces/YTNodes/classes/PageHeaderView.md
@@ -0,0 +1,287 @@
+[youtubei.js](../../../../README.md) / [YTNodes](../README.md) / PageHeaderView
+
+# Class: PageHeaderView
+
+Defined in: [src/parser/classes/PageHeaderView.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L12)
+
+## Extends
+
+- [`YTNode`](../../Helpers/classes/YTNode.md)
+
+## Constructors
+
+### Constructor
+
+> **new PageHeaderView**(`data`): `PageHeaderView`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:25](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L25)
+
+#### Parameters
+
+##### data
+
+[`RawNode`](../../../../type-aliases/RawNode.md)
+
+#### Returns
+
+`PageHeaderView`
+
+#### Overrides
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructor)
+
+## Properties
+
+### actions
+
+> **actions**: [`FlexibleActionsView`](FlexibleActionsView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:20](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L20)
+
+***
+
+### animated\_image
+
+> **animated\_image**: [`ContentPreviewImageView`](ContentPreviewImageView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:17](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L17)
+
+***
+
+### attributation
+
+> **attributation**: [`AttributionView`](AttributionView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:22](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L22)
+
+***
+
+### banner
+
+> **banner**: [`ImageBannerView`](ImageBannerView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:23](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L23)
+
+***
+
+### description
+
+> **description**: [`DescriptionPreviewView`](DescriptionPreviewView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:21](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L21)
+
+***
+
+### hero\_image
+
+> **hero\_image**: [`ContentPreviewImageView`](ContentPreviewImageView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:18](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L18)
+
+***
+
+### image
+
+> **image**: [`DecoratedAvatarView`](DecoratedAvatarView.md) \| [`ContentPreviewImageView`](ContentPreviewImageView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:16](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L16)
+
+***
+
+### metadata
+
+> **metadata**: [`ContentMetadataView`](ContentMetadataView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L19)
+
+***
+
+### title
+
+> **title**: [`DynamicTextView`](DynamicTextView.md) \| `null`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L15)
+
+***
+
+### type
+
+> `readonly` **type**: `string`
+
+Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L8)
+
+#### Inherited from
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type)
+
+***
+
+### type
+
+> `static` **type**: `string` = `'PageHeaderView'`
+
+Defined in: [src/parser/classes/PageHeaderView.ts:13](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/PageHeaderView.ts#L13)
+
+#### Overrides
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1)
+
+## Methods
+
+### as()
+
+> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
+
+Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L29)
+
+Cast to one of the given types.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
+
+##### K
+
+`K` *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
+
+#### Parameters
+
+##### types
+
+...`K`
+
+The types to cast to
+
+#### Returns
+
+`InstanceType`\<`K`\[`number`\]\>
+
+The node cast to one of the given types
+
+#### Throws
+
+If the node is not of the given type
+
+#### Inherited from
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as)
+
+***
+
+### hasKey()
+
+> **hasKey**\<`T`, `R`\>(`key`): `this is PageHeaderView & { [k in string]: R }`
+
+Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L41)
+
+Check for a key without asserting the type.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string`
+
+##### R
+
+`R` = `any`
+
+#### Parameters
+
+##### key
+
+`T`
+
+The key to check
+
+#### Returns
+
+`this is PageHeaderView & { [k in string]: R }`
+
+Whether the node has the key
+
+#### Inherited from
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey)
+
+***
+
+### is()
+
+> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
+
+Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L19)
+
+Check if the node is of the given type.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
+
+##### K
+
+`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)
+
+***
+
+### key()
+
+> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
+
+Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L51)
+
+Assert that the node has the given key and return it.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string`
+
+##### R
+
+`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)