feed

  • Version 6.0.0
  • Published
  • 27.3 kB
  • 1 dependency
  • MIT license

Install

npm i feed
yarn add feed
pnpm add feed

Overview

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

Index

Classes

class Feed

class Feed {}

    constructor

    constructor(options: FeedOptions);

      property categories

      categories: string[];

        property contributors

        contributors: Author[];

          property extensions

          extensions: Extension[];

            property items

            items: Item[];

              property options

              options: FeedOptions;

                method addCategory

                addCategory: (category: string) => void;

                  method addContributor

                  addContributor: (contributor: Author) => void;

                    method addExtension

                    addExtension: (extension: Extension) => void;

                      method addItem

                      addItem: (item: Item) => void;

                        method atom1

                        atom1: () => string;

                          method json1

                          json1: () => string;

                            method rss2

                            rss2: () => string;

                              Interfaces

                              interface Author

                              interface Author {}

                                property avatar

                                avatar?: string;

                                  property email

                                  email?: string;
                                    link?: string;

                                      property name

                                      name?: string;

                                        interface Category

                                        interface Category {}

                                          property domain

                                          domain?: string;

                                            property name

                                            name?: string;

                                              property scheme

                                              scheme?: string;

                                                property term

                                                term?: string;

                                                  interface Enclosure

                                                  interface Enclosure {}

                                                    property duration

                                                    duration?: number;

                                                      property length

                                                      length?: number;

                                                        property title

                                                        title?: string;

                                                          property type

                                                          type?: string;

                                                            property url

                                                            url: string;

                                                              interface Extension

                                                              interface Extension {}

                                                                property name

                                                                name: string;

                                                                  property objects

                                                                  objects: Record<string, unknown>;

                                                                    interface FeedOptions

                                                                    interface FeedOptions {}

                                                                      property author

                                                                      author?: Author;

                                                                        property category

                                                                        category?: string;

                                                                          property copyright

                                                                          copyright?: string;

                                                                            property description

                                                                            description?: string;

                                                                              property docs

                                                                              docs?: string;

                                                                                property favicon

                                                                                favicon?: string;

                                                                                  property feed

                                                                                  feed?: string;
                                                                                    feedLinks?: {
                                                                                    rss?: string;
                                                                                    atom?: string;
                                                                                    json?: string;
                                                                                    [key: string]: string | undefined;
                                                                                    };

                                                                                      property generator

                                                                                      generator?: string | false;
                                                                                      • Feed generator. Defaults to the library's URL. Pass false to omit the <generator> element entirely.

                                                                                      property hub

                                                                                      hub?: string;

                                                                                        property id

                                                                                        id?: string;

                                                                                          property image

                                                                                          image?: string;

                                                                                            property language

                                                                                            language?: string;
                                                                                              link?: string;

                                                                                                property podcast

                                                                                                podcast?: boolean;

                                                                                                  property stylesheet

                                                                                                  stylesheet?: 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 (1)

                                                                                                                                              Dependencies (1)

                                                                                                                                              Dev Dependencies (4)

                                                                                                                                              Peer Dependencies (0)

                                                                                                                                              No peer dependencies.

                                                                                                                                              Badge

                                                                                                                                              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
                                                                                                                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/feed)
                                                                                                                                              • HTML
                                                                                                                                                <a href="https://www.jsdocs.io/package/feed"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>