From f877c84453c552de435ce8f84d0af330b9fd1898 Mon Sep 17 00:00:00 2001
From: BlackAsLight <44320105+BlackAsLight@users.noreply.github.com>
Date: Sat, 9 Nov 2024 23:25:14 +1100
Subject: [PATCH] fix: JSDocs being removed from `decoder_stream.ts`

---
 src/decoder_stream.ts | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/decoder_stream.ts b/src/decoder_stream.ts
index 87f00bf..eed64b1 100644
--- a/src/decoder_stream.ts
+++ b/src/decoder_stream.ts
@@ -2,6 +2,21 @@ import { toByteStream } from "@std/streams/unstable-to-byte-stream";
 import type { QOIOptions } from "./types.ts";
 import { createDecoder } from "./_common.ts";
 
+/**
+ * The QOIDecoderStream is a TransformStream that decodes qoi image format into
+ * raw image data. The raw data is a sequence of `[ r, g, b, a ]` numbers.
+ *
+ * @example
+ * ```ts ignore
+ * import { QOIDecoderStream } from "img/qoi";
+ *
+ * const rawStream = (await Deno.open("image.qoi"))
+ *   .readable
+ *   .pipeThrough(new QOIDecoderStream(header => console.log(header)));
+ * ```
+ *
+ * @module
+ */
 export class QOIDecoderStream
   implements TransformStream<Uint8Array, Uint8Array> {
   #readable: ReadableStream<Uint8Array>;