jsdoc comments

README.md

@@ -10,7 +10,7 @@ Fetch and parse XML documents using the power of JavaScript web streams and asyn
 
 ## Usage
 
-See the `examples` directory for platform specific examples.
+Add dependency from JSR: [@dbushell/xml-streamify](https://jsr.io/@dbushell/xml-streamify). See the `examples` directory for platform specific examples.
 
 ```javascript
 import {parse} from "jsr:@dbushell/[email protected]";

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbushell/xml-streamify",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "exports": {
     ".": "./mod.ts",
     "./node": "./src/node.ts",

mod.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Fetch and parse XML documents using web streams and async iterators.
+ */
 export * from './src/node.ts';
 export * from './src/parse.ts';
 export * from './src/stream.ts';

src/node.ts

@@ -1,6 +1,8 @@
 /**
- * XML node with helper methods to read data and traverse the tree
+ * @module
+ * Module exports an XML Node class
  */
+/** XML node with helper methods to read data and traverse the tree */
 export class Node {
   #type: string;
   #children: Array<Node>;

src/parse.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Module export an async generator function for parsing a streamed XML document.
+ */
 import type {ParseOptions} from './types.ts';
 import {NodeType} from './types.ts';
 import {Node} from './node.ts';
@@ -9,6 +13,12 @@ const ignoreTypes: Partial<Record<NodeType, keyof ParseOptions>> = {
   [NodeType.DOCTYPE]: 'ignoreDoctype'
 } as const;
 
+/**
+ * Async generator function for parsing a streamed XML document
+ * @param url      URL to fetch and parse
+ * @param options  Parsing options {@link ParseOptions}
+ * @returns Yields parsed XML nodes {@link Node}
+ */
 export async function* parse(
   url: string | URL,
   options?: ParseOptions

src/stream.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Module exports a `TransformStream` class for decoding binary XML streams into structured data.
+ */
 import {NodeType, StateType} from './types.ts';
 
 type State = NodeType | StateType;
@@ -25,6 +29,7 @@ const ENTITIES = {
   }
 } as const;
 
+/** Transformer object for `TransformStream` constructed by `XMLStream` */
 export const transformer: Transformer<Uint8Array, [NodeType, string]> & {
   buf: string;
   state: State;
@@ -91,9 +96,7 @@ export const transformer: Transformer<Uint8Array, [NodeType, string]> & {
   }
 };
 
-/**
- * Convert a binary XML stream into a stream of XML nodes
- */
+/** Transform a binary XML stream into a stream of structured XML data */
 export class XMLStream extends TransformStream<Uint8Array, [NodeType, string]> {
   constructor() {
     super({...transformer});

src/types.ts

@@ -1,3 +1,8 @@
+/**
+ * @module
+ * Types for `@dbushell/xml-streamify`
+ */
+/** Options for `parse` async generator function */
 export interface ParseOptions {
   /** Abort signal for fetch and parser */
   signal?: AbortSignal;