Class YouTubeChannel

YouTube Channel Class

Hierarchy

YouTubeChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new YouTubeChannel(data?: any): YouTubeChannel

- Defined in play-dl/YouTube/classes/Channel.ts:55
YouTube Channel Constructor

Parameters
- data: any = {}
  
  YouTube Channel data that we recieve from basic info or from search
Returns YouTubeChannel

Properties

Optional artist

artist?: boolean

YouTube Channel artist if any.

Optional icon

icon?: ChannelIconInterface

YouTube Channel Icon data.

Optional id

id?: string

YouTube Channel ID.

Optional name

name?: string

YouTube Channel Title

Optional subscribers

subscribers?: string

YouTube Channel subscribers count.

type

type: "playlist" | "channel" | "video"

YouTube Class type. == "channel"

Optional url

url?: string

YouTube Channel Url

Optional verified

verified?: boolean

YouTube Channel Verified status.

Methods

iconURL

iconURL(options?: { size: number }): undefined | string

- Defined in play-dl/YouTube/classes/Channel.ts:72
Returns channel icon url

Parameters
- options: { size: number } = ...
  
  Icon options
  - size: number
Returns undefined | string

toJSON

toJSON(): ChannelJSON

- Defined in play-dl/YouTube/classes/Channel.ts:89
Converts Channel Class to JSON format

Returns ChannelJSON
json data of the channel

toString

toString(): string

- Defined in play-dl/YouTube/classes/Channel.ts:82
Converts Channel Class to channel name.

Returns string
name of channel

Generated using TypeDoc