mirror of
https://github.com/futurepress/epub.js.git
synced 2025-10-05 15:32:55 +02:00
Added type declarations
This commit is contained in:
parent
0da286b0a2
commit
6bfcd1e4eb
50 changed files with 1837 additions and 54 deletions
|
@ -53,7 +53,7 @@ class PageList {
|
|||
/**
|
||||
* Parse a Nav PageList
|
||||
* @private
|
||||
* @param {document} navHtml
|
||||
* @param {node} navHtml
|
||||
* @return {PageList.item[]} list
|
||||
*/
|
||||
parseNav(navHtml){
|
||||
|
@ -77,7 +77,7 @@ class PageList {
|
|||
/**
|
||||
* Page List Item
|
||||
* @private
|
||||
* @param {object} item
|
||||
* @param {node} item
|
||||
* @return {object} pageListItem
|
||||
*/
|
||||
item(item){
|
||||
|
@ -128,7 +128,7 @@ class PageList {
|
|||
/**
|
||||
* Get a PageList result from a EpubCFI
|
||||
* @param {string} cfi EpubCFI String
|
||||
* @return {string} page
|
||||
* @return {number} page
|
||||
*/
|
||||
pageFromCfi(cfi){
|
||||
var pg = -1;
|
||||
|
@ -165,7 +165,7 @@ class PageList {
|
|||
|
||||
/**
|
||||
* Get an EpubCFI from a Page List Item
|
||||
* @param {string} pg
|
||||
* @param {string | number} pg
|
||||
* @return {string} cfi
|
||||
*/
|
||||
cfiFromPage(pg){
|
||||
|
@ -188,7 +188,7 @@ class PageList {
|
|||
/**
|
||||
* Get a Page from Book percentage
|
||||
* @param {number} percent
|
||||
* @return {string} page
|
||||
* @return {number} page
|
||||
*/
|
||||
pageFromPercentage(percent){
|
||||
var pg = Math.round(this.totalPages * percent);
|
||||
|
@ -197,7 +197,7 @@ class PageList {
|
|||
|
||||
/**
|
||||
* Returns a value between 0 - 1 corresponding to the location of a page
|
||||
* @param {int} pg the page
|
||||
* @param {number} pg the page
|
||||
* @return {number} percentage
|
||||
*/
|
||||
percentageFromPage(pg){
|
||||
|
@ -216,6 +216,9 @@ class PageList {
|
|||
return percentage;
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroy
|
||||
*/
|
||||
destroy() {
|
||||
this.pages = undefined;
|
||||
this.locations = undefined;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue