youtubei.js / YTMusic / Library

Class: Library

Defined in: src/parser/ytmusic/Library.ts:21

Constructors

Constructor

new Library(response, actions): Library

Defined in: src/parser/ytmusic/Library.ts:29

Parameters

response

ApiResponse

actions

Actions

Returns

Library

Properties

contents?

optional contents: ObservedArray<MusicShelf | Grid>

Defined in: src/parser/ytmusic/Library.ts:27

optional header: MusicSideAlignedItem

Defined in: src/parser/ytmusic/Library.ts:26

Accessors

filters

Get Signature

get filters(): string[]

Defined in: src/parser/ytmusic/Library.ts:142

Returns

string[]

has_continuation

Get Signature

get has_continuation(): boolean

Defined in: src/parser/ytmusic/Library.ts:132

Returns

boolean

page

Get Signature

get page(): IBrowseResponse

Defined in: src/parser/ytmusic/Library.ts:146

Returns

IBrowseResponse

sort_options

Get Signature

get sort_options(): string[]

Defined in: src/parser/ytmusic/Library.ts:136

Returns

string[]

Methods

applyFilter()

applyFilter(filter): Promise<Library>

Defined in: src/parser/ytmusic/Library.ts:94

Applies given filter to the library.

Parameters

filter

string | ChipCloudChip

Returns

Promise<Library>

applySort()

applySort(sort_by): Promise<Library>

Defined in: src/parser/ytmusic/Library.ts:44

Applies given sort option to the library items.

Parameters

sort_by

string | MusicMultiSelectMenuItem

Returns

Promise<Library>

getContinuation()

getContinuation(): Promise<LibraryContinuation>

Defined in: src/parser/ytmusic/Library.ts:120

Retrieves continuation of the library items.

Returns

Promise<LibraryContinuation>