retext-latin/index.d.ts

retext plugin to parse Latin-script prose

import type {Nodes, Paragraph, Root, Sentence} from 'nlcst'
import type {Plugin} from 'unified'

// See `parse-latin`.
type Extension<Node extends Nodes> = (node: Node) => undefined | void

/**
 * Add support for parsing Latin-script natural language.
 *
 * @this
 *   Unified processor.
 * @returns
 *   Nothing.
 */
declare const retextLatin: Plugin<[], string, Root>
export default retextLatin

// Add custom data supported when `retext-latin` is added.
declare module 'unified' {
  interface Data {
    /**
     * List of extensions to transform paragraph nodes.
     */
    nlcstParagraphExtensions?: Array<Extension<Paragraph>>
    /**
     * List of extensions to transform root nodes.
     */
    nlcstRootExtensions?: Array<Extension<Root>>
    /**
     * List of extensions to transform sentence nodes.
     */
    nlcstSentenceExtensions?: Array<Extension<Sentence>>
  }
}