rss-emitter-ts
Version:
Emit rss feed items, written in TypeScript
375 lines • 18.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FeedItem | 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>
<li>
<a href="feeditem.html">FeedItem</a>
</li>
</ul>
<h1>Interface FeedItem</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">Item</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">FeedItem</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-kind-interface">
<h3 class="tsd-before-signature">Indexable</h3>
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>x: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#author" class="tsd-kind-icon">author</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#categories" class="tsd-kind-icon">categories</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#comments" class="tsd-kind-icon">comments</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#date" class="tsd-kind-icon">date</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#enclosures" class="tsd-kind-icon">enclosures</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#guid" class="tsd-kind-icon">guid</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#image" class="tsd-kind-icon">image</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#link" class="tsd-kind-icon">link</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#meta" class="tsd-kind-icon">meta</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#origlink" class="tsd-kind-icon">origlink</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#pubdate" class="tsd-kind-icon">pubdate</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#summary" class="tsd-kind-icon">summary</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="feeditem.html#title" class="tsd-kind-icon">title</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="author" class="tsd-anchor"></a>
<h3>author</h3>
<div class="tsd-signature tsd-kind-icon">author<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.author</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L21">lib/index.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="categories" class="tsd-anchor"></a>
<h3>categories</h3>
<div class="tsd-signature tsd-kind-icon">categories<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Overrides Item.categories</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L25">lib/index.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="comments" class="tsd-anchor"></a>
<h3>comments</h3>
<div class="tsd-signature tsd-kind-icon">comments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.comments</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L23">lib/index.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="date" class="tsd-anchor"></a>
<h3>date</h3>
<div class="tsd-signature tsd-kind-icon">date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<p>Overrides Item.date</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L17">lib/index.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="description" class="tsd-anchor"></a>
<h3>description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.description</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L15">lib/index.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="enclosures" class="tsd-anchor"></a>
<h3>enclosures</h3>
<div class="tsd-signature tsd-kind-icon">enclosures<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Enclosure</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Overrides Item.enclosures</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L26">lib/index.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="guid" class="tsd-anchor"></a>
<h3>guid</h3>
<div class="tsd-signature tsd-kind-icon">guid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.guid</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L22">lib/index.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="image" class="tsd-anchor"></a>
<h3>image</h3>
<div class="tsd-signature tsd-kind-icon">image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Image</span></div>
<aside class="tsd-sources">
<p>Overrides Item.image</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L24">lib/index.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="link" class="tsd-anchor"></a>
<h3>link</h3>
<div class="tsd-signature tsd-kind-icon">link<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.link</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L19">lib/index.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="meta" class="tsd-anchor"></a>
<h3>meta</h3>
<div class="tsd-signature tsd-kind-icon">meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Meta</span></div>
<aside class="tsd-sources">
<p>Overrides Item.meta</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L27">lib/index.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="origlink" class="tsd-anchor"></a>
<h3>origlink</h3>
<div class="tsd-signature tsd-kind-icon">origlink<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.origlink</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L20">lib/index.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="pubdate" class="tsd-anchor"></a>
<h3>pubdate</h3>
<div class="tsd-signature tsd-kind-icon">pubdate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<p>Overrides Item.pubdate</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L18">lib/index.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="summary" class="tsd-anchor"></a>
<h3>summary</h3>
<div class="tsd-signature tsd-kind-icon">summary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.summary</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L16">lib/index.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="title" class="tsd-anchor"></a>
<h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Item.title</p>
<ul>
<li>Defined in <a href="https://github.com/Pepijn98/RssEmitter/blob/336e063/lib/index.ts#L14">lib/index.ts:14</a></li>
</ul>
</aside>
</section>
</section>
</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="feedconfig.html" class="tsd-kind-icon">Feed<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="feeddata.html" class="tsd-kind-icon">Feed<wbr>Data</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="feeditem.html" class="tsd-kind-icon">Feed<wbr>Item</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#author" class="tsd-kind-icon">author</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#categories" class="tsd-kind-icon">categories</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#comments" class="tsd-kind-icon">comments</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#date" class="tsd-kind-icon">date</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#enclosures" class="tsd-kind-icon">enclosures</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#guid" class="tsd-kind-icon">guid</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#image" class="tsd-kind-icon">image</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#link" class="tsd-kind-icon">link</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#meta" class="tsd-kind-icon">meta</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#origlink" class="tsd-kind-icon">origlink</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#pubdate" class="tsd-kind-icon">pubdate</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#summary" class="tsd-kind-icon">summary</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="feeditem.html#title" class="tsd-kind-icon">title</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="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>