1.1.3 • Published 6 years ago

nanofeed v1.1.3

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

GitHub version Code Climate Build Status Test Coverage

nanofeed

Tiny RSS feed parser client built in JavaScript.

No library dependencies. Asynchronous requests. Multiple feeds sources. Multiple independent successive calls. Uses Yahoo! YQL Plataform. Widely supported by browsers.

Installation

Recommended using CDN:

<script src="https://www.jsdelivr.com/package/npm/nanofeed@1/dist/nanofeed.min.js"></script>

or package manager:

$ yarn add nanofeed
$ pnpm i -D nanofeed

Examples

// minimal
nanofeed.fetch(url, function(items) {
  console.log(items)
})

// Multiple feed sources
nanofeed.fetch([socialFeedUrl, newsFeedUrl], addFeedItems)

// Successive calls
nanofeed
  .fetch([socialFeedUrl, newsFeedUrl], addFeedItems)
  .fetch(weatherFeedUrl, addWeatherFeedItems)

// Callback function receive array of items retrieved from the feed
function callback(items) {
  items.forEach(function(x) {
    var newItemHtml = '<li>' + items.title + ' - ' + item.date + '</li>'
    document.getElementById('feed').innerHTML += newItemHtml
  })
}

// Setting options for a function call
nanofeed.fetch(
  url,
  {
    fields: ['title', 'date'],
    qty: 15
  },
  callback
)

// or globally for all function calls
nanofeed.options = {
  fields: ['title', 'date'],
  qty: 15
}
nanofeed.fetch(url, callback)
nanofeed.fetch(weatherFeedUrl, addWeatherFeedItems)

Documentation

nanofeed.fetch(feed_url, [options,] success_callback)

parametertyperequireddescription
feed_urlstring | string arrayyesAbsolute URL(s) of the RSS feed(s).
optionsobjectnoOptions about format of result returned from feed sources.
success_callbackfunction(data)yesCallback function called on success.

Options parameters

attributetypedefaultacceptsdescription
fieldsstring array'title', 'link'title, link, date, descriptionFields to be returned from feed source(s).
qtyinteger5positive integers (limited by feed source or Yahoo Feed API)Quantity of feed entries to return.

Callback function called on success:

Returns as parameter the list of feed entries ordered by most recent publish date. Array of object:

attributetype
titlestring
linkstring
pubDatedate
descriptionstring

For further documentation see specifications.

Specification & Tests

Detailed code coverage is available at https://andretf.github.io/nanofeed/spec/coverage.

Authoring

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.1

7 years ago

1.0.0

8 years ago

0.5.1

8 years ago

0.5.0

8 years ago