types: add support for buffer, other return values

wooorm · web-flow · commit b22bf8e1fb61 · 2021-07-04T18:06:29.000+02:00
Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com> Closes GH-144.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -357,9 +357,9 @@ export interface Compiler {
   /**
    * Transform an AST node/tree into text
    *
-   * @returns Compiled text
+   * @returns Compiled text (for `file.value`) or something else (for `file.result`)
    */
-  compile(): string
+  compile(): unknown
 }
 
 /**
@@ -373,9 +373,9 @@ export type CompilerConstructor = new (node: Node, file: VFile) => Compiler
  *
  * @param node Node/tree to be stringified
  * @param file File associated with node
- * @returns Compiled text
+ * @returns Compiled text (for `file.value`) or something else (for `file.result`)
  */
-export type CompilerFunction = (node: Node, file: VFile) => string
+export type CompilerFunction = (node: Node, file: VFile) => unknown
 
 /**
  * Access results from transforms
