1
0
Fork 0
mirror of https://github.com/futurepress/epub.js.git synced 2025-10-03 14:59:18 +02:00

Merge pull request #1239 from rafaelsaback/fix-locations-generate-type

Fix locations.generate's return type
This commit is contained in:
Fred Chasen 2022-01-07 15:49:31 -08:00 committed by GitHub
commit f6fece4f88
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 5 deletions

View file

@ -37,7 +37,7 @@ class Locations {
/** /**
* Load all of sections in the book to generate locations * Load all of sections in the book to generate locations
* @param {int} chars how many chars to split on * @param {int} chars how many chars to split on
* @return {object} locations * @return {Promise<Array<string>>} locations
*/ */
generate(chars) { generate(chars) {

View file

@ -5,13 +5,13 @@ import EpubCFI from "./epubcfi";
export default class Locations { export default class Locations {
constructor(spine: Spine, request?: Function, pause?: number); constructor(spine: Spine, request?: Function, pause?: number);
generate(chars: number): object; generate(chars: number): Promise<Array<string>>;
process(section: Section): Promise<Array<string>>; process(section: Section): Promise<Array<string>>;
locationFromCfi(cfi: string | EpubCFI): Location; locationFromCfi(cfi: string | EpubCFI): Location;
percentageFromCfi(cfi: string | EpubCFI): number; percentageFromCfi(cfi: string | EpubCFI): number;
percentageFromLocation(loc: number): number; percentageFromLocation(loc: number): number;
@ -19,7 +19,7 @@ export default class Locations {
cfiFromPercentage(percentage: number): string; cfiFromPercentage(percentage: number): string;
load(locations: string): Array<string>; load(locations: string): Array<string>;
save(): string; save(): string;