@appium/typedoc-plugin-appium/build/lib/converter/index.d.ts

TypeDoc plugin for Appium & its extensions

/**
 * Converts code parsed by TypeDoc into a data structure describing the commands and execute methods, which will later be used to create new {@linkcode typedoc#DeclarationReflection} instances in the TypeDoc context.
 *
 * The logic in this module is highly dependent on Appium's extension API, and is further dependent on specific usages of TS types.  Anything that will be parsed successfully by this module must use a `const` type alias in TS parlance.  For example:
 *
 * ```ts
 * const METHOD_MAP = {
 *   '/status': {
 *     GET: {command: 'getStatus'}
 *   },
 *   // ...
 * } as const; // <-- required
 * ```
 * @module
 */
import { Context } from 'typedoc';
import { AppiumPluginLogger } from '../logger';
import { ProjectCommands } from '../model';
/**
 * Converts declarations into information about the commands found within
 * @param ctx - Current TypeDoc context
 * @param parentLog - Logger
 * @returns All commands found in the project
 */
export declare function convertCommands(ctx: Context, parentLog: AppiumPluginLogger): ProjectCommands | undefined;
export * from '../model/builtin-commands';
export * from './base-converter';
export * from './builder';
export * from './builtin-external-driver';
export * from './builtin-method-map';
export * from './comment';
export * from './exec-method-map';
export * from './external';
export * from './method-map';
export * from './overrides';
export * from './types';
export * from './utils';
//# sourceMappingURL=index.d.ts.map