feat: Add types for renderStream & pipeableStream

rschristian · rschristian · commit 1cf9354db25a · 2024-05-26T01:46:11.000-05:00
diff --git a/src/stream-node.d.ts b/src/stream-node.d.ts
@@ -0,0 +1,19 @@
+import { VNode } from 'preact';
+import { WritableStream } from 'node:stream';
+
+interface RenderToPipeableStreamOptions {
+	onShellReady?: () => void;
+	onAllReady?: () => void;
+	onError?: (error: any) => void;
+}
+
+interface PipeableStream {
+	abort: () => void;
+	pipe: (writable: WritableStream) => void;
+}
+
+export function renderToReadableStream(
+	vnode: VNode,
+	options: RenderToPipeableStreamOptions,
+	context?: any
+): PipeableStream;
diff --git a/src/stream-node.js b/src/stream-node.js
@@ -8,11 +8,17 @@ import { renderToChunks } from './lib/chunked.js';
  * @property {(error) => void} [onError]
  */
 
+/**
+ * @typedef {object} PipeableStream
+ * @property {() => void} abort
+ * @property {(writable: import('stream').Writable) => void} pipe
+ */
+
 /**
  * @param {import('preact').VNode} vnode
  * @param {RenderToPipeableStreamOptions} options
  * @param {any} [context]
- * @returns {{}}
+ * @returns {PipeableStream}
  */
 export function renderToPipeableStream(vnode, options, context) {
 	const encoder = new TextEncoder('utf-8');
diff --git a/src/stream.d.ts b/src/stream.d.ts
@@ -0,0 +1,10 @@
+import { VNode } from 'preact';
+
+interface RenderStream extends ReadableStream<Uint8Array> {
+	allReady: Promise<void>;
+}
+
+export function renderToReadableStream(
+	vnode: VNode,
+	context?: any
+): RenderStream;
