knowmax-quest-types/dist/types/ICoverOptions.d.ts

Contains type definitions for communicating with Knowmax Quest.

/** Options for getting cover. */
export interface ICoverOptions {
    /** Return thumb instead of full image. Thumb will be of type JPG or SVG. Default true. */
    thumb?: boolean;
    /** If set to true only document version specific cover is returned. Otherwise allows to fall back to document specific image. Default false. */
    versionSpecific?: boolean;
    /** If set to true JSON reference info of requested document will be returned in case no cover image could be located.
     * The reference info includes document meta info to allow the client to determine alternative image. Default false. */
    softFail?: boolean;
}
//# sourceMappingURL=ICoverOptions.d.ts.map