import { ProjectReflection, Reflection } from 'typedoc'; /** * An event emitted before and after the markdown of a page is rendered. * * @event */ export declare class MarkdownPageEvent< /** @ignore **/ Model = Reflection> extends Event { /** * The {@linkcode typedoc!ProjectReflection ProjectReflection} instance the renderer is currently processing. */ project: ProjectReflection; /** * The model that that is being rendered on this page. * Either a {@linkcode typedoc!DeclarationReflection DeclarationReflection} or {@linkcode typedoc!ProjectReflection ProjectReflection}. */ readonly model: Model; /** * The group title of the group reflection belongs to. */ group?: string; /** * The final markdown `string` content of the page. * * Should be rendered by layout templates and can be modified by plugins. */ contents?: string; /** * The url `string` of the page. */ url: string; /** * The complete `string` filename where the file will be written.. */ filename: string; /** * The frontmatter of this page represented as a key value object. This property can be utilised by other plugins. */ frontmatter?: Record; /** @hidden */ pageHeadings: any; /** @hidden */ pageSections: any; /** @hidden */ startNewSection: any; /** * Triggered before a document will be rendered. * @event */ static readonly BEGIN = "beginPage"; /** * Triggered after a document has been rendered, just before it is written to disc. * @event */ static readonly END = "endPage"; /** * @ignore */ constructor(name: string, model: Model); }