feed
- Version 5.1.0
- Published
- 54.4 kB
- 1 dependency
- MIT license
Install
npm i feedyarn add feedpnpm add feedOverview
Feed is a RSS, Atom and JSON feed generator for Node.js, making content syndication simple and intuitive!
Index
Classes
Interfaces
Classes
class Feed
class Feed {}Class used to generate Feeds
constructor
constructor(options: FeedOptions);property addCategory
addCategory: (category: string) => number;Add a category
Parameter category
property addContributor
addContributor: (contributor: Author) => number;Add a contributor
Parameter contributor
property addExtension
addExtension: (extension: Extension) => number;Adds an extension
Parameter extension
property addItem
addItem: (item: Item) => number;Add a feed item
Parameter item
property atom1
atom1: () => string;Returns a Atom 1.0 feed
property categories
categories: string[];property contributors
contributors: Author[];property extensions
extensions: Extension[];property items
items: Item[];property json1
json1: () => string;Returns a JSON1 feed
property options
options: FeedOptions;property rss2
rss2: () => string;Returns a RSS 2.0 feed
Interfaces
interface Author
interface Author {}interface Category
interface Category {}interface Enclosure
interface Enclosure {}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;property feedLinks
feedLinks?: any;property generator
generator?: string;property hub
hub?: string;property id
id: string;property image
image?: string;property language
language?: string;property link
link?: string;property podcast
podcast?: boolean;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;property link
link: string;property published
published?: Date;property title
title: string;property video
video?: string | Enclosure;Package Files (1)
Dependencies (1)
Dev Dependencies (16)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this one
to 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[](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>
- Updated .
Package analyzed in 2845 ms. - Missing or incorrect documentation? Open an issue for this package.