Skeudenn

Appearance

Skeudenn / preload / ReadingListApi

Interface: ReadingListApi ​

Defined in: src/preload.ts:154

Reading lists (ordered piles of library entries), as window.tankobon.readingLists.

Methods ​

addEntries() ​

addEntries(id, libraryIds): Promise<ReadingListAddResult>

Defined in: src/preload.ts:166

Appends several library entries to a reading list, in the order given: books already in it are skipped, and once it holds 50 books the rest are left out (the result counts each case).

Parameters ​

id ​

string

libraryIds ​

string[]

Returns ​

Promise<ReadingListAddResult>

addEntry() ​

addEntry(id, libraryId): Promise<ReadingListResult>

Defined in: src/preload.ts:164

Appends a library entry to a reading list; refused when the list already holds 50 books.

Parameters ​

id ​

string

libraryId ​

string

Returns ​

Promise<ReadingListResult>

create() ​

create(name): Promise<ReadingListResult>

Defined in: src/preload.ts:158

Creates an empty reading list; refused when the name is empty.

Parameters ​

name ​

string

Returns ​

Promise<ReadingListResult>

list() ​

list(): Promise<ReadingList[]>

Defined in: src/preload.ts:156

Every reading list, in the user's order (new lists last), each with its library entry ids in reading order.

Returns ​

Promise<ReadingList[]>

remove() ​

remove(id): Promise<void>

Defined in: src/preload.ts:162

Deletes a reading list; its books stay in the library.

Parameters ​

id ​

string

Returns ​

Promise<void>

removeEntry() ​

removeEntry(id, libraryId): Promise<ReadingListResult>

Defined in: src/preload.ts:168

Takes a library entry out of a reading list.

Parameters ​

id ​

string

libraryId ​

string

Returns ​

Promise<ReadingListResult>

rename() ​

rename(id, name): Promise<ReadingListResult>

Defined in: src/preload.ts:160

Renames a reading list; refused when the name is empty.

Parameters ​

id ​

string

name ​

string

Returns ​

Promise<ReadingListResult>

reorder() ​

reorder(id, entryIds): Promise<ReadingListResult>

Defined in: src/preload.ts:170

Stores a new order for a reading list; entryIds must hold exactly the list's current entries.

Parameters ​

id ​

string

entryIds ​

string[]

Returns ​

Promise<ReadingListResult>

reorderLists() ​

reorderLists(listIds): Promise<ReadingListOrderResult>

Defined in: src/preload.ts:172

Stores a new order for the reading lists themselves; listIds must hold exactly the current lists.

Parameters ​

listIds ​

string[]

Returns ​

Promise<ReadingListOrderResult>