Fast and simple Podcast RSS generator/builder for Node projects. Supports enclosures and GeoRSS.
$ npm install podcast
import Podcast from 'podcast';
const feed = new Podcast(feedOptions);titlestring Title of your site or feeddescriptionoptional string A short description of the feed.generatoroptional string Feed generator.feedUrlurl string Url to the rss feed.siteUrlurl string Url to the site that the feed is for.imageUrloptional *url string Small image for feed readers to use.docsoptional url string Url to documentation on this feed.authorstring Who owns this feed.managingEditoroptional string Who manages content in this feed.webMasteroptional string Who manages feed availability and technical support.copyrightoptional string Copyright information for this feed.languageoptional string The language of the content of this feed.categoriesoptional array of strings One or more categories this feed belongs to.pubDateoptional Date object or date string The publication date for content in the feedttloptional integer Number of minutes feed can be cached before refreshing from source.itunesAuthoroptional string (iTunes specific) author of the podcastitunesSubtitleoptional string (iTunes specific) subtitle for iTunes listingitunesSummaryoptional string (iTunes specific) summary for iTunes listingitunesOwneroptional object (iTunes specific) owner of the podcast ( {name:String, email:String} )itunesExplicitoptional boolean (iTunes specific) specifies if the podcast contains explicit contentitunesCategoryoptional array of objects (iTunes specific) Categories for iTunes ( [{text:String, subcats:[{text:String, subcats:Array}]}] )itunesImageoptional string (iTunes specific) link to an image for the podcastitunesTypeoptional string (iTunes specific) type of podcast (episodicorserial)customNamespacesoptional object Put additional namespaces in element (without 'xmlns:' prefix)customElementsoptional array Put additional elements in the feed (node-xml syntax)
An item can be used for a blog entry, project update, log entry, etc. Your RSS feed an have any number of items. Most feeds use 20 or fewer items.
feed.addItem(itemOptions);titlestring Title of this particular item.descriptionstring Content for the item. Can contain html but link and image urls must be absolute path including hostname.urlurl string Url to the item. This could be a blog entry.guidunique string A unique string feed readers use to know if an item is new or has already been seen. If you use a guid never change it. If you don't provide a guid then your item urls must be unique.categoriesoptional array of strings If provided, each array item will be added as a category elementauthoroptional string If included it is the name of the item's creator. If not provided the item author will be the same as the feed author. This is typical except on multi-author blogs.dateDate object or date string The date and time of when the item was created. Feed readers use this to determine the sort order. Some readers will also use it to determine if the content should be presented as unread.latoptional number The latitude coordinate of the item.longoptional number The longitude coordinate of the item.enclosureoptional object Attach a multimedia file to this item.urlstring Url to the related file.fileoptional string Path to the related file on the filesystem. Used to fill out size and mime information.sizeoptional number Number of bytes in the file. The length field will defualt to 0 if thesizeorfilefields have not been set.typeoptional string Mime type of the file. Will be guessed from the url if this parameter is not set.
contentoptional string Long html content for the episodeitunesAuthoroptional string (iTunes specific) author of the podcastitunesExplicitoptional boolean (iTunes specific) specifies if the podcast contains explicit contentitunesSubtitleoptional string (iTunes specific) subtitle for iTunes listingitunesSummaryoptional string (iTunes specific) summary for iTunes listingitunesDurationoptional number (iTunes specific) duration of the podcast item in secondsitunesImageoptional string (iTunes specific) link to an image for the itemitunesSeasonoptional number (iTunes specific) season number (non-zero integer)itunesEpisodeoptional number (iTunes specific) episode number (non-zero integer)itunesTitleoptional string (iTunes specific) episode titleitunesEpisodeTypeoptional string (iTunes specific) the type of episode (full(default),trailer,bonus)itunesNewFeedUrloptional string (iTunes specific) The new podcast RSS Feed URL.customElementsoptional array Put additional elements in the item (node-xml syntax)
const xml = feed.buildXml(indent);This returns the XML as a string.
indent optional string What to use as a tab. Defaults to no tabs (compressed).
For example you can use '\t' for tab character, or ' ' for two-space tabs.
import Podcast from 'podcast';
/* lets create an rss feed */
const feed = new Podcast({
title: 'title',
description: 'description',
feed_url: 'http://example.com/rss.xml',
site_url: 'http://example.com',
image_url: 'http://example.com/icon.png',
docs: 'http://example.com/rss/docs.html',
author: 'Dylan Greene',
managingEditor: 'Dylan Greene',
webMaster: 'Dylan Greene',
copyright: '2013 Dylan Greene',
language: 'en',
categories: ['Category 1','Category 2','Category 3'],
pubDate: 'May 20, 2012 04:00:00 GMT',
ttl: 60,
itunesAuthor: 'Max Nowack',
itunesSubtitle: 'I am a sub title',
itunesSummary: 'I am a summary',
itunesOwner: { name: 'Max Nowack', email: '[email protected]' },
itunesExplicit: false,
itunesCategory: [{
text: 'Entertainment',
subcats: [{
text: 'Television'
}]
}],
itunesImage: 'http://example.com/image.png'
});
/* loop over data and add to feed */
feed.addItem({
title: 'item title',
description: 'use this for the content. It can include html.',
url: 'http://example.com/article4?this&that', // link to the item
guid: '1123', // optional - defaults to url
categories: ['Category 1','Category 2','Category 3','Category 4'], // optional - array of item categories
author: 'Guest Author', // optional - defaults to feed author property
date: 'May 27, 2012', // any format that js Date can parse.
lat: 33.417974, //optional latitude field for GeoRSS
long: -111.933231, //optional longitude field for GeoRSS
enclosure : {url:'...', file:'path-to-file'}, // optional enclosure
itunesAuthor: 'Max Nowack',
itunesExplicit: false,
itunesSubtitle: 'I am a sub title',
itunesSummary: 'I am a summary',
itunesDuration: 12345,
itunesNewFeedUrl: 'https://newlocation.com/example.rss',
});
// cache the xml to send to clients
const xml = feed.buildXml();- You do not need to escape anything. This module will escape characters when necessary.
- This module is very fast but you might as well cache the output of buildXml() and serve it until something changes.
Contributions to the project are welcome. Feel free to fork and improve. I do my best accept pull requests in a timely manor, especially when tests and updated docs are included.
(The MIT License)
Copyright (c) 2018 Max Nowack [email protected]
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.