types: add createCompiler to MDX Typescript API (#1499)

mdx-js · Apr 1, 2021 · 5169bf1 · 5169bf1 · vercel · Apr 1, 2021
1 parent d140f95
commit 5169bf1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/packages/mdx/types/index.d.ts b/packages/mdx/types/index.d.ts
@@ -48,12 +48,20 @@ declare namespace mdx {
   function sync(mdx: string, options?: Options): string
 
   /**
-   * Generated an MDX compiler
+   * Generated an MDX AST compiler
    *
    * @param options transform and compiler options
    * @returns Unified Processor for MDX
    */
   function createMdxAstCompiler(options?: Options): Processor
+
+  /**
+   * Generated an MDX compiler
+   *
+   * @param options transform and compiler options
+   * @returns Unified Processor for MDX
+   */
+  function createCompiler(options?: Options): Processor
 }
 
 /**

diff --git a/packages/mdx/types/mdx-test.ts b/packages/mdx/types/mdx-test.ts
@@ -19,3 +19,9 @@ mdx.createMdxAstCompiler({skipExport: false}) // $ExpectType Processor<Settings>
 mdx.createMdxAstCompiler({wrapExport: 'React.memo'}) // $ExpectType Processor<Settings>
 mdx.createMdxAstCompiler({rehypePlugins: [() => () => ({type: 'test'})]}) // $ExpectType Processor<Settings>
 mdx.createMdxAstCompiler({remarkPlugins: [() => () => ({type: 'test'})]}) // $ExpectType Processor<Settings>
+
+mdx.createCompiler() // $ExpectType Processor<Settings>
+mdx.createCompiler({skipExport: false}) // $ExpectType Processor<Settings>
+mdx.createCompiler({wrapExport: 'React.memo'}) // $ExpectType Processor<Settings>
+mdx.createCompiler({rehypePlugins: [() => () => ({type: 'test'})]}) // $ExpectType Processor<Settings>
+mdx.createCompiler({remarkPlugins: [() => () => ({type: 'test'})]}) // $ExpectType Processor<Settings>