@appium/typedoc-plugin-appium/build/lib/options/reader.d.ts

TypeDoc plugin for Appium & its extensions

import { Options, OptionsReader } from 'typedoc';
import { AppiumPluginLogger } from '../logger';
/**
 * This befouls the options.
 *
 * It can do what has been undone and undo what has been done. It can make real your dreams... or nightmares.
 */
export declare class AppiumPluginOptionsReader implements OptionsReader {
    #private;
    /**
     * I don't know the point of `name`, but the interface requires it, so here.
     */
    readonly name = "naughty-appium-options-reader";
    /**
     * This needs to be higher than the value in `MarkdownOptionsReader`.
     */
    readonly priority = 2000;
    constructor(logger: AppiumPluginLogger);
    /**
     * Attempts to derive a title (for use in theme output) from a package's `package.json` if that package is an Appium extension
     * @param pkgJsonPath Path to a `package.json`
     */
    static getTitleFromPackageJson(pkgJsonPath: string): string | undefined;
    /**
     * Calls various private methods to override option values or provide defaults.
     * @param container - Options container
     */
    read(container: Options): void;
}
//# sourceMappingURL=reader.d.ts.map