mdast2docx 0.0.0-beta.0

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { OutputType, type IPropertiesOptions } from "@mayank1513/docx";
+import type { Root } from "mdast";
+import { type ISectionProps } from "./section";
+/**
+ * Defines document properties, excluding sections and footnotes (which are managed internally).
+ */
+type IDocxProps = Omit<IPropertiesOptions, "sections" | "footnotes">;
+/**
+ * Represents the input MDAST tree(s) for conversion.
+ * It can be a single root node or an array of objects containing the AST and optional section properties.
+ */
+type IInputMDAST = Root | {
+    ast: Root;
+    props?: ISectionProps;
+}[];
+/**
+ * Converts an MDAST (Markdown Abstract Syntax Tree) into a DOCX document.
+ * @param astInputs - A single or multiple MDAST trees with optional section properties.
+ * @param docxProps - General document properties. @see https://docx.js.org/#/usage/document
+ * @param defaultSectionProps - Default properties for each document section. @see https://docx.js.org/#/usage/sections
+ * @param outputType - The desired output format (default: `"blob"`). @see https://docx.js.org/#/usage/packers
+ * @returns A DOCX document in the specified format.
+ */
+export declare const toDocx: (astInputs: IInputMDAST, docxProps: IDocxProps, defaultSectionProps: ISectionProps, outputType?: OutputType) => Promise<string | ArrayBuffer | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | Blob | readonly number[]>;
+export type { ISectionProps, IDocxProps, IInputMDAST };