mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
182 lines
153 KiB
HTML
182 lines
153 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MonitoringStore | Community Solid Server - v7.1.1</title><meta name="description" content="Documentation for Community Solid Server"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">Community Solid Server - v7.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Community Solid Server</a></li><li><a href="MonitoringStore.html">MonitoringStore</a></li></ul><h1>Class MonitoringStore<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Store that notifies listeners of changes to its source
|
||
by emitting a <code>changed</code> event.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/ResourceStore.html" class="tsd-signature-type tsd-kind-interface">ResourceStore</a> = <a href="../interfaces/ResourceStore.html" class="tsd-signature-type tsd-kind-interface">ResourceStore</a></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#MonitoringStore">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="../variables/BaseActivityEmitter.html" class="tsd-signature-type tsd-kind-variable">BaseActivityEmitter</a><ul class="tsd-hierarchy"><li><span class="target">MonitoringStore</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/ResourceStore.html" class="tsd-signature-type tsd-kind-interface">ResourceStore</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L18">src/storage/MonitoringStore.ts:18</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="MonitoringStore.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="MonitoringStore.html#addListener" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Listener</span></a>
|
||
<a href="MonitoringStore.html#emit" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a>
|
||
<a href="MonitoringStore.html#eventNames" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Names</span></a>
|
||
<a href="MonitoringStore.html#listenerCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listener<wbr/>Count</span></a>
|
||
<a href="MonitoringStore.html#listeners" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listeners</span></a>
|
||
<a href="MonitoringStore.html#off" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>off</span></a>
|
||
<a href="MonitoringStore.html#on" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on</span></a>
|
||
<a href="MonitoringStore.html#once" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a>
|
||
<a href="MonitoringStore.html#prependListener" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepend<wbr/>Listener</span></a>
|
||
<a href="MonitoringStore.html#prependOnceListener" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a>
|
||
<a href="MonitoringStore.html#rawListeners" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw<wbr/>Listeners</span></a>
|
||
<a href="MonitoringStore.html#removeAllListeners" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a>
|
||
<a href="MonitoringStore.html#removeListener" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>Listener</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="MonitoringStore.html#_captureRejectionSymbol_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>[capture<wbr/>Rejection<wbr/>Symbol]?</span></a>
|
||
<a href="MonitoringStore.html#addResource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Resource</span></a>
|
||
<a href="MonitoringStore.html#deleteResource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Resource</span></a>
|
||
<a href="MonitoringStore.html#getMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="MonitoringStore.html#getRepresentation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Representation</span></a>
|
||
<a href="MonitoringStore.html#hasResource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Resource</span></a>
|
||
<a href="MonitoringStore.html#modifyResource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>modify<wbr/>Resource</span></a>
|
||
<a href="MonitoringStore.html#setMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="MonitoringStore.html#setRepresentation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Representation</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_MonitoringStore" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Monitoring<wbr/>Store</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MonitoringStore.html#constructor.new_MonitoringStore.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MonitoringStore.html" class="tsd-signature-type tsd-kind-class">MonitoringStore</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MonitoringStore.html#constructor.new_MonitoringStore.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_MonitoringStore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_MonitoringStore.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/ResourceStore.html" class="tsd-signature-type tsd-kind-interface">ResourceStore</a> = <a href="../interfaces/ResourceStore.html" class="tsd-signature-type tsd-kind-interface">ResourceStore</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="MonitoringStore.html#constructor.new_MonitoringStore.T-1">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="MonitoringStore.html" class="tsd-signature-type tsd-kind-class">MonitoringStore</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MonitoringStore.html#constructor.new_MonitoringStore.T-1">T</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Overrides BaseActivityEmitter.constructor</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L22">src/storage/MonitoringStore.ts:22</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="addListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">add<wbr/>Listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.on(eventName, listener)</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since" class="tsd-anchor"></a>Since<a href="#Since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.addListener</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L15">src/util/GenericEventEmitter.ts:15</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L15">src/util/GenericEventEmitter.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a><span class="tsd-signature-symbol">, </span>activity<span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span>metadata<span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a><span class="tsd-signature-symbol">, </span>metadata<span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
||
to each.</p>
|
||
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-2">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// First listener</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-0">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Helloooo! first listener'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Second listener</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-0">secondListener</span><span class="hl-1">(</span><span class="hl-6">arg1</span><span class="hl-1">, </span><span class="hl-6">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`event with parameters </span><span class="hl-3">${</span><span class="hl-6">arg1</span><span class="hl-3">}</span><span class="hl-2">, </span><span class="hl-3">${</span><span class="hl-6">arg2</span><span class="hl-3">}</span><span class="hl-2"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Third listener</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-0">thirdListener</span><span class="hl-1">(...</span><span class="hl-6">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">parameters</span><span class="hl-1"> = </span><span class="hl-6">args</span><span class="hl-1">.</span><span class="hl-0">join</span><span class="hl-1">(</span><span class="hl-2">', '</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`event with parameters </span><span class="hl-3">${</span><span class="hl-6">parameters</span><span class="hl-3">}</span><span class="hl-2"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">listeners</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">));</span><br/><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">2</span><span class="hl-1">, </span><span class="hl-7">3</span><span class="hl-1">, </span><span class="hl-7">4</span><span class="hl-1">, </span><span class="hl-7">5</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// [</span><br/><span class="hl-5">// [Function: firstListener],</span><br/><span class="hl-5">// [Function: secondListener],</span><br/><span class="hl-5">// [Function: thirdListener]</span><br/><span class="hl-5">// ]</span><br/><span class="hl-5">// Helloooo! first listener</span><br/><span class="hl-5">// event with parameters 1, 2 in second listener</span><br/><span class="hl-5">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-1" class="tsd-anchor"></a>Since<a href="#Since-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.emit</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L23">src/util/GenericEventEmitter.ts:23</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L23">src/util/GenericEventEmitter.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="eventNames" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>event<wbr/>Names</span><a href="#eventNames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">event<wbr/>Names</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">"changed"</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
||
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-2">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'bar'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">sym</span><span class="hl-1"> = </span><span class="hl-0">Symbol</span><span class="hl-1">(</span><span class="hl-2">'symbol'</span><span class="hl-1">);</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-6">sym</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">eventNames</span><span class="hl-1">());</span><br/><span class="hl-5">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-2" class="tsd-anchor"></a>Since<a href="#Since-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v6.0.0</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.eventNames</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L27">src/util/GenericEventEmitter.ts:27</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L27">src/util/GenericEventEmitter.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="listenerCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">listener<wbr/>Count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Returns the number of listeners listening to the event named <code>eventName</code>.</p>
|
||
<p>If <code>listener</code> is provided, it will return how many times the listener
|
||
is found in the list of the listeners of the event.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-3" class="tsd-anchor"></a>Since<a href="#Since-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v3.2.0</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: eventName" class="tsd-anchor"></a>Param: eventName<a href="#Param: eventName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The name of the event being listened for</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: listener" class="tsd-anchor"></a>Param: listener<a href="#Param: listener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The event handler function</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.listenerCount</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L24">src/util/GenericEventEmitter.ts:24</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L24">src/util/GenericEventEmitter.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="listeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||
<pre><code class="js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-6">util</span><span class="hl-1">.</span><span class="hl-0">inspect</span><span class="hl-1">(</span><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">listeners</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">)));</span><br/><span class="hl-5">// Prints: [ [Function] ]</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-4" class="tsd-anchor"></a>Since<a href="#Since-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.listeners</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L21">src/util/GenericEventEmitter.ts:21</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L21">src/util/GenericEventEmitter.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">off</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.removeListener()</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-5" class="tsd-anchor"></a>Since<a href="#Since-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v10.0.0</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.off</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L19">src/util/GenericEventEmitter.ts:19</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L19">src/util/GenericEventEmitter.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the end of the listeners array for the
|
||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||
times.</p>
|
||
<pre><code class="js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependListener()</code> method can be used as an alternative to add the
|
||
event listener to the beginning of the listeners array.</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'a'</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">prependListener</span><span class="hl-1">(</span><span class="hl-2">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'b'</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'foo'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-6" class="tsd-anchor"></a>Since<a href="#Since-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.101</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: eventName-1" class="tsd-anchor"></a>Param: eventName<a href="#Param: eventName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The name of the event.</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: listener-1" class="tsd-anchor"></a>Param: listener<a href="#Param: listener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The callback function</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.on</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L16">src/util/GenericEventEmitter.ts:16</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L16">src/util/GenericEventEmitter.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">once</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
|
||
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
||
<pre><code class="js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">once</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
||
event listener to the beginning of the listeners array.</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">once</span><span class="hl-1">(</span><span class="hl-2">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'a'</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">prependOnceListener</span><span class="hl-1">(</span><span class="hl-2">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'b'</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'foo'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-7" class="tsd-anchor"></a>Since<a href="#Since-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.3.0</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: eventName-2" class="tsd-anchor"></a>Param: eventName<a href="#Param: eventName-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The name of the event.</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: listener-2" class="tsd-anchor"></a>Param: listener<a href="#Param: listener-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The callback function</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.once</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L17">src/util/GenericEventEmitter.ts:17</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L17">src/util/GenericEventEmitter.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="prependListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>prepend<wbr/>Listener</span><a href="#prependListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
|
||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||
times.</p>
|
||
<pre><code class="js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">prependListener</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-8" class="tsd-anchor"></a>Since<a href="#Since-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v6.0.0</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: eventName-3" class="tsd-anchor"></a>Param: eventName<a href="#Param: eventName-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The name of the event.</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: listener-3" class="tsd-anchor"></a>Param: listener<a href="#Param: listener-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The callback function</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.prependListener</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L25">src/util/GenericEventEmitter.ts:25</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L25">src/util/GenericEventEmitter.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="prependOnceListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>prepend<wbr/>Once<wbr/>Listener</span><a href="#prependOnceListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the <em>beginning</em> of the listeners array. The next time <code>eventName</code> is triggered, this
|
||
listener is removed, and then invoked.</p>
|
||
<pre><code class="js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">prependOnceListener</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-9" class="tsd-anchor"></a>Since<a href="#Since-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v6.0.0</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: eventName-4" class="tsd-anchor"></a>Param: eventName<a href="#Param: eventName-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The name of the event.</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: listener-4" class="tsd-anchor"></a>Param: listener<a href="#Param: listener-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The callback function</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.prependOnceListener</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L26">src/util/GenericEventEmitter.ts:26</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L26">src/util/GenericEventEmitter.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="rawListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>raw<wbr/>Listeners</span><a href="#rawListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">raw<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
||
including any wrappers (such as those created by <code>.once()</code>).</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">emitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-0">once</span><span class="hl-1">(</span><span class="hl-2">'log'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'log once'</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-5">// `listener` which contains the original listener bound above</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">listeners</span><span class="hl-1"> = </span><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-0">rawListeners</span><span class="hl-1">(</span><span class="hl-2">'log'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-6">listeners</span><span class="hl-1">[</span><span class="hl-7">0</span><span class="hl-1">];</span><br/><br/><span class="hl-5">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-6">logFnWrapper</span><span class="hl-1">.</span><span class="hl-0">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-0">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'log'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'log persistently'</span><span class="hl-1">));</span><br/><span class="hl-5">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">newListeners</span><span class="hl-1"> = </span><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-0">rawListeners</span><span class="hl-1">(</span><span class="hl-2">'log'</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Logs "log persistently" twice</span><br/><span class="hl-6">newListeners</span><span class="hl-1">[</span><span class="hl-7">0</span><span class="hl-1">]();</span><br/><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'log'</span><span class="hl-1">);</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-10" class="tsd-anchor"></a>Since<a href="#Since-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v9.4.0</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.rawListeners</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L22">src/util/GenericEventEmitter.ts:22</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L22">src/util/GenericEventEmitter.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="removeAllListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
|
||
<p>It is bad practice to remove listeners added elsewhere in the code,
|
||
particularly when the <code>EventEmitter</code> instance was created by some other
|
||
component or module (e.g. sockets or file streams).</p>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-11" class="tsd-anchor"></a>Since<a href="#Since-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.removeAllListeners</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L20">src/util/GenericEventEmitter.ts:20</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L20">src/util/GenericEventEmitter.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="removeListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Listener</span><a href="#removeListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">remove<wbr/>Listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"changed"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">activity</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#object"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#target"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Add"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Create"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Remove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"https://www.w3.org/ns/activitystreams#Update"</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type tsd-kind-class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-0">callback</span><span class="hl-1"> = (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">, </span><span class="hl-6">callback</span><span class="hl-1">);</span><br/><span class="hl-5">// ...</span><br/><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-0">removeListener</span><span class="hl-1">(</span><span class="hl-2">'connection'</span><span class="hl-1">, </span><span class="hl-6">callback</span><span class="hl-1">);</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p><code>removeListener()</code> will remove, at most, one instance of a listener from the
|
||
listener array. If any single listener has been added multiple times to the
|
||
listener array for the specified <code>eventName</code>, then <code>removeListener()</code> must be
|
||
called multiple times to remove each instance.</p>
|
||
<p>Once an event is emitted, all listeners attached to it at the
|
||
time of emitting are called in order. This implies that any<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and <em>before</em> the last listener finishes execution
|
||
will not remove them from<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-0">callbackA</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'A'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">removeListener</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">, </span><span class="hl-6">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-0">callbackB</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'B'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">, </span><span class="hl-6">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">, </span><span class="hl-6">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-5">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span><br/><span class="hl-5">// B</span><br/><br/><span class="hl-5">// callbackB is now removed.</span><br/><span class="hl-5">// Internal listener array [callbackA]</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'event'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Because listeners are managed using an internal array, calling this will
|
||
change the position indices of any listener registered <em>after</em> the listener
|
||
being removed. This will not impact the order in which listeners are called,
|
||
but it means that any copies of the listener array as returned by
|
||
the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
||
<p>When a single function has been added as a handler multiple times for a single
|
||
event (as in the example below), <code>removeListener()</code> will remove the most
|
||
recently added instance. In the example the <code>once('ping')</code>listener is removed:</p>
|
||
<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-0">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'pong'</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'ping'</span><span class="hl-1">, </span><span class="hl-6">pong</span><span class="hl-1">);</span><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-0">once</span><span class="hl-1">(</span><span class="hl-2">'ping'</span><span class="hl-1">, </span><span class="hl-6">pong</span><span class="hl-1">);</span><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-0">removeListener</span><span class="hl-1">(</span><span class="hl-2">'ping'</span><span class="hl-1">, </span><span class="hl-6">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'ping'</span><span class="hl-1">);</span><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'ping'</span><span class="hl-1">);</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-12" class="tsd-anchor"></a>Since<a href="#Since-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.removeListener</p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L18">src/util/GenericEventEmitter.ts:18</a></li><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/util/GenericEventEmitter.ts#L18">src/util/GenericEventEmitter.ts:18</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_captureRejectionSymbol_" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>[capture<wbr/>Rejection<wbr/>Symbol]</span><a href="#_captureRejectionSymbol_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="_captureRejectionSymbol_._captureRejectionSymbol_-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">[capture<wbr/>Rejection<wbr/>Symbol]</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">event</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_captureRejectionSymbol_._captureRejectionSymbol_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.[captureRejectionSymbol]</p><ul><li>Defined in node_modules/@types/node/events.d.ts:115</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Resource</span><a href="#addResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addResource.addResource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">container</span>, <span class="tsd-kind-parameter">representation</span>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#addResource.addResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new resource in the container.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">container</span>: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Container in which to create a resource.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">representation</span>: <a href="../interfaces/Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a></span><div class="tsd-comment tsd-typography"><p>Representation of the new resource</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="../interfaces/Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ResourceStore.html">ResourceStore</a>.<a href="../interfaces/ResourceStore.html#addResource">addResource</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L39">src/storage/MonitoringStore.ts:39</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Resource</span><a href="#deleteResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteResource.deleteResource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#deleteResource.deleteResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a resource.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to delete.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="../interfaces/Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ResourceStore.html">ResourceStore</a>.<a href="../interfaces/ResourceStore.html#deleteResource">deleteResource</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L47">src/storage/MonitoringStore.ts:47</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Max<wbr/>Listeners</span><a href="#getMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getMaxListeners.getMaxListeners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getMaxListeners.getMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the current max listener value for the <code>EventEmitter</code> which is either
|
||
set by <code>emitter.setMaxListeners(n)</code> or defaults to defaultMaxListeners.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-13" class="tsd-anchor"></a>Since<a href="#Since-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v1.0.0</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.getMaxListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:647</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRepresentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Representation</span><a href="#getRepresentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRepresentation.getRepresentation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Representation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">preferences</span>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a><span class="tsd-signature-symbol">></span><a href="#getRepresentation.getRepresentation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a representation of a resource.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of the resource to read.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">preferences</span>: <a href="../interfaces/RepresentationPreferences.html" class="tsd-signature-type tsd-kind-interface">RepresentationPreferences</a></span><div class="tsd-comment tsd-typography"><p>Preferences indicating desired representations.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="../interfaces/Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a><span class="tsd-signature-symbol">></span></h4><p>A representation corresponding to the identifier.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ResourceStore.html">ResourceStore</a>.<a href="../interfaces/ResourceStore.html#getRepresentation">getRepresentation</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L31">src/storage/MonitoringStore.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hasResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Resource</span><a href="#hasResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="hasResource.hasResource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">has<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#hasResource.hasResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks whether a resource exists in this ResourceSet.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to check.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A promise resolving if the resource already exists.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ResourceStore.html">ResourceStore</a>.<a href="../interfaces/ResourceStore.html#hasResource">hasResource</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L27">src/storage/MonitoringStore.ts:27</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="modifyResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>modify<wbr/>Resource</span><a href="#modifyResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="modifyResource.modifyResource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">modify<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">patch</span>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#modifyResource.modifyResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets or updates the representation of a resource,
|
||
creating a new resource and intermediary containers as needed.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to update.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">patch</span>: <a href="../interfaces/Patch.html" class="tsd-signature-type tsd-kind-interface">Patch</a></span><div class="tsd-comment tsd-typography"><p>Description of which parts to update.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="../interfaces/Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ResourceStore.html">ResourceStore</a>.<a href="../interfaces/ResourceStore.html#modifyResource">modifyResource</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L62">src/storage/MonitoringStore.ts:62</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="setMaxListeners.setMaxListeners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#setMaxListeners.setMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>By default <code>EventEmitter</code>s will print a warning if more than <code>10</code> listeners are
|
||
added for a particular event. This is a useful default that helps finding
|
||
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
|
||
modified for this specific <code>EventEmitter</code> instance. The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since-14" class="tsd-anchor"></a>Since<a href="#Since-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.3.5</p>
|
||
</div><aside class="tsd-sources"><p>Inherited from BaseActivityEmitter.setMaxListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:641</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setRepresentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Representation</span><a href="#setRepresentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setRepresentation.setRepresentation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Representation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">representation</span>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#setRepresentation.setRepresentation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets or replaces the representation of a resource,
|
||
creating a new resource and intermediary containers as needed.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to update.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">representation</span>: <a href="../interfaces/Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a></span><div class="tsd-comment tsd-typography"><p>New representation of the resource.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="../interfaces/Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ResourceStore.html">ResourceStore</a>.<a href="../interfaces/ResourceStore.html#setRepresentation">setRepresentation</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/storage/MonitoringStore.ts#L54">src/storage/MonitoringStore.ts:54</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#addListener" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Listener</span></a><a href="#emit" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a><a href="#eventNames" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Names</span></a><a href="#listenerCount" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listener<wbr/>Count</span></a><a href="#listeners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listeners</span></a><a href="#off" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>off</span></a><a href="#on" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on</span></a><a href="#once" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a><a href="#prependListener" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepend<wbr/>Listener</span></a><a href="#prependOnceListener" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a><a href="#rawListeners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw<wbr/>Listeners</span></a><a href="#removeAllListeners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#removeListener" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>Listener</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#_captureRejectionSymbol_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>[capture<wbr/>Rejection<wbr/>Symbol]</span></a><a href="#addResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Resource</span></a><a href="#deleteResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Resource</span></a><a href="#getMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a><a href="#getRepresentation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Representation</span></a><a href="#hasResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Resource</span></a><a href="#modifyResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>modify<wbr/>Resource</span></a><a href="#setMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a><a href="#setRepresentation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Representation</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Community Solid Server - v7.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|