honkit/lib/api/encodeProgress.d.ts

HonKit is building beautiful books using Markdown.

import { EncodedNavigation } from "./encodeNavigation";
import Output from "../models/output";
import Page from "../models/page";
export type EncodedChapters = Array<EncodedNavigation[string] & {
    path: string;
    done: boolean;
    percent: number;
}>;
export type PartialEncodedChapterValue = EncodedNavigation[string] & Partial<{
    path: string;
    done: boolean;
    percent: number;
}>;
export type EncodeProgress = {
    prevPercent: number;
    percent: number;
    current: number;
    chapters: EncodedChapters;
};
/**
 page.progress is a deprecated property from GitBook v2
 */
declare function encodeProgress(output: Output, page: Page): EncodeProgress;
export default encodeProgress;
//# sourceMappingURL=encodeProgress.d.ts.map