@bitjson/typedoc
Version:
Create api documentation for TypeScript projects.
36 lines (35 loc) • 1.18 kB
TypeScript
import { TemplateDelegate } from 'handlebars';
import { Event } from '../utils/events';
import { ProjectReflection } from '../models/reflections/project';
import { UrlMapping } from './models/UrlMapping';
import { NavigationItem } from './models/NavigationItem';
export declare class RendererEvent extends Event {
readonly project: ProjectReflection;
settings: any;
readonly outputDirectory: string;
urls?: UrlMapping[];
static BEGIN: string;
static END: string;
constructor(name: string, outputDirectory: string, project: ProjectReflection);
createPageEvent(mapping: UrlMapping): PageEvent;
}
export declare class PageEvent extends Event {
project: ProjectReflection;
settings: any;
filename: string;
url: string;
model: any;
template?: TemplateDelegate;
templateName: string;
navigation?: NavigationItem;
toc?: NavigationItem;
contents?: string;
static BEGIN: string;
static END: string;
}
export declare class MarkdownEvent extends Event {
readonly originalText: string;
parsedText: string;
static PARSE: string;
constructor(name: string, originalText: string, parsedText: string);
}