Commit 290d22a8 authored by Robert Knight's avatar Robert Knight

Update docs for `PageInfo.{page, index}` properties

After some additional testing it seems the original comment was incorrect and
that `index` is only set in PDF-based ("pbk") books.
parent 4b79489f
...@@ -64,13 +64,13 @@ export type PageInfo = { ...@@ -64,13 +64,13 @@ export type PageInfo = {
* The page label for the first page of the segment. This is the page number * The page label for the first page of the segment. This is the page number
* that is displayed in the VitalSource navigation controls when the * that is displayed in the VitalSource navigation controls when the
* chapter is scrolled to the top. * chapter is scrolled to the top.
*
* This may be missing in EPUBs that do not contain page break information.
* It should always be present in PDF books.
*/ */
page?: string; page?: string;
/** /** Index of the current page. Only available in PDF-based books. */
* Index of the current segment within the sequence of pages or content
* documents that make up the book.
*/
index?: number; index?: number;
/** /**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment