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

youtubei.js / YTNodes / Channel

Class: Channel

Extends

• YTNode

Constructors

new Channel()

new Channel(data): Channel

Parameters

• data: RawNode

Returns

Channel

Overrides

YTNode.constructor

Defined in

src/parser/classes/Channel.ts:23

Properties

author

author: Author

Defined in

src/parser/classes/Channel.ts:14

---

description_snippet

description_snippet: Text

Defined in

src/parser/classes/Channel.ts:21

---

endpoint

endpoint: NavigationEndpoint

Defined in

src/parser/classes/Channel.ts:19

---

id

id: string

Defined in

src/parser/classes/Channel.ts:13

---

long_byline

long_byline: Text

Defined in

src/parser/classes/Channel.ts:17

---

short_byline

short_byline: Text

Defined in

src/parser/classes/Channel.ts:18

---

subscribe_button

subscribe_button: null | Button | SubscribeButton

Defined in

src/parser/classes/Channel.ts:20

---

subscriber_count

subscriber_count: Text

Defined in

src/parser/classes/Channel.ts:15

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

video_count

video_count: Text

Defined in

src/parser/classes/Channel.ts:16

---

type

static type: string = 'Channel'

Overrides

YTNode.type

Defined in

src/parser/classes/Channel.ts:11

Accessors

subscribers

get subscribers(): Text

Deprecated

This will be removed in a future release. Please use Channel.subscriber_count instead.

Returns

Text

Defined in

src/parser/classes/Channel.ts:47

---

videos

get videos(): Text

Deprecated

This will be removed in a future release. Please use Channel.video_count instead.

Returns

Text

Defined in

src/parser/classes/Channel.ts:57

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 Channel & { [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 Channel & { [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