youtubei.js / YTNodes / LiveChatBanner

Class: LiveChatBanner

Extends

• YTNode

Constructors

new LiveChatBanner()

new LiveChatBanner(data): LiveChatBanner

Parameters

• data: RawNode

Returns

LiveChatBanner

Overrides

YTNode.constructor

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:17

Properties

action_id

action_id: string

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:11

---

background_type

background_type: string

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:15

---

contents

contents: YTNode

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:10

---

header

header: null | LiveChatBannerHeader

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:9

---

is_stackable

is_stackable: boolean

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:14

---

target_id

target_id: string

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:13

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

viewer_is_creator

viewer_is_creator: boolean

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:12

---

type

static type: string = 'LiveChatBanner'

Overrides

YTNode.type

Defined in

src/parser/classes/livechat/items/LiveChatBanner.ts:7

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

Returns

InstanceType<K[number]>

Inherited from

YTNode.as

Defined in

src/parser/helpers.ts:35

---

hasKey()

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

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:47

---

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

YTNode.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

YTNode.key

Defined in

src/parser/helpers.ts:57