Skip to content

Commit

Permalink
fix: JSDocs being removed from decoder_stream.ts
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackAsLight committed Nov 9, 2024
1 parent cc370b8 commit f877c84
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/decoder_stream.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
Expand Down

0 comments on commit f877c84

Please sign in to comment.