rss-emitter-ts
Version:
Emit rss feed items, written in TypeScript
197 lines • 7.51 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RssEmitter</title>
<meta name="description" content="Documentation for RssEmitter">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">RssEmitter</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>RssEmitter</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<div align="center">
<br />
<p>
<a href="https://discord.gg/p895czC"><img src="https://discordapp.com/api/guilds/240059867744698368/embed.png" alt="Discord server" /></a>
<a href="https://www.npmjs.com/package/rss-emitter-ts"><img src="https://img.shields.io/npm/v/rss-emitter-ts.svg?maxAge=3600" alt="NPM version" /></a>
<a href="https://www.npmjs.com/package/rss-emitter-ts"><img src="https://img.shields.io/npm/dt/rss-emitter-ts.svg?maxAge=3600" alt="NPM downloads" /></a>
<a href="https://david-dm.org/KurozeroPB/rssemitter"><img src="https://img.shields.io/david/kurozeropb/rssemitter.svg?maxAge=3600" alt="Dependencies" /></a>
<a href="https://www.patreon.com/Kurozero"><img src="https://img.shields.io/badge/donate-patreon-F96854.svg" alt="Patreon" /></a>
</p>
<p>
<a href="https://nodei.co/npm/rss-emitter-ts/"><img src="https://nodei.co/npm/rss-emitter-ts.png?downloads=true&stars=true" alt="NPM info" /></a>
</p>
</div>
<a href="#rssemitter" id="rssemitter" style="color: inherit; text-decoration: none;">
<h1>RssEmitter</h1>
</a>
<p>Emit rss feed items, written in TypeScript</p>
<a href="#docs" id="docs" style="color: inherit; text-decoration: none;">
<h1>Docs</h1>
</a>
<p><a href="https://kurozeropb.github.io/RssEmitter/">https://kurozeropb.github.io/RssEmitter/</a></p>
<table>
<thead>
<tr>
<th>Emitted events</th>
<th>Params</th>
<th>Description</th>
<th>Since</th>
</tr>
</thead>
<tbody><tr>
<td>item:new</td>
<td>item: FeedItem</td>
<td>emits when a new item is added to the rss feed (where no <code>eventName</code> is provided)</td>
<td>0.0.1</td>
</tr>
<tr>
<td>item:new<zero-width space>:[eventName]</td>
<td>item: FeedItem</td>
<td>emits when a new item is added to the rss feed (where <code>eventName</code> is provided)</td>
<td>0.4.3</td>
</tr>
<tr>
<td>feed:init</td>
<td>feed: FeedConfig</td>
<td>emits when a feed is done loading it's initial items</td>
<td>0.3.0</td>
</tr>
<tr>
<td>feed:new</td>
<td>feed: FeedConfig</td>
<td>emits when a new feed is added using FeedEmitter#add()</td>
<td>0.3.0</td>
</tr>
<tr>
<td>feed:update</td>
<td>feed: FeedConfig</td>
<td>emits when an existing feed is added using FeedEmitter#add()</td>
<td>0.3.0</td>
</tr>
<tr>
<td>feed:error</td>
<td>error: FeedError</td>
<td>emits when an error occured while checking the feed</td>
<td>0.0.1</td>
</tr>
</tbody></table>
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
<h2>Examples</h2>
</a>
<p>Can be found in the <a href="/examples">examples</a> folder</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/feedemitter.html" class="tsd-kind-icon">Feed<wbr>Emitter</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/feederror.html" class="tsd-kind-icon">Feed<wbr>Error</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/feedconfig.html" class="tsd-kind-icon">Feed<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/feeddata.html" class="tsd-kind-icon">Feed<wbr>Data</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/feeditem.html" class="tsd-kind-icon">Feed<wbr>Item</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/options.html" class="tsd-kind-icon">Options</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>