react-docgen/dist/main.d.ts

A library to extract information from React components for documentation generation.

/// <reference types="node" resolution-mode="require"/>
import * as builtinHandlers from './handlers/index.js';
import * as builtinResolvers from './resolver/index.js';
import { makeFsImporter } from './importer/index.js';
import * as utils from './utils/index.js';
import type { Documentation } from './Documentation.js';
import type DocumentationBuilder from './Documentation.js';
import type { Resolver, ResolverClass, ResolverFunction } from './resolver/index.js';
import type { Importer } from './importer/index.js';
import type { Handler } from './handlers/index.js';
import type FileState from './FileState.js';
import type { Config } from './config.js';
import { defaultHandlers } from './config.js';
import { ERROR_CODES } from './error.js';
declare const builtinImporters: {
    fsImporter: Importer;
    ignoreImporter: Importer;
};
declare module '@babel/traverse' {
    interface HubInterface {
        file: FileState;
        parse: typeof FileState.prototype.parse;
        import: typeof FileState.prototype.import;
    }
    interface Hub {
        file: FileState;
        parse: typeof FileState.prototype.parse;
        import: typeof FileState.prototype.import;
    }
}
/**
 * Parse the *src* and scan for react components based on the config
 * that gets supplied.
 *
 * The default resolvers look for *exported* react components.
 *
 * By default all handlers are applied, so that all possible
 * different use cases are covered.
 *
 * The default importer is the fs-importer that tries to resolve
 * files based on the nodejs resolve algorithm.
 */
declare function defaultParse(src: Buffer | string, config?: Config): Documentation[];
export type { NodePath } from '@babel/traverse';
export type * as babelTypes from '@babel/types';
export { builtinHandlers, builtinResolvers, builtinImporters, defaultHandlers, makeFsImporter, defaultParse as parse, utils, ERROR_CODES, };
export type { Importer, Handler, Resolver, ResolverClass, ResolverFunction, FileState, Config, Documentation, DocumentationBuilder, };