https://github.com/bevry-archive/feedr

Deprecated: Use node-fetch, fetch-h2, fetch-lite, isomorphic-unfetch
https://github.com/bevry-archive/feedr

archived cson http-request json nodejs xml yaml

Last synced: 3 months ago
JSON representation

Deprecated: Use node-fetch, fetch-h2, fetch-lite, isomorphic-unfetch

• Host: GitHub
• URL: https://github.com/bevry-archive/feedr
• Owner: bevry-archive
• License: other
• Created: 2012-10-21T19:57:35.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2019-12-09T08:55:32.000Z (about 5 years ago)
• Last Synced: 2024-04-08T15:41:52.065Z (10 months ago)
• Topics: archived, cson, http-request, json, nodejs, xml, yaml
• Language: JavaScript
• Homepage:
• Size: 513 KB
• Stars: 58
• Watchers: 4
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


Feedr

































Use feedr to fetch the data from a remote url, respect its caching, and parse its data. Despite its name, it's not just for feed data but also for all data that you can feed into it (including binary data).

Install


npm



Install: npm install --save feedr



Require: require('feedr')





Editions


This package is published with the following editions:






feedr aliases feedr/source/index.js





feedr/source/index.js is esnext source code with require for modules



Environments older than Node.js v8 may need Babel's Polyfill or something similar.


## Usage

``` javascript

// Create a new feedr instance

const feedr = require('feedr').create({/* optional configuration */})

// Prepare our feeds that we want read

const feeds = {

	someAtomFeed: 'https://github.com/bevry/feedr/commits/for-testing.atom'

	someJsonFile: 'https://raw.githubusercontent.com/bevry/feedr/for-testing/package.json'

}

// Read a single feed

feedr.readFeed(feeds.someAtomFeed, {/* optional configuration */}, function (err, data, headers) {

	console.log(err, data, headers)

})

// Read all the feeds together

feedr.readFeeds(feeds, {/* optional configuration */}, function (err, result) {

	console.log(err, result.someAtomFeed, result.someJsonFile)

})

```

## Configuration

Feed configuration defaults / global configuration properties are:

- `log` defaults to `null`, log function to use

- `tmpPath` defaults to system tmp path, the tempory path to cache our feedr results to

- `cache` defaults to one day `1000*60*60*24`, available values:

	- `Number` prefers to use the cache when it is within the range of the number in milliseconds

	- `true` prefers to use the cache when the response headers indicate that the cache is still valid

	- `"preferred"` will always use the cache if the cache exists

	- `false` will never use the cache

- `xml2jsOptions` defaults to `null`, the options to send to [xml2js](https://github.com/Leonidas-from-XIV/node-xml2js)

- `requestOptions` defaults to `null`, the options to send to [request](https://github.com/mikeal/request)

Feed configuration properties are:

- `url` required, the url to fetch

- `hash` defaults to hash of the url, the hashed url for caching

- `name` defaults to hash, the name of the feed for use in debugging

- `path` defaults to tmp feed path, the path to save the file to

- `parse` defaults to `true`, whether or not we should attempt to parse the response data, supported values are `xml`, `json`, `cson`, `yaml`, `string`, `raw`/`false`. If `true` will try all the available parsers. Can also be a function with the signature `({response, data, feed, feedr}, next(err, data))`

- `check` defaults to `true`, whether or not we should check the response data for custom error messages. Can also be a function with the signature `({response, data, feed, feedr}, next(err))`

- `xml2jsOptions` defaults to global value, the options to send to [xml2js](https://github.com/Leonidas-from-XIV/node-xml2js)

- `requestOptions` defaults to global value, the options to send to [request](https://github.com/mikeal/request)

History


Discover the release history by heading on over to the HISTORY.md file.

Contribute


Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers


Maintainers


These amazing people are maintaining this project:



Benjamin Lupton — view contributions



Sponsors


No sponsors yet! Will you be the first?



















Contributors


These amazing people have contributed code to this project:





Benjamin Lupton — view contributions





Zearin — view contributions





dependabot[bot] — view contributions





dependabot-preview[bot] — view contributions





Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License


Unless stated otherwise all works are:

Copyright © 2012+ Bevry Pty Ltd



and licensed under:

MIT License