https://github.com/au5ton/use-atom-feed

🎣 React Hook and custom parser for reading Atom feeds.
https://github.com/au5ton/use-atom-feed

atom-feed react react-hooks

Last synced: over 1 year ago
JSON representation

🎣 React Hook and custom parser for reading Atom feeds.

• Host: GitHub
• URL: https://github.com/au5ton/use-atom-feed
• Owner: au5ton
• License: mit
• Created: 2021-05-19T01:02:34.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-22T20:57:59.000Z (over 3 years ago)
• Last Synced: 2025-03-14T15:15:41.561Z (over 1 year ago)
• Topics: atom-feed, react, react-hooks
• Language: TypeScript
• Homepage: https://au5ton.github.io/use-atom-feed/
• Size: 898 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @au5ton/use-atom-feed

[![npm](https://img.shields.io/npm/v/@au5ton/use-atom-feed)](https://www.npmjs.com/@au5ton/use-atom-feed) [![CI](https://github.com/au5ton/use-atom-feed/actions/workflows/main.yml/badge.svg)](https://github.com/au5ton/use-atom-feed/actions/workflows/main.yml) ![types](https://badgen.net/npm/types/@au5ton/use-atom-feed) [![publish size](https://badgen.net/packagephobia/publish/@au5ton/use-atom-feed)](https://packagephobia.com/result?p=%40au5ton%2Fuse-atom-feed) [![minified + gzip](https://badgen.net/bundlephobia/minzip/@au5ton/use-atom-feed)](https://bundlephobia.com/result?p=@au5ton/use-atom-feed@1.0.2) [![dependency count](https://badgen.net/bundlephobia/dependency-count/@au5ton/use-atom-feed)](https://bundlephobia.com/result?p=@au5ton/use-atom-feed@1.0.2)

[React Hook](https://reactjs.org/docs/hooks-intro.html) and custom parser for reading [Atom feeds](https://validator.w3.org/feed/docs/atom.html).

Included is a custom Atom feed parser: [`Parser.ts`](src/Parser.ts). If you just need to parse a feed directly, this could be useful to you. Within `test/` are some sample feeds that are used for test cases.

The models for this project are adapted from the Atom standard and from the [World Wide Web Consortium](https://validator.w3.org/feed/docs/atom.html).

This project is bootstrapped by [TSDX](https://github.com/formium/tsdx).

## Documentation

Documentation is automatically generated by [TypeDoc](https://typedoc.org) and published to [au5ton.github.io/use-atom-feed/](https://au5ton.github.io/use-atom-feed/).