Interface ITransformResult

interface ITransformResult {
    content: string;
    contentLineOffset: number;
    features: IFeatures;
    frontmatter?: {
        markmap?: IMarkmapJSONOptions;
        title?: string;
    };
    root: IPureNode;
}

Hierarchy (view full)

ITransformContext
- ITransformResult

Index

Properties

content contentLineOffset features frontmatter? root

Properties

content

content: string

contentLineOffset

contentLineOffset: number

The index of line where content without frontmatter starts

features

features: IFeatures

`Optional` frontmatter

frontmatter?: {
markmap?: IMarkmapJSONOptions;
title?: string;
}

Type declaration

Optional markmap?: IMarkmapJSONOptions
Optional title?: string

root

root: IPureNode

Generated using TypeDoc