/** * Copyright 2017-present Palantir Technologies, Inc. All rights reserved. * Licensed under the BSD-3 License as modified (the “License”); you may obtain * a copy of the license in the LICENSE and PATENTS files in the root of this * repository. */ import { ICompiler, IFile, IPlugin, ITypescriptPluginData } from "../../client"; export { ITypescriptPluginData }; export interface ITypescriptPluginOptions { /** * Array of patterns (string or RegExp) to exclude members by name. * Strings will be converted to regular expressions through `string.match(pattern)`. * * Note that excluded members will still be parsed by the compiler, so they can be referenced * by other symbols, but they will not appear in the output data. */ excludeNames?: Array; /** * Array of patterns (string or RegExp) to exclude members based on file path. * See `excludeNames` above for usage notes. */ excludePaths?: Array; /** * Specify the branch name to use when generating source file URLs. * If omitted, the current commit hash will be used. * @see ITsDocBase.url */ gitBranch?: string; /** * Enable parsing of `.d.ts` files. * @default false */ includeDeclarations?: boolean; /** * Whether files in `node_modules` should be included in the TypeScript * compilation context. This is disabled by default because it typically * results in an explosion of data size due to including all types from _all * installed packages_, the vast majority of which are not useful for * documenting your own APIs. * * Enable at your own risk, and consider using the `excludeNames` and * `excludePaths` options above to filter the output data. * @default false */ includeNodeModules?: boolean; /** * Whether `private` fields should be included in the data. * This is disabled by default as `private` fields typically do not need to be publicly documented. * @default false */ includePrivateMembers?: boolean; /** * Whether members not marked `export` should be included in the data. * This is disabled by default as non-exported members typically do not need to be publicly documented. * @default false */ includeNonExportedMembers?: boolean; /** Path to tsconfig file. */ tsconfigPath?: string; /** * If enabled, logs messages and compiler errors to the console. * Note that compiler errors are ignored by Typedoc so they do not affect docs generation. * @default false */ verbose?: boolean; } export declare class TypescriptPlugin implements IPlugin { private options; private app; constructor(options?: ITypescriptPluginOptions); compile(files: IFile[], compiler: ICompiler): ITypescriptPluginData; private getTypedocProject; }