Class Processor

constructor

• new Processor(config?: {}): Processor

  Parameters

  • Optionalconfig: {}

  Returns Processor

config

Staticconfig

• get config(): object

  Get the static configuration map for this processor class. Uses hasOwnProperty to avoid inheriting a parent class's config object through the prototype chain when a subclass first accesses config.

  Returns object

createAnchor

• createAnchor(parent: any, ...rest: any[]): Inline

  Shorthand for createInline with context 'anchor'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Inline

createBlock

• createBlock(
      parent: Section | Block,
      context: string,
      source: string | string[],
      attrs: object,
      opts?: object,
  ): Block

  Create a generic block node and link it to the specified parent.

  Parameters

  • parent: Section | Block

    The parent node.

  • context: string

    The block context (e.g. 'paragraph', 'listing').

  • source: string | string[]

    The source content.

  • attrs: object

    A plain object of attributes.

  • Optionalopts: object

    An optional plain object of options.

  Returns Block

  a Block node with all properties properly initialized.

createExampleBlock

• createExampleBlock(parent: any, ...rest: any[]): Block

  Shorthand for createBlock with context 'example'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Block

createImageBlock

• createImageBlock(
      parent: Document | Section | Block,
      attrs: object,
      opts?: object,
  ): Block

  Create an image block node and link it to the specified parent.

  Parameters

  • parent: Document | Section | Block

    The parent of this new image block.

  • attrs: object

    A plain object of attributes to control how the image block is built. The target attribute sets the image source; alt sets the alt text.

  • Optionalopts: object

    An optional plain object of options.

  Returns Block

  a Block node with all properties properly initialized.

createInline

• createInline(
      parent: Block,
      context: string,
      text: string,
      opts?: object,
  ): Inline

  Create an inline node and bind it to the specified parent.

  Parameters

  • parent: Block

    The parent Block of this new inline node.

  • context: string

    The context of the inline node ('quoted', 'anchor', etc.).

  • text: string

    The text of the inline node.

  • Optionalopts: object

    An optional plain object of options:

    • type {string} - The subtype of the inline node context.
    • attributes {object} - Attributes to set on the inline node.

  Returns Inline

  an Inline node with all properties properly initialized.

createInlinePass

• createInlinePass(parent: any, ...rest: any[]): Inline

  Shorthand for createInline with context 'quoted'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Inline

createList

• createList(
      parent: Document | Section | Block,
      context: string,
      attrs?: object,
  ): List

  Create a list node and link it to the specified parent.

  Parameters

  • parent: Document | Section | Block

    The parent of this new list.

  • context: string

    The list context ('ulist', 'olist', 'colist', 'dlist').

  • Optionalattrs: object

    A plain object of attributes to set on this list block.

  Returns List

  a List node with all properties properly initialized.

createListingBlock

• createListingBlock(parent: any, ...rest: any[]): Block

  Shorthand for createBlock with context 'listing'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Block

createListItem

• createListItem(parent: List, text?: string): ListItem

  Create a list item node and link it to the specified parent.

  Parameters

  • parent: List

    The parent List of this new list item.

  • Optionaltext: string

    The text of the list item.

  Returns ListItem

  a ListItem node with all properties properly initialized.

createLiteralBlock

• createLiteralBlock(parent: any, ...rest: any[]): Block

  Shorthand for createBlock with context 'literal'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Block

createOpenBlock

• createOpenBlock(parent: any, ...rest: any[]): Block

  Shorthand for createBlock with context 'open'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Block

createParagraph

• createParagraph(parent: any, ...rest: any[]): Block

  Shorthand for createBlock with context 'paragraph'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Block

createPassBlock

• createPassBlock(parent: any, ...rest: any[]): Block

  Shorthand for createBlock with context 'pass'.

  Parameters

  • parent: any
  • ...rest: any[]

  Returns Block

createSection

• createSection(
      parent: Document | Section,
      title: string,
      attrs: object,
      opts?: object,
  ): Section

  Create a Section node in the same manner as the parser.

  Parameters

  • parent: Document | Section

    The parent Section or Document of this new Section.

  • title: string

    The String title of the new Section.

  • attrs: object

    A plain object of attributes to control how the section is built. Use the style attribute to set the name of a special section (e.g. appendix). Use the id attribute to assign an explicit ID, or set it to false to disable automatic ID generation (when sectids document attribute is set).

  • Optionalopts: object

    An optional plain object of options:

    • level {number} - The Integer level to assign; defaults to parent.level + 1.
    • numbered {boolean} - Flag to force numbering.

  Returns Section

  a Section node with all properties properly initialized.

parseAttributes

• parseAttributes(
      block: Section | Block,
      attrlist: string,
      opts?: object,
  ): Promise<object>

  Parse the attrlist String into a plain object of attributes.

  Parameters

  • block: Section | Block

    The current block (used for applying subs).

  • attrlist: string

    The list of attributes as a String.

  • Optionalopts: object

    An optional plain object of options:

    • positional_attributes {string[]} - Array of attribute names to map positional args to.
    • sub_attributes {boolean} - Enables attribute substitution on attrlist.

  Returns Promise<object>

  a plain object of parsed attributes.

parseContent

• parseContent(
      parent: Section | Block,
      content: string[] | Reader,
      attributes?: object,
  ): Promise<Section | Block>

  Parse blocks in the content and attach them to the parent.

  Parameters

  • parent: Section | Block

    The parent node.

  • content: string[] | Reader

    Lines or a Reader.

  • Optionalattributes: object

    Attributes to pass to the parser.

  Returns Promise<Section | Block>

  the parent node into which the blocks are parsed.

process

• process(..._args: any[]): void

  Parameters

  • ..._args: any[]

  Returns void

updateConfig

• updateConfig(config: any): void

  Parameters

  • config: any

  Returns void

StaticenableDsl

• enableDsl(): void

  Mix the DSL object for this processor class into its prototype.

  Returns void

Staticoption

• option(key: string, value: any): void

  Set a default option value for all instances of this processor class.

  Parameters

  • key: string

    The option key.

  • value: any

    The option value.

  Returns void

StaticuseDsl

• useDsl(): void

  Alias for enableDsl.

  Returns void