podcast2
v2.0.0
Published
Podcast RSS feed generator. A really simple API to add Podcast-RSS feeds to any project.
Downloads
6
Readme
Podcast RSS for Node
Fast and simple Podcast RSS generator/builder for Node projects. Supports enclosures and GeoRSS.
An updated version of node-podcast
.
Install
npm install podcast2
Usage
Create a new feed
const podcast = require('podcast2')
const feedXml = podcast(feedOptions, feedItems)
feedOptions
title
string Title of your site or feeddescription
optional string A short description of the feed.generator
optional string Feed generator.feed_url
url string Url to the rss feed.site_url
url string Url to the site that the feed is for.image_url
optional url string Small image for feed readers to use.docs
optional url string Url to documentation on this feed.author
string Who owns this feed.managingEditor
optional string Who manages content in this feed.webMaster
optional string Who manages feed availability and technical support.copyright
optional string Copyright information for this feed.language
optional string The language of the content of this feed.categories
optional array of strings One or more categories this feed belongs to.pubDate
optional date object or date string The publication date for content in the feedttl
optional integer Number of minutes feed can be cached before refreshing from source.itunesAuthor
optional string (iTunes specific) author of the podcastitunesSubtitle
optional string (iTunes specific) subtitle for iTunes listingitunesSummary
optional string (iTunes specific) summary for iTunes listingitunesOwner
optional object (iTunes specific) owner of the podcastname
stringemail
string
itunesExplicit
optional boolean (iTunes specific) specifies if the podcast contains explicit contentitunesCategory
optional array of objects (iTunes specific) Categories for iTunestext
stringsubcats
array of objects A recursive array of these category objects
itunesImage
optional string (iTunes specific) link to an image for the podcastindent
optional boolean Whether or not the output should be indented with a tab
feedItems
An array of any number of item objects.
Item object properties:
title
string Title of this particular item.description
string Content for the item. Can contain html but link and image urls must be absolute path including hostname.url
url string Url to the item. This could be a blog entry.guid
unique 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.categories
optional array of strings If provided, each array item will be added as a category elementauthor
optional 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.date
date 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.lat
optional number The latitude coordinate of the item.long
optional number The longitude coordinate of the item.enclosure
optional object Attach a multimedia file to this item.url
string Url to the related file.file
optional string Path to the related file on the filesystem. Used to fill out size and mime information.size
optional number Number of bytes in the file. The length field will default to 0 if thesize
orfile
fields have not been set.mime
optional string Mime type of the file. Will be guessed from the url if this parameter is not set.
itunesAuthor
optional string (iTunes specific) author of the podcastitunesExplicit
optional boolean (iTunes specific) specifies if the podcast contains explicit contentitunesSubtitle
optional string (iTunes specific) subtitle for iTunes listingitunesSummary
optional string (iTunes specific) summary for iTunes listingitunesDuration
optional number (iTunes specific) duration of the podcast item in secondsitunesImage
optional string (iTunes specific) link to an image for the item
Example Usage
const podcast = require('podcast2')
const xml = 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: 'Joseph Dykstra',
managingEditor: 'Joseph Dykstra',
webMaster: 'Joseph Dykstra',
copyright: '2013 Joseph Dykstra',
language: 'en',
categories: ['Category 1','Category 2','Category 3'],
pubDate: 'May 20, 2012 04:00:00 GMT',
ttl: '60',
itunesAuthor: 'Joseph Dykstra',
itunesSubtitle: 'I am a sub title',
itunesSummary: 'I am a summary',
itunesOwner: { name: 'Joseph Dykstra', email:'[email protected]' },
itunesExplicit: false,
itunesCategory: {
text: "Entertainment",
subcats: [{
text: "Television"
}]
},
itunesImage: 'http://link.to/image.png'
}, [{
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: 'Joseph Dykstra',
itunesExplicit: false,
itunesSubtitle: 'I am a sub title',
itunesSummary: 'I am a summary',
itunesDuration: 12345,
itunesKeywords: ['javascript','podcast']
}])
Tests
Tests included use Tape. Use npm test
to run the tests.
npm test
Credit / License
I forked the node-podcast
module, because it wasn't passing its tests, and the install was failing.