chore: update markdown type definition

maizzle · Aug 29, 2024 · 9dd5708 · 9dd5708
1 parent daea021
commit 9dd5708
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -37,10 +37,11 @@ declare namespace MaizzleFramework {
    *
    * @param {string} input The Markdown string to compile.
    * @param {MarkdownConfig} [options] A configuration object for the Markdown compiler.
-   * @returns {string} The compiled HTML string.
-   * @see https://maizzle.com/docs/transformers/markdown
+   * @param {PostHTMLConfig} [posthtmlOptions] A configuration object for PostHTML.
+   * @returns {Promise<string>} The compiled HTML string.
+   * @see https://maizzle.com/docs/markdown#api
    */
-  function markdown(input: string, options?: MarkdownConfig): string;
+  function markdown(input: string, options?: MarkdownConfig, posthtmlOptions?: PostHTMLConfig): Promise<string>;
 
   /**
    * Prevent widow words inside a tag by adding a `&nbsp;` between its last two words.