youtubei.js / YTNodes / ChipView
Class: ChipView
Defined in: src/parser/classes/ChipView.ts:5
Extends
Constructors
Constructor
new ChipView(
data):ChipView
Defined in: src/parser/classes/ChipView.ts:33
Parameters
data
Returns
ChipView
Overrides
Properties
accessibility_hint?
optionalaccessibility_hint:string
Defined in: src/parser/classes/ChipView.ts:8
accessibility_label?
optionalaccessibility_label:string
Defined in: src/parser/classes/ChipView.ts:9
chip_entity_key?
optionalchip_entity_key:string
Defined in: src/parser/classes/ChipView.ts:26
display_type?
optionaldisplay_type:"CHIP_VIEW_MODEL_DISPLAY_TYPE_UNSPECIFIED"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_DROP_DOWN"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_DROP_DOWN_WITH_CLEAR"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_FILTER"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_NO_ICON"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_ADJUST"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_CLEAR"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_ADD"|"CHIP_VIEW_MODEL_DISPLAY_TYPE_SPARK"
Defined in: src/parser/classes/ChipView.ts:12
max_text_width?
optionalmax_text_width:number
Defined in: src/parser/classes/ChipView.ts:21
original_text?
optionaloriginal_text:string
Defined in: src/parser/classes/ChipView.ts:23
secondary_accessibility_label?
optionalsecondary_accessibility_label:string
Defined in: src/parser/classes/ChipView.ts:22
secondary_tap_command?
optionalsecondary_tap_command:NavigationEndpoint
Defined in: src/parser/classes/ChipView.ts:25
selected
selected:
boolean
Defined in: src/parser/classes/ChipView.ts:27
tap_command?
optionaltap_command:NavigationEndpoint
Defined in: src/parser/classes/ChipView.ts:24
text?
optionaltext:string
Defined in: src/parser/classes/ChipView.ts:10
trailing_text?
optionaltrailing_text:string
Defined in: src/parser/classes/ChipView.ts:11
type
readonlytype:string
Defined in: src/parser/helpers.ts:8
Inherited from
type
statictype:string='ChipView'
Defined in: src/parser/classes/ChipView.ts:6
Overrides
Accessors
endpoint
Get Signature
get endpoint():
NavigationEndpoint|undefined
Defined in: src/parser/classes/ChipView.ts:29
Returns
NavigationEndpoint | undefined
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
hasKey()
hasKey<
T,R>(key):this is ChipView & { [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 ChipView & { [k in string]: R }
Whether the node has the key
Inherited from
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
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
The value of the key wrapped in a Maybe
Throws
If the node does not have the key