Files
welshman/docs/classes/_welshman_app.Router.html
T
2024-12-13 14:16:38 -08:00

27 lines
60 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Router | Welshman Docs</title><meta name="description" content="Documentation for Welshman Docs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-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"><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">Welshman Docs</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">Welshman Docs</a></li><li><a href="../modules/_welshman_app.html">@welshman/app</a></li><li><a href="_welshman_app.Router.html">Router</a></li></ul><h1>Class Router</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L119">packages/app/src/router.ts:119</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="_welshman_app.Router.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="_welshman_app.Router.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_welshman_app.Router.html#event" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event</span></a>
<a href="_welshman_app.Router.html#eventancestors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Ancestors</span></a>
<a href="_welshman_app.Router.html#eventmentions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Mentions</span></a>
<a href="_welshman_app.Router.html#eventparents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Parents</span></a>
<a href="_welshman_app.Router.html#eventroots" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Roots</span></a>
<a href="_welshman_app.Router.html#forpubkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>For<wbr/>Pubkey</span></a>
<a href="_welshman_app.Router.html#forpubkeys" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>For<wbr/>Pubkeys</span></a>
<a href="_welshman_app.Router.html#foruser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>For<wbr/>User</span></a>
<a href="_welshman_app.Router.html#frompubkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>Pubkey</span></a>
<a href="_welshman_app.Router.html#frompubkeys" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>Pubkeys</span></a>
<a href="_welshman_app.Router.html#fromrelays" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>Relays</span></a>
<a href="_welshman_app.Router.html#fromuser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>User</span></a>
<a href="_welshman_app.Router.html#getrelaysforpubkey" 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/>Relays<wbr/>For<wbr/>Pubkey</span></a>
<a href="_welshman_app.Router.html#getrelaysforpubkeys" 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/>Relays<wbr/>For<wbr/>Pubkeys</span></a>
<a href="_welshman_app.Router.html#getrelaysforuser" 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/>Relays<wbr/>For<wbr/>User</span></a>
<a href="_welshman_app.Router.html#merge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>merge</span></a>
<a href="_welshman_app.Router.html#pubkeyinbox" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Pubkey<wbr/>Inbox</span></a>
<a href="_welshman_app.Router.html#pubkeyinboxes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Pubkey<wbr/>Inboxes</span></a>
<a href="_welshman_app.Router.html#publishevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Publish<wbr/>Event</span></a>
<a href="_welshman_app.Router.html#quote" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Quote</span></a>
<a href="_welshman_app.Router.html#replies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Replies</span></a>
<a href="_welshman_app.Router.html#scenario" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scenario</span></a>
<a href="_welshman_app.Router.html#userinbox" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>User<wbr/>Inbox</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="constructorrouter" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Router</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_app.RouterOptions.html" class="tsd-signature-type tsd-kind-type-alias">RouterOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.Router.html" class="tsd-signature-type tsd-kind-class">Router</a><a href="#constructorrouter" 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">options</span>: <a href="../types/_welshman_app.RouterOptions.html" class="tsd-signature-type tsd-kind-type-alias">RouterOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.Router.html" class="tsd-signature-type tsd-kind-class">Router</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L120">packages/app/src/router.ts:120</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"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>options</span><a href="#options" 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">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_app.RouterOptions.html" class="tsd-signature-type tsd-kind-type-alias">RouterOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L120">packages/app/src/router.ts:120</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"><a id="event" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Event</span><a href="#event" 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="event-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#event-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L175">packages/app/src/router.ts:175</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="eventancestors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Event<wbr/>Ancestors</span><a href="#eventancestors" 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="eventancestors-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">EventAncestors</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;mentions&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;replies&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;roots&quot;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#eventancestors-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">&quot;mentions&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;replies&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;roots&quot;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L199">packages/app/src/router.ts:199</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="eventmentions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Event<wbr/>Mentions</span><a href="#eventmentions" 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="eventmentions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">EventMentions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#eventmentions-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L219">packages/app/src/router.ts:219</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="eventparents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Event<wbr/>Parents</span><a href="#eventparents" 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="eventparents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">EventParents</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#eventparents-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L221">packages/app/src/router.ts:221</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="eventroots" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Event<wbr/>Roots</span><a href="#eventroots" 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="eventroots-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">EventRoots</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#eventroots-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L223">packages/app/src/router.ts:223</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="forpubkey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>For<wbr/>Pubkey</span><a href="#forpubkey" 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="forpubkey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ForPubkey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#forpubkey-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">pubkey</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L157">packages/app/src/router.ts:157</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="forpubkeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>For<wbr/>Pubkeys</span><a href="#forpubkeys" 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="forpubkeys-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ForPubkeys</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkeys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#forpubkeys-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">pubkeys</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L166">packages/app/src/router.ts:166</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="foruser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>For<wbr/>User</span><a href="#foruser" 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="foruser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ForUser</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#foruser-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"><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L148">packages/app/src/router.ts:148</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="frompubkey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>From<wbr/>Pubkey</span><a href="#frompubkey" 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="frompubkey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">FromPubkey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#frompubkey-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">pubkey</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L160">packages/app/src/router.ts:160</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="frompubkeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>From<wbr/>Pubkeys</span><a href="#frompubkeys" 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="frompubkeys-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">FromPubkeys</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkeys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#frompubkeys-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">pubkeys</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L169">packages/app/src/router.ts:169</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromrelays" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>From<wbr/>Relays</span><a href="#fromrelays" 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="fromrelays-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">FromRelays</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">relays</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#fromrelays-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">relays</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L145">packages/app/src/router.ts:145</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromuser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>From<wbr/>User</span><a href="#fromuser" 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="fromuser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">FromUser</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#fromuser-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"><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L151">packages/app/src/router.ts:151</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getrelaysforpubkey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Relays<wbr/>For<wbr/>Pubkey</span><a href="#getrelaysforpubkey" 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="getrelaysforpubkey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getRelaysForPubkey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/_welshman_app.RelayMode.html" class="tsd-signature-type tsd-kind-enum">RelayMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getrelaysforpubkey-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">pubkey</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mode</span>: <a href="../enums/_welshman_app.RelayMode.html" class="tsd-signature-type tsd-kind-enum">RelayMode</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L124">packages/app/src/router.ts:124</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getrelaysforpubkeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Relays<wbr/>For<wbr/>Pubkeys</span><a href="#getrelaysforpubkeys" 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="getrelaysforpubkeys-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getRelaysForPubkeys</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkeys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/_welshman_app.RelayMode.html" class="tsd-signature-type tsd-kind-enum">RelayMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><a href="#getrelaysforpubkeys-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">pubkeys</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mode</span>: <a href="../enums/_welshman_app.RelayMode.html" class="tsd-signature-type tsd-kind-enum">RelayMode</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L127">packages/app/src/router.ts:127</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getrelaysforuser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Relays<wbr/>For<wbr/>User</span><a href="#getrelaysforuser" 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="getrelaysforuser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getRelaysForUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/_welshman_app.RelayMode.html" class="tsd-signature-type tsd-kind-enum">RelayMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getrelaysforuser-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><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mode</span>: <a href="../enums/_welshman_app.RelayMode.html" class="tsd-signature-type tsd-kind-enum">RelayMode</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L130">packages/app/src/router.ts:130</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="merge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>merge</span><a href="#merge" 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="merge-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">merge</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scenarios</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#merge-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">scenarios</span>: <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L140">packages/app/src/router.ts:140</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pubkeyinbox" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Pubkey<wbr/>Inbox</span><a href="#pubkeyinbox" 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="pubkeyinbox-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">PubkeyInbox</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#pubkeyinbox-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">pubkey</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L163">packages/app/src/router.ts:163</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pubkeyinboxes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Pubkey<wbr/>Inboxes</span><a href="#pubkeyinboxes" 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="pubkeyinboxes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">PubkeyInboxes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pubkeys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#pubkeyinboxes-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">pubkeys</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L172">packages/app/src/router.ts:172</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="publishevent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Publish<wbr/>Event</span><a href="#publishevent" 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="publishevent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">PublishEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#publishevent-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L225">packages/app/src/router.ts:225</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="quote" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Quote</span><a href="#quote" 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="quote-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Quote</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">relays</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#quote-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">relays</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L181">packages/app/src/router.ts:181</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="replies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Replies</span><a href="#replies" 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="replies-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Replies</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#replies-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">event</span>: <a href="../types/_welshman_util.TrustedEvent.html" class="tsd-signature-type tsd-kind-type-alias">TrustedEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L178">packages/app/src/router.ts:178</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="scenario" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>scenario</span><a href="#scenario" 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="scenario-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">scenario</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">selections</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_app.Selection.html" class="tsd-signature-type tsd-kind-type-alias">Selection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#scenario-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">selections</span>: <a href="../types/_welshman_app.Selection.html" class="tsd-signature-type tsd-kind-type-alias">Selection</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L138">packages/app/src/router.ts:138</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="userinbox" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>User<wbr/>Inbox</span><a href="#userinbox" 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="userinbox-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UserInbox</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a><a href="#userinbox-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"><h4 class="tsd-returns-title">Returns <a href="_welshman_app.RouterScenario.html" class="tsd-signature-type tsd-kind-class">RouterScenario</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/app/src/router.ts#L154">packages/app/src/router.ts:154</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="section-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="section-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="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-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="#event" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event</span></a><a href="#eventancestors" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Ancestors</span></a><a href="#eventmentions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Mentions</span></a><a href="#eventparents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Parents</span></a><a href="#eventroots" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Event<wbr/>Roots</span></a><a href="#forpubkey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>For<wbr/>Pubkey</span></a><a href="#forpubkeys" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>For<wbr/>Pubkeys</span></a><a href="#foruser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>For<wbr/>User</span></a><a href="#frompubkey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>Pubkey</span></a><a href="#frompubkeys" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>Pubkeys</span></a><a href="#fromrelays" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>Relays</span></a><a href="#fromuser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>From<wbr/>User</span></a><a href="#getrelaysforpubkey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Relays<wbr/>For<wbr/>Pubkey</span></a><a href="#getrelaysforpubkeys" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Relays<wbr/>For<wbr/>Pubkeys</span></a><a href="#getrelaysforuser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Relays<wbr/>For<wbr/>User</span></a><a href="#merge" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>merge</span></a><a href="#pubkeyinbox" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Pubkey<wbr/>Inbox</span></a><a href="#pubkeyinboxes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Pubkey<wbr/>Inboxes</span></a><a href="#publishevent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Publish<wbr/>Event</span></a><a href="#quote" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Quote</span></a><a href="#replies" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Replies</span></a><a href="#scenario" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scenario</span></a><a href="#userinbox" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>User<wbr/>Inbox</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Welshman Docs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>