Variable BooksApiConst

Type Declaration

• chapters: function

  • chapters(bookId: number): Promise<ApiResponse<BookChaptersResponse>>

    Fetch a book's chapters in reading order.

    Parameters

    • bookId: number

      Book ID

    Returns Promise<ApiResponse<BookChaptersResponse>>

    Promise with the chapter list

• get: function

  • get(bookId: number): Promise<ApiResponse<BookResponse>>

    Fetch a single book's metadata, progress and chapters.

    Parameters

    • bookId: number

      Book ID

    Returns Promise<ApiResponse<BookResponse>>

    Promise with the book and chapters, or an error envelope if it is gone

• importEpub: function

  • importEpub(formData: FormData): Promise<ApiResponse<BookImportResponse>>

    Import an EPUB as a book.

    Parameters

    • formData: FormData

      Multipart body carrying the file plus LgID/TxLgID, and optionally TxTitle and TextTags

    Returns Promise<ApiResponse<BookImportResponse>>

    Promise with the created book's ID and a message

• list: function

  • list(
        languageId: number | null,
        page: number,
    ): Promise<ApiResponse<BookListResponse>>

    List books, newest first, optionally filtered to one language.

    Parameters

    • languageId: number | null

      Language to filter by, or null for all languages

    • page: number

      1-based page number

    Returns Promise<ApiResponse<BookListResponse>>

    Promise with the page of books and its pagination block

• remove: function

  • remove(bookId: number): Promise<ApiResponse<BookMutationResponse>>

    Delete a book and its chapters.

    Parameters

    • bookId: number

      Book ID

    Returns Promise<ApiResponse<BookMutationResponse>>

    Promise with the outcome message

• setProgress: function

  • setProgress(
        bookId: number,
        chapterNum: number,
    ): Promise<ApiResponse<BookMutationResponse>>

    Record which chapter the reader has reached.

    Parameters

    • bookId: number

      Book ID

    • chapterNum: number

      1-based chapter number

    Returns Promise<ApiResponse<BookMutationResponse>>

    Promise with the outcome message