Files
YouTube.js/docs/api/namespaces/YTNodes/classes/LiveChatAuthorBadge.md
2024-11-25 03:25:27 -03:00

5.6 KiB

youtubei.js / YTNodes / LiveChatAuthorBadge

Class: LiveChatAuthorBadge

Extends

Constructors

new LiveChatAuthorBadge()

new LiveChatAuthorBadge(data): LiveChatAuthorBadge

Parameters

data: RawNode

Returns

LiveChatAuthorBadge

Overrides

MetadataBadge.constructor

Defined in

src/parser/classes/LiveChatAuthorBadge.ts:10

Properties

custom_thumbnail

custom_thumbnail: Thumbnail[]

Defined in

src/parser/classes/LiveChatAuthorBadge.ts:8


icon_type?

optional icon_type: string

Inherited from

MetadataBadge.icon_type

Defined in

src/parser/classes/MetadataBadge.ts:7


label?

optional label: string

Inherited from

MetadataBadge.label

Defined in

src/parser/classes/MetadataBadge.ts:9


style?

optional style: string

Inherited from

MetadataBadge.style

Defined in

src/parser/classes/MetadataBadge.ts:8


tooltip?

optional tooltip: string

Inherited from

MetadataBadge.tooltip

Defined in

src/parser/classes/MetadataBadge.ts:10


type

readonly type: string

Inherited from

MetadataBadge.type

Defined in

src/parser/helpers.ts:8


type

static type: string = 'LiveChatAuthorBadge'

Overrides

MetadataBadge.type

Defined in

src/parser/classes/LiveChatAuthorBadge.ts:6

Methods

as()

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

Cast to one of the given types.

Type Parameters

T extends YTNode

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

MetadataBadge.as

Defined in

src/parser/helpers.ts:38


hasKey()

hasKey<T, R>(key): this is LiveChatAuthorBadge & { [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 LiveChatAuthorBadge & { [k in string]: R }

Whether the node has the key

Inherited from

MetadataBadge.hasKey

Defined in

src/parser/helpers.ts:50


is()

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

Check if the node is of the given type.

Type Parameters

T extends YTNode

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

MetadataBadge.is

Defined in

src/parser/helpers.ts:28


key()

key<T, R>(key): Maybe

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

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

MetadataBadge.key

Defined in

src/parser/helpers.ts:60