youtubei.js / YTNodes / AvatarStackView

Class: AvatarStackView

Defined in: src/parser/classes/AvatarStackView.ts:9

Extends

YTNode

Constructors

Constructor

new AvatarStackView(data): AvatarStackView

Defined in: src/parser/classes/AvatarStackView.ts:18

Parameters

data

Returns

AvatarStackView

Overrides

YTNode.constructor

Properties

avatar_cluster_size?

optional avatar_cluster_size?: "AVATAR_SIZE_UNKNOWN" | "AVATAR_SIZE_XS" | "AVATAR_SIZE_S" | "AVATAR_SIZE_M" | "AVATAR_SIZE_XL" | "AVATAR_SIZE_40" | "AVATAR_SIZE_L" | "AVATAR_SIZE_XXS" | "AVATAR_SIZE_RESPONSIVE" | "AVATAR_SIZE_XXL" | "AVATAR_SIZE_XXXL" | "AVATAR_SIZE_48"

Defined in: src/parser/classes/AvatarStackView.ts:14

avatars

avatars: ObservedArray<AvatarView>

Defined in: src/parser/classes/AvatarStackView.ts:12

layout_type?

optional layout_type?: "AVATAR_STACK_LAYOUT_CLUSTER"

Defined in: src/parser/classes/AvatarStackView.ts:15

renderer_context

renderer_context: RendererContext

Defined in: src/parser/classes/AvatarStackView.ts:16

text?

optional text?: Text

Defined in: src/parser/classes/AvatarStackView.ts:13

type

readonly type: string

Defined in: src/parser/helpers.ts:8

Inherited from

YTNode.type

type

static type: string = 'AvatarStackView'

Defined in: src/parser/classes/AvatarStackView.ts:10

Overrides

YTNode.type

Methods

as()

as<T, K>(...types): InstanceType<K[number]>

Defined in: src/parser/helpers.ts:29

Cast to one of the given types.

Type Parameters

T

T extends YTNode

K

K extends YTNodeConstructor<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

hasKey()

hasKey<T, R>(key): this is AvatarStackView & { [k in string]: R }

Defined in: src/parser/helpers.ts:41

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 AvatarStackView & { [k in string]: R }

Whether the node has the key

Inherited from

YTNode.hasKey

is()

is<T, K>(...types): this is InstanceType<K[number]>

Defined in: src/parser/helpers.ts:19

Check if the node is of the given type.

Type Parameters

T

T extends YTNode

K

K extends YTNodeConstructor<T>[]

Parameters

types

...K

The type to check

Returns

this is InstanceType<K[number]>

whether the node is of the given type

Inherited from

key()

key<T, R>(key): Maybe

Defined in: src/parser/helpers.ts:51

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

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from