wassname/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/wassname/DefinitelyTyped.git synced 2026-09-06 16:20:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added type definitions for rss.

Browse Source
This commit is contained in:
secondwtq
2015-12-23 19:14:29 +08:00
parent 4c41545030
commit 492d942da4
2 changed files with 280 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
rss/rss-tests.ts
+71
View File
@@ -0,0 +1,71 @@
/// <reference path="rss.d.ts" />
// this test is copied from https://github.com/dylang/node-rss
// it basically:
//
// * creates an RSS feed with some attributes,
// * add an item to it
// * then generates XML string
import * as RSS from 'rss';
var feed = new RSS({
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',
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,
custom_namespaces: {
'itunes': 'http://www.itunes.com/dtds/podcast-1.0.dtd'
},
custom_elements: [
{ 'itunes:subtitle': 'A show about everything' },
{ 'itunes:author': 'John Doe' },
{ 'itunes:summary': 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our podcast in the Podcasts app or in the iTunes Store'},
{ 'itunes:owner': [
{ 'itunes:name': 'John Doe' },
{ 'itunes:email': 'john.doe@example.com' }
]
},
{ 'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything.jpg'
}
}
}
]
});
feed.item({
title: 'item title',
description: 'use this for the content. It can include html.',
url: 'http://example.com/article4?this&that',
guid: '1123',
categories: ['Category 1','Category 2','Category 3','Category 4'],
author: 'Guest Author',
date: 'May 27, 2012',
lat: 33.417974,
long: -111.933231,
enclosure: { url:'...', file:'path-to-file' },
custom_elements: [
{ 'itunes:author': 'John Doe' },
{ 'itunes:subtitle': 'A short primer on table spices' },
{ 'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything/Episode1.jpg'
}
}
},
{ 'itunes:duration': '7:04' }
]
});
var xml = feed.xml();
rss/rss.d.ts
Vendored
+209
View File
@@ -0,0 +1,209 @@
// Type definitions for rss
// Project: https://github.com/dylang/node-rss
// Definitions by: Second Datke <https://github.com/secondwtq>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
declare module NodeRSS {
interface FeedOptions {
/**
* Title of your site or feed.
*/
title: string;
/**
* A short description of the feed.
*/
description?: string;
/**
* Feed generator.
*/
generator?: string;
/**
* URL to the rss feed.
*/
feed_url: string;
/**
* URL to the site that the feed is for.
*/
site_url: string;
/**
* Small image for feed readers to use.
*/
image_url?: string;
/**
* URL to documentation on this feed.
*/
docs?: string;
/**
* Who manages content in this feed.
*/
managingEditor?: string;
/**
* Who manages feed availability and technical support.
*/
webMaster?: string;
/**
* Copyright information for this feed.
*/
copyright?: string;
/**
* The language of the content of this feed.
*/
language?: string;
/**
* One or more categories this feed belongs to.
*/
categories?: string[];
/**
* The publication date for content in the feed.
* Accepts Date object or string with any format
* JS Date can parse.
*/
pubDate?: Date | string;
/**
* Number of minutes feed can be cached before refreshing
* from source.
*/
ttl?: number;
/**
* Where is the PubSubHub hub located.
*/
hub?: string;
/**
* Put additional namespaces in element
* (without 'xmlns:' prefix).
*/
custom_namespaces?: Object;
/**
* Put additional elements in the feed (node-xml syntax).
*/
custom_elements?: any[];
}
interface EnclosureObject {
/**
* URL to file object (or file).
*/
url: string;
/**
* Path to binary file (or URL).
*/
file: string;
/**
* Size of the file.
*/
size?: number;
/**
* If not provided, the MIME Type will be guessed based
* on the extension of the file or URL, passing type to
* the enclosure will override the guessed type.
*/
type?: string;
}
interface ItemOptions {
/**
* Title of this particular item.
*/
title: string;
/**
* Content for the item. Can contain HTML but link and image
* URLs must be absolute path including hostname.
*/
description: string;
/**
* URL to the item. This could be a blog entry.
*/
url: 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.
* Defaults to url.
*/
guid?: string;
/**
* If provided, each array item will be added as a category
* element.
*/
categories?: 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.
*/
author?: 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.
* Accepts Date object or string with any format
* JS Date can parse.
*/
date: Date | string;
/**
* The latitude coordinate of the item for GeoRSS.
*/
lat?: number;
/**
* The longitude coordinate of the item for GeoRSS.
*/
long?: number;
/**
* Put additional elements in the item (node-xml syntax).
*/
custom_elements?: any[];
/**
* An enclosure object.
*/
enclosure?: EnclosureObject;
}
interface XmlOptions {
/**
* 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. If you set it to true it will use
* four spaces.
*/
indent?: boolean | string;
}
interface RSS {
/**
* Add an item to a feed. An item can be used for a blog
* entry, project update, log entry, etc.
* @param {ItemOptions} itemOptions
* @returns {RSS}
*/
item(itemOptions: ItemOptions): RSS;
/**
* Generate XML and return as a string for this feed.
* @returns {string}
*/
xml(): string;
/**
* Generate XML and return as a string for this feed.
*
* @param {XmlOptions} xmlOptions - You can use indent
* option to specify the tab character to use.
* @returns {string}
*/
xml(xmlOptions: XmlOptions): string;
}
interface RSSFactory {
/**
* Create an RSS feed with options.
* @param {FeedOptions} feedOptions - Options for the RSS feed.
* @returns {RSS}
*/
new(feedOptions: FeedOptions): RSS;
}
}
declare module 'rss' {
var factory: NodeRSS.RSSFactory;
export = factory;
}