YouTube.js/docs/api/namespaces/YTNodes/classes/RichShelf.md

youtubei.js / YTNodes / RichShelf

Class: RichShelf

Extends

• YTNode

Constructors

new RichShelf()

new RichShelf(data): RichShelf

Parameters

• data: RawNode

Returns

RichShelf

Overrides

YTNode.constructor

Defined in

src/parser/classes/RichShelf.ts:14

Properties

contents

contents: ObservedArray<YTNode>

Defined in

src/parser/classes/RichShelf.ts:10

---

endpoint?

optional endpoint: NavigationEndpoint

Defined in

src/parser/classes/RichShelf.ts:11

---

subtitle?

optional subtitle: Text

Defined in

src/parser/classes/RichShelf.ts:12

---

title

title: Text

Defined in

src/parser/classes/RichShelf.ts:9

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

type

static type: string = 'RichShelf'

Overrides

YTNode.type

Defined in

src/parser/classes/RichShelf.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

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

Defined in

src/parser/helpers.ts:38

---

hasKey()

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

Whether the node has the key

Inherited from

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

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:60