• Version 4.2.2
  • Published
  • 105 kB
  • 1 dependency
  • MIT license


npm i feed
yarn add feed
pnpm add feed


Feed is a RSS, Atom and JSON feed generator for Node.js, making content syndication simple and intuitive!



class Feed

class Feed {}


    constructor(options: FeedOptions);

      property addCategory

      addCategory: (category: string) => number;

        property addContributor

        addContributor: (contributor: Author) => number;

          property addExtension

          addExtension: (extension: Extension) => number;

            property addItem

            addItem: (item: Item) => number;

              property atom1

              atom1: () => string;

                property categories

                categories: string[];

                  property contributors

                  contributors: Author[];

                    property extensions

                    extensions: Extension[];

                      property items

                      items: Item[];

                        property json1

                        json1: () => string;

                          property options

                          options: FeedOptions;

                            property rss2

                            rss2: () => string;


                              interface Author

                              interface Author {}

                                property email

                                email?: string;
                                  link?: string;

                                    property name

                                    name?: string;

                                      interface Extension

                                      interface Extension {}

                                        property name

                                        name: string;

                                          property objects

                                          objects: any;

                                            interface FeedOptions

                                            interface FeedOptions {}

                                              property author

                                              author?: Author;

                                                property copyright

                                                copyright: string;

                                                  property description

                                                  description?: string;

                                                    property docs

                                                    docs?: string;

                                                      property favicon

                                                      favicon?: string;

                                                        property feed

                                                        feed?: string;
                                                          feedLinks?: any;

                                                            property generator

                                                            generator?: string;

                                                              property hub

                                                              hub?: string;

                                                                property id

                                                                id: string;

                                                                  property image

                                                                  image?: string;

                                                                    property language

                                                                    language?: string;
                                                                      link?: string;

                                                                        property title

                                                                        title: string;

                                                                          property ttl

                                                                          ttl?: number;

                                                                            property updated

                                                                            updated?: Date;

                                                                              interface Item

                                                                              interface Item {}

                                                                                property audio

                                                                                audio?: string | Enclosure;

                                                                                  property author

                                                                                  author?: Author[];

                                                                                    property category

                                                                                    category?: Category[];

                                                                                      property content

                                                                                      content?: string;

                                                                                        property contributor

                                                                                        contributor?: Author[];

                                                                                          property copyright

                                                                                          copyright?: string;

                                                                                            property date

                                                                                            date: Date;

                                                                                              property description

                                                                                              description?: string;

                                                                                                property enclosure

                                                                                                enclosure?: Enclosure;

                                                                                                  property extensions

                                                                                                  extensions?: Extension[];

                                                                                                    property guid

                                                                                                    guid?: string;

                                                                                                      property id

                                                                                                      id?: string;

                                                                                                        property image

                                                                                                        image?: string | Enclosure;
                                                                                                          link: string;

                                                                                                            property published

                                                                                                            published?: Date;

                                                                                                              property title

                                                                                                              title: string;

                                                                                                                property video

                                                                                                                video?: string | Enclosure;

                                                                                                                  Package Files (2)

                                                                                                                  Dependencies (1)

                                                                                                                  Dev Dependencies (9)

                                                                                                                  Peer Dependencies (0)

                                                                                                                  No peer dependencies.


                                                                                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/feed.

                                                                                                                  • Markdown
                                                                                                                  • HTML
                                                                                                                    <a href="https://www.jsdocs.io/package/feed"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>