youtubei.js / Helpers / ObservedArray
Type Alias: ObservedArray<T>
ObservedArray<
T> =T[] &object
Defined in: src/parser/helpers.ts:353
An extended array type that includes additional utility methods for filtering and manipulating YTNode objects.
Type Declaration
first()
first: () =>
T
Returns the first item in the array.
Returns
T
The first item in the array
get()
get: (
rule,del_item?) =>T|undefined
Returns the first object that matches the specified rule object.
Parameters
rule
object
An object containing properties to match against
del_item?
boolean
Optional flag to remove the matched item from the array
Returns
T | undefined
The first matching object or undefined if no match is found
getAll()
getAll: (
rule,del_items?) =>T[]
Returns all objects that match the specified rule object.
Parameters
rule
object
An object containing properties to match against
del_items?
boolean
Optional flag to remove all matched items from the array
Returns
T[]
An array of all matching objects
matchCondition()
matchCondition: (
condition) =>T|undefined
Returns the first object that satisfies the provided condition function.
Parameters
condition
(node) => boolean
A predicate function that tests each element
Returns
T | undefined
The first element that satisfies the condition or undefined if none found
remove()
remove: (
index) =>T[]
Removes the item at the specified index.
Parameters
index
number
The index of the item to remove
Returns
T[]
The modified array after removal
as()
as<
R,K>(...types):ObservedArray<InstanceType<K[number]>>
Similar to filter but with strict type checking. Filters the array to include only items of the specified types.
Type Parameters
R
R extends YTNode
Type extending YTNode
K
K extends YTNodeConstructor<R>[]
Array of types (YTNodes)
Parameters
types
...K
Rest parameter of YTNode constructor types to filter by
Returns
ObservedArray<InstanceType<K[number]>>
A new ObservedArray containing only items of the specified types
Throws
If an item is not of the specified type
filterType()
filterType<
R,K>(...types):ObservedArray<InstanceType<K[number]>>
Filters the array to only include items of the specified YTNode types.
Type Parameters
R
R extends YTNode
Type extending YTNode
K
K extends YTNodeConstructor<R>[]
Array of types (YTNodes)
Parameters
types
...K
Rest parameter of YTNode constructor types to filter by
Returns
ObservedArray<InstanceType<K[number]>>
A new ObservedArray containing only items of the specified types
firstOfType()
firstOfType<
R,K>(...types):InstanceType<K[number]> |undefined
Returns the first item in the array that matches any of the specified YTNode types.
Type Parameters
R
R extends YTNode
Type extending YTNode
K
K extends YTNodeConstructor<R>[]
Array of types (YTNodes)
Parameters
types
...K
Rest parameter of YTNode constructor types to match against
Returns
InstanceType<K[number]> | undefined
The first matching item or undefined if none found