Merge branch 'update-types'

silvenon · Apr 14, 2024 · d283337 · d283337
2 parents 1af1923 + ab3b762
commit d283337
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 714 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,15 +1,20 @@
 /**
  * remark plugin to implement SmartyPants.
  *
- * @type {import('unified').Plugin<[Options?] | void[], Root>}
+ * @type {import('unified').Plugin<[Options?], Root>}
  */
-
-import { Options } from "retext-smartypants";
-import { Transformer } from "unified";
+import type { Options } from "retext-smartypants";
+import type { Transformer } from "unified";
 import { Root } from "mdast";
 
 export { Options };
 
+/**
+ * Applies SmartyPants transformation to a Markdown Abstract Syntax Tree (MDAST).
+ *
+ * @param {Options?} options - Configuration options for SmartyPants.
+ * @returns {Transformer<Root, Root>?} - A transformer for the MDAST.
+ */
 export default function remarkSmartypants(
-  options?: void | Options,
-): void | Transformer<Root, Root>;
+  options?: Options,
+): Transformer<Root, Root> | undefined | void;