https://github.com/dbushell/xml-streamify

Fetch and parse XML with JavaScript web streams and async iterators ✨
https://github.com/dbushell/xml-streamify

async bun deno iterator javascript nodejs stream xml

Last synced: 24 days ago
JSON representation

Fetch and parse XML with JavaScript web streams and async iterators ✨

• Host: GitHub
• URL: https://github.com/dbushell/xml-streamify
• Owner: dbushell
• License: mit
• Created: 2023-10-19T07:03:32.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-19T05:56:18.000Z (about 2 months ago)
• Last Synced: 2024-09-30T10:05:05.610Z (about 1 month ago)
• Topics: async, bun, deno, iterator, javascript, nodejs, stream, xml
• Language: TypeScript
• Homepage:
• Size: 46.9 KB
• Stars: 20
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📰 XML Streamify

[![JSR](https://jsr.io/badges/@dbushell/xml-streamify?labelColor=98e6c8&color=333)](https://jsr.io/@dbushell/xml-streamify) [![NPM](https://img.shields.io/npm/v/@dbushell/xml-streamify?labelColor=98e6c8&color=333)](https://www.npmjs.com/package/@dbushell/xml-streamify)

Fetch and parse XML documents using the power of JavaScript web streams and async iterators ✨

* Small, fast, zero dependencies †

* Work with data before the fetch is complete

* Cross-runtime support (Bun, Deno, Node, and web browsers)

**This is experimental work in progress.** But it does seem to work. It was designed to parse RSS feeds.

## Usage

The `parse` generator function is the main export. Below is a basic example that logs RSS item titles as they're found:

```javascript

import {parse} from "@dbushell/xml-streamify";

for await (const node of parse('https://dbushell.com/rss.xml')) {

  if (node.is('channel', 'item')) {

    console.log(node.first('title').innerText);

  }

}

```

See [`src/types.ts`](/src/types.ts) for `parse` options.

`parse` uses a lower level `XMLStream` that can be used alone:

```javascript

const response = await fetch('https://dbushell.com/rss.xml');

const stream = response.body.pipeThrough(new XMLStream());

for await (const [type, value] of stream) {

  // e.g. declaration: 

  console.log(`${type}: ${value}`);

}

```

## Advanced

See the `examples` directory for more advanced and platform specific examples.

In the `examples/advanced` directory there is a Deno web server. It will proxy RSS feeds, add CORS headers, and throttle streaming speed for testing. Run `deno run -A examples/advanced/mod.ts` for the full example script.

## Notes

This project may not be fully XML compliant. It can handle XHTML in some cases. It will not parse HTML where elements like `` are not self-closing and `
` do not require a closing `
` for example.


Browsers may need a [polyfill](https://bugs.chromium.org/p/chromium/issues/detail?id=929585#c10) until they support async iterator on `ReadableStream`.

† bring your own HTML entities decoder

* * *

[MIT License](/LICENSE) | Copyright © 2024 [David Bushell](https://dbushell.com)