fix: define renderToStream to return promise (#1681)

* fix: define renderToStream to return promise The old return type was `string` which is wrong, because it returns a `promise` which resolves in a `string` instead.
diegomura · Jan 26, 2022 · 4eddbf5 · 4eddbf5
1 parent 5e32cb9
commit 4eddbf5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.changeset/hip-trainers-tickle.md b/.changeset/hip-trainers-tickle.md
@@ -0,0 +1,5 @@
+---
+'@react-pdf/renderer': patch
+---
+
+defined renderToStream to return promise
diff --git a/packages/renderer/index.d.ts b/packages/renderer/index.d.ts
@@ -497,7 +497,7 @@ declare namespace ReactPDF {
     document: React.ReactElement<DocumentProps>,
   ) => Promise<NodeJS.ReadableStream>;
 
-  const renderToString: (document: React.ReactElement<DocumentProps>) => string;
+  const renderToString: (document: React.ReactElement<DocumentProps>) => Promise<string>;
 
   const renderToFile: (
     document: React.ReactElement<DocumentProps>,