Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hughrun/feedfinder
nodejs package for finding RSS and Atom feeds from a given URL and vice-versa
https://github.com/hughrun/feedfinder
atom feedfinder nodejs rss
Last synced: about 1 month ago
JSON representation
nodejs package for finding RSS and Atom feeds from a given URL and vice-versa
- Host: GitHub
- URL: https://github.com/hughrun/feedfinder
- Owner: hughrun
- License: gpl-3.0
- Created: 2019-07-24T02:29:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T10:29:36.000Z (3 months ago)
- Last Synced: 2024-11-11T13:11:54.590Z (about 1 month ago)
- Topics: atom, feedfinder, nodejs, rss
- Language: HTML
- Size: 381 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# feedfinder
nodejs package for finding RSS and Atom feeds from a given URL and vice-versa
[Reporting bugs or proposing changes](contributing.md)
[Usage](#usage)
[Methods](#methods)
[Caveats](#caveats)
## Usage
To install:
```bash
npm install @hughrun/feedfinder
```
In your code:
```javascript
const feedfinder = require('@hughrun/feedfinder')
feedfinder.getFeed(url)
.then( x => {
console.log(x)
// returns an object
})
.catch( e => {
console.error(e)
// returns a string
})
feedfinder.getSite(feed)
.then( x => {
console.log(x)
// returns an object
})
.catch( e => {
console.error(e)
// returns a string
})
```
## Methods
All _feedfinder_ methods are Promises.
### getFeed
`getFeed(url)` takes a full url (i.e. including protocol) and returns an object with the given url, the feed url, and the site name, or alternatively returns an error in the form of a string.
Examples:
```javascript
feedfinder.getFeed('http://hughrundle.net')
/*
returns:
{
url: 'https://hughrundle.net',
feed: 'https://www.hughrundle.net/rss/',
title: 'Information Flaneur'
}
*/
feedfinder.getFeed('http://nla.gov.au')
// returns error: 'No link to RSS or Atom feed found at this URL'
feedfinder.getFeed("https://www.example.com")
// returns error: 'URL cannot be found'
```
Note that the error message is returned as an error - so if you don't catch it, nothing is returned.
### getSite
`getSite(url)` takes a full feed URL and returns an object with the site url, the provided feed url, and the site name, or alternatively returns an error in the form of a string.
Examples:
```javascript
feedfinder.getSite('https://www.hughrundle.net/rss')
/*
Returns:'
{
url: 'https://www.hughrundle.net/',
feed: 'https://www.hughrundle.net/rss',
title: 'Information Flaneur'
}
*/
feedfinder.getSite('https://www.hughrundle.net')
// returns: 'No RSS or Atom file found at this URL'
feedfinder.getSite("https://www.example.com/rss")
// returns error: 'URL cannot be found'
```
## Caveats
Well-formed web pages will list their RSS/Atom feed in a ``element in the head, however sometimes there is a feed for a page but it is not referred to in a head `` element. In this case, _feedfinder_ looks in the body of the page for anchor links (i.e. `` elements) that look like they might point to feeds. If there is more than one link to a likely feed, **the first one listed will be used**. This is likely to be what you want, but there is only so much that can be done with poorly-structured pages so ...it might not be.
YouTube user, channel and playlist pages should all work as long as YouTube does not change the way it constructs RSS feeds - they are not listed on pages, but as the form is known, we can construct them from the ID.
## Acknowledgements
Thanks to Sam Popowich and Tim Sherrat for licensing their blogs CC-BY, thus allowing me to use their homepages and feed files as examples for testing.