new Poll(data): Poll

Defined in: src/parser/classes/Poll.ts:25

Parameters

data

RawNode

Returns

Poll

Overrides

YTNode.constructor

Properties

choices

choices: object[]

Defined in: src/parser/classes/Poll.ts:10

deselect_endpoint

deselect_endpoint: NavigationEndpoint | null

image

image: Thumbnail[] | null

select_endpoint

select_endpoint: NavigationEndpoint | null

text

text: Text

vote_percentage_if_not_selected

vote_percentage_if_not_selected: Text

vote_percentage_if_selected

vote_percentage_if_selected: Text

vote_ratio_if_not_selected

vote_ratio_if_not_selected: number | null

vote_ratio_if_selected

vote_ratio_if_selected: number | null

live_chat_poll_id?

optional live_chat_poll_id: string

Defined in: src/parser/classes/Poll.ts:23

poll_type?

optional poll_type: string

Defined in: src/parser/classes/Poll.ts:21

total_votes?

optional total_votes: Text

Defined in: src/parser/classes/Poll.ts:22

type

readonly type: string

Defined in: src/parser/helpers.ts:8

Inherited from

YTNode.type

type

static type: string = 'Poll'

Defined in: src/parser/classes/Poll.ts:8

Overrides

YTNode.type

Methods

as()

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

Defined in: src/parser/helpers.ts:29

Cast to one of the given types.

Type Parameters

T

T extends YTNode

K

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

hasKey()

hasKey<T, R>(key): this is Poll & { [k in string]: R }

Defined in: src/parser/helpers.ts:41

Check for a key without asserting the type.

Type Parameters

T

T extends string

R

R = any

Parameters

key

T

The key to check

Returns

this is Poll & { [k in string]: R }

Whether the node has the key

Inherited from

YTNode.hasKey

is()

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

Defined in: src/parser/helpers.ts:19

Check if the node is of the given type.

Type Parameters

T

T extends YTNode

K

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

key()

key<T, R>(key): Maybe

Defined in: src/parser/helpers.ts:51

Assert that the node has the given key and return it.

Type Parameters

T

T extends string

R

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