feed

What is feed?

The 'feed' npm package is a versatile tool for creating RSS, Atom, and JSON feeds. It provides a simple API to generate feeds in various formats, making it easy to syndicate content for blogs, podcasts, and other web applications.

What are feed's main functionalities?

Create an RSS Feed

This code sample demonstrates how to create an RSS feed using the 'feed' package. It initializes a new feed with metadata and adds an item to the feed. Finally, it outputs the RSS XML.

const { Feed } = require('feed');

const feed = new Feed({
  title: 'Feed Title',
  description: 'Feed Description',
  id: 'http://example.com/',
  link: 'http://example.com/',
  language: 'en',
  image: 'http://example.com/image.png',
  favicon: 'http://example.com/favicon.ico',
  updated: new Date(),
  generator: 'Feed Generator',
  feedLinks: {
    rss: 'http://example.com/rss',
    atom: 'http://example.com/atom',
    json: 'http://example.com/json'
  },
  author: {
    name: 'Author Name',
    email: '[e-mail]',
    link: 'http://example.com/author'
  }
});

feed.addItem({
  title: 'Post Title',
  id: 'http://example.com/post',
  link: 'http://example.com/post',
  description: 'Post Description',
  content: 'Post Content',
  author: [
    {
      name: 'Author Name',
      email: '[e-mail]',
      link: 'http://example.com/author'
    }
  ],
  date: new Date()
});

console.log(feed.rss2());

Create an Atom Feed

This code sample demonstrates how to create an Atom feed using the 'feed' package. It initializes a new feed with metadata and adds an item to the feed. Finally, it outputs the Atom XML.

const { Feed } = require('feed');

const feed = new Feed({
  title: 'Feed Title',
  description: 'Feed Description',
  id: 'http://example.com/',
  link: 'http://example.com/',
  language: 'en',
  image: 'http://example.com/image.png',
  favicon: 'http://example.com/favicon.ico',
  updated: new Date(),
  generator: 'Feed Generator',
  feedLinks: {
    rss: 'http://example.com/rss',
    atom: 'http://example.com/atom',
    json: 'http://example.com/json'
  },
  author: {
    name: 'Author Name',
    email: '[e-mail]',
    link: 'http://example.com/author'
  }
});

feed.addItem({
  title: 'Post Title',
  id: 'http://example.com/post',
  link: 'http://example.com/post',
  description: 'Post Description',
  content: 'Post Content',
  author: [
    {
      name: 'Author Name',
      email: '[e-mail]',
      link: 'http://example.com/author'
    }
  ],
  date: new Date()
});

console.log(feed.atom1());

Create a JSON Feed

This code sample demonstrates how to create a JSON feed using the 'feed' package. It initializes a new feed with metadata and adds an item to the feed. Finally, it outputs the JSON feed.

const { Feed } = require('feed');

const feed = new Feed({
  title: 'Feed Title',
  description: 'Feed Description',
  id: 'http://example.com/',
  link: 'http://example.com/',
  language: 'en',
  image: 'http://example.com/image.png',
  favicon: 'http://example.com/favicon.ico',
  updated: new Date(),
  generator: 'Feed Generator',
  feedLinks: {
    rss: 'http://example.com/rss',
    atom: 'http://example.com/atom',
    json: 'http://example.com/json'
  },
  author: {
    name: 'Author Name',
    email: '[e-mail]',
    link: 'http://example.com/author'
  }
});

feed.addItem({
  title: 'Post Title',
  id: 'http://example.com/post',
  link: 'http://example.com/post',
  description: 'Post Description',
  content: 'Post Content',
  author: [
    {
      name: 'Author Name',
      email: '[e-mail]',
      link: 'http://example.com/author'
    }
  ],
  date: new Date()
});

console.log(feed.json1());

Other packages similar to feed

rss

The 'rss' package is a simple RSS feed generator for Node.js. It provides a straightforward API to create RSS feeds but lacks support for Atom and JSON feeds, making it less versatile compared to 'feed'.

rss-parser

The 'rss-parser' package is primarily used for parsing RSS and Atom feeds rather than generating them. It is useful for consuming and processing feeds, whereas 'feed' is focused on feed creation.

feedme

The 'feedme' package is a robust feed parser that supports RSS, Atom, and JSON feeds. Similar to 'rss-parser', it is designed for parsing feeds rather than generating them, making it complementary to 'feed'.

README

jpmonette/feed - RSS 2.0, JSON Feed 1.0, and Atom 1.0 generator for Node.js
Making content syndication simple and intuitive!

---

👩🏻‍💻 Developer Ready: Quickly generate syndication feeds for your Website.

💪🏼 Strongly Typed: Developed using TypeScript / type-safe.

🔒 Tested: Tests & snapshot for each syndication format to avoid regressions.

Getting Started

Installation

$ yarn add feed

Example

import { Feed } from "feed";

const feed = new Feed({
  title: "Feed Title",
  description: "This is my personal feed!",
  id: "http://example.com/",
  link: "http://example.com/",
  language: "en", // optional, used only in RSS 2.0, possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
  image: "http://example.com/image.png",
  favicon: "http://example.com/favicon.ico",
  copyright: "All rights reserved 2013, John Doe",
  updated: new Date(2013, 6, 14), // optional, default = today
  generator: "awesome", // optional, default = 'Feed for Node.js'
  feedLinks: {
    json: "https://example.com/json",
    atom: "https://example.com/atom"
  },
  author: {
    name: "John Doe",
    email: "[e-mail]",
    link: "https://example.com/johndoe"
  }
});

posts.forEach(post => {
  feed.addItem({
    title: post.title,
    id: post.url,
    link: post.url,
    description: post.description,
    content: post.content,
    author: [
      {
        name: "Jane Doe",
        email: "[e-mail]",
        link: "https://example.com/janedoe"
      },
      {
        name: "Joe Smith",
        email: "[e-mail]",
        link: "https://example.com/joesmith"
      }
    ],
    contributor: [
      {
        name: "Shawn Kemp",
        email: "[e-mail]",
        link: "https://example.com/shawnkemp"
      },
      {
        name: "Reggie Miller",
        email: "[e-mail]",
        link: "https://example.com/reggiemiller"
      }
    ],
    date: post.date,
    image: post.image
  });
});

feed.addCategory("Technologie");

feed.addContributor({
  name: "Johan Cruyff",
  email: "[e-mail]",
  link: "https://example.com/johancruyff"
});

console.log(feed.rss2());
// Output: RSS 2.0

console.log(feed.atom1());
// Output: Atom 1.0

console.log(feed.json1());
// Output: JSON Feed 1.0

Migrating from < 3.0.0

If you are migrating from a version older than 3.0.0, be sure to update your import as we migrated to ES6 named imports.

If your environment supports the ES6 module syntax, you can import as described above:

import { Feed } from "feed";

Otherwise, you can stick with require():

- const Feed = require('feed');
+ const Feed = require('feed').Feed;

More Information

• Follow @jpmonette on Twitter for updates
• Read my personal blog Blogue de Jean-Philippe Monette to learn more about what I do!

License

Copyright (C) 2013, Jean-Philippe Monette [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

4.2.2 (2021-01-22)

Full Changelog

Implemented enhancements:

• Export types in feed #128

Merged pull requests:

• Bump node-notifier from 8.0.0 to 8.0.1 #137 (dependabot[bot])
• fix: export types from feed #136 (gustavkj)
• Bump deps #129 (jpmonette)
• Bump lodash from 4.17.15 to 4.17.19 #127 (dependabot[bot])