feed

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 = 'https://github.com/jpmonette/feed'
  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

Options

Feed Options

Property	Type	Description
title	string	Required. Feed title
id	string	Feed identifier (required for Atom)
link	string	URL to the feed's website
description	string	Feed description/subtitle
copyright	string	Copyright notice
language	string	Language code (e.g., "en", "fr-CA")
updated	Date	Last update date (default: now)
generator	string	Generator name (default: "https://github.com/jpmonette/feed")
image	string	URL to feed image/logo
favicon	string	URL to feed favicon
author	Author	Feed author
feedLinks	object	Links to feed formats ({ rss, atom, json })
feed	string	Self-referencing feed URL
hub	string	WebSub/PubSubHubbub hub URL
ttl	number	Time to live in minutes (RSS)
docs	string	RSS specification docs URL
stylesheet	string	URL to XSL stylesheet
podcast	boolean	Enable iTunes/Google podcast extensions
category	string	Podcast category name

Item Options

Property	Type	Description
title	string	Required. Item title
link	string	Required. URL to the item
date	Date	Required. Last modified/updated date
id	string	Unique identifier (Atom/JSON)
guid	string	RSS-specific GUID
description	string	Brief summary or excerpt
content	string	Full content (HTML allowed)
author	Author[]	Item authors
contributor	Author[]	Item contributors
category	Category[]	Item categories
published	Date	Original publication date
copyright	string	Item copyright notice
image	string | Enclosure	Image attachment
audio	string | Enclosure	Audio attachment
video	string | Enclosure	Video attachment
enclosure	Enclosure	Generic media enclosure
extensions	Extension[]	Custom extensions

Types

interface Author {
  name?: string;
  email?: string;
  link?: string;
  avatar?: string; // JSON Feed only
}

interface Enclosure {
  url: string;
  type?: string; // MIME type (e.g., "audio/mpeg")
  length?: number; // File size in bytes
  title?: string;
  duration?: number; // Duration in seconds (for podcasts)
}

interface Category {
  name?: string;
  domain?: string; // RSS
  scheme?: string; // Atom
  term?: string; // Atom
}

interface Extension {
  name: string;
  objects: Record<string, unknown>;
}

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;

Star History

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.

Similar packages

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'.