annotatedtext-remark - v1.0.10
    Preparing search index...

    Interface IOptions

    IOptions

    interface IOptions {
        remarkoptions: Options;
        annotatetextnode(node: INode, text: string): null | IAnnotation;
        children(node: INode): INode[];
        interpretmarkup(text?: string): string;
    }
    Index

    Properties

    remarkoptions: Options

    Options for the remark parser.

    Methods

    • Function to annotate a text node.

      Parameters

      • node: INode
      • text: string

      Returns null | IAnnotation

    • Function to get the children of a node.

      Parameters

      • node: INode

      Returns INode[]

    • Function to interpret markup.

      Parameters

      • Optionaltext: string

      Returns string