mfdoc
Version:
Auto generate JS SDK and HTTP API documentation
34 lines (33 loc) • 1.1 kB
TypeScript
import { MfdocHttpEndpointDefinitionTypePrimitive } from './mfdoc.js';
export declare function genHttpApiEndpointsInfo(params: {
endpoints: MfdocHttpEndpointDefinitionTypePrimitive[];
includeTags?: string[];
ignoreTags?: string[];
includeTagsRegExp?: RegExp[];
ignoreTagsRegExp?: RegExp[];
includePaths?: string[];
ignorePaths?: string[];
includePathsRegExp?: RegExp[];
ignorePathsRegExp?: RegExp[];
includeNames?: string[];
ignoreNames?: string[];
includeNamesRegExp?: RegExp[];
ignoreNamesRegExp?: RegExp[];
outputPath: string;
}): Promise<void>;
export declare function genHttpApiEndpointsInfoCmd(params: {
srcPath: string;
includeTags?: string[];
ignoreTags?: string[];
includeTagsRegExp?: RegExp[];
ignoreTagsRegExp?: RegExp[];
includePaths?: string[];
ignorePaths?: string[];
includePathsRegExp?: RegExp[];
ignorePathsRegExp?: RegExp[];
includeNames?: string[];
ignoreNames?: string[];
includeNamesRegExp?: RegExp[];
ignoreNamesRegExp?: RegExp[];
outputPath: string;
}): Promise<void>;