@au5ton/use-atom-feed

Index

Namespaces

Guards

Interfaces

Type aliases

Functions

Type aliases

AtomLinkRelType

AtomLinkRelType: "alternate" | "enclosure" | "related" | "self" | "via"

AtomTextType

AtomTextType: "text" | "html" | "xhtml"

Functions

parseAtomFeed

parseAtomFeed(data: string): AtomFeed

- Defined in Parser.ts:18
parses the feed

Parameters
- data: string
Returns AtomFeed

useAtomFeed

useAtomFeed(feedURL: string, options?: SWRConfiguration): Response<AtomFeed>

- Defined in useAtomFeed.ts:19
The React hook used for reading the Atom feed.

Parameters
- feedURL: string
  
  The URL of the Atom feed
- Optional options: SWRConfiguration
  
  Options that are passed to useSWR() behind the scenes. More info: https://swr.vercel.app/docs/options#options
Returns Response<AtomFeed>

The decoded Atom feed or any errors seen along the way

Generated using TypeDoc