Welshman

Appearance

Welshman Docs / @welshman/app / Router

Class: Router ​

Defined in: packages/app/src/router.ts:127

Constructors ​

new Router() ​

new Router(options): Router

Defined in: packages/app/src/router.ts:128

Parameters ​

options ​

RouterOptions

Returns ​

Router

Properties ​

options ​

readonly options: RouterOptions

Defined in: packages/app/src/router.ts:128

Methods ​

Event() ​

Event(event): RouterScenario

Defined in: packages/app/src/router.ts:174

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

EventAncestors() ​

EventAncestors(event, type): RouterScenario

Defined in: packages/app/src/router.ts:199

Parameters ​

event ​

TrustedEvent

type ​

"mentions" | "replies" | "roots"

Returns ​

RouterScenario

EventMentions() ​

EventMentions(event): RouterScenario

Defined in: packages/app/src/router.ts:222

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

EventParents() ​

EventParents(event): RouterScenario

Defined in: packages/app/src/router.ts:224

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

EventRoots() ​

EventRoots(event): RouterScenario

Defined in: packages/app/src/router.ts:226

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

ForPubkey() ​

ForPubkey(pubkey): RouterScenario

Defined in: packages/app/src/router.ts:161

Parameters ​

pubkey ​

string

Returns ​

RouterScenario

ForPubkeys() ​

ForPubkeys(pubkeys): RouterScenario

Defined in: packages/app/src/router.ts:168

Parameters ​

pubkeys ​

string[]

Returns ​

RouterScenario

ForUser() ​

ForUser(): RouterScenario

Defined in: packages/app/src/router.ts:155

Returns ​

RouterScenario

FromPubkey() ​

FromPubkey(pubkey): RouterScenario

Defined in: packages/app/src/router.ts:163

Parameters ​

pubkey ​

string

Returns ​

RouterScenario

FromPubkeys() ​

FromPubkeys(pubkeys): RouterScenario

Defined in: packages/app/src/router.ts:170

Parameters ​

pubkeys ​

string[]

Returns ​

RouterScenario

FromRelays() ​

FromRelays(relays): RouterScenario

Defined in: packages/app/src/router.ts:153

Parameters ​

relays ​

string[]

Returns ​

RouterScenario

FromUser() ​

FromUser(): RouterScenario

Defined in: packages/app/src/router.ts:157

Returns ​

RouterScenario

getRelaysForPubkey() ​

getRelaysForPubkey(pubkey, mode?): string[]

Defined in: packages/app/src/router.ts:132

Parameters ​

pubkey ​

string

mode? ​

RelayMode

Returns ​

string[]

getRelaysForPubkeys() ​

getRelaysForPubkeys(pubkeys, mode?): string[][]

Defined in: packages/app/src/router.ts:135

Parameters ​

pubkeys ​

string[]

mode? ​

RelayMode

Returns ​

string[][]

getRelaysForUser() ​

getRelaysForUser(mode?): string[]

Defined in: packages/app/src/router.ts:138

Parameters ​

mode? ​

RelayMode

Returns ​

string[]

merge() ​

merge(scenarios): RouterScenario

Defined in: packages/app/src/router.ts:148

Parameters ​

scenarios ​

RouterScenario[]

Returns ​

RouterScenario

PubkeyInbox() ​

PubkeyInbox(pubkey): RouterScenario

Defined in: packages/app/src/router.ts:165

Parameters ​

pubkey ​

string

Returns ​

RouterScenario

PubkeyInboxes() ​

PubkeyInboxes(pubkeys): RouterScenario

Defined in: packages/app/src/router.ts:172

Parameters ​

pubkeys ​

string[]

Returns ​

RouterScenario

PublishEvent() ​

PublishEvent(event): RouterScenario

Defined in: packages/app/src/router.ts:228

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

Quote() ​

Quote(event, value, relays): RouterScenario

Defined in: packages/app/src/router.ts:180

Parameters ​

event ​

TrustedEvent

value ​

string

relays ​

string[] = []

Returns ​

RouterScenario

Replies() ​

Replies(event): RouterScenario

Defined in: packages/app/src/router.ts:177

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

scenario() ​

scenario(selections): RouterScenario

Defined in: packages/app/src/router.ts:146

Parameters ​

selections ​

Selection[]

Returns ​

RouterScenario

UserInbox() ​

UserInbox(): RouterScenario

Defined in: packages/app/src/router.ts:159

Returns ​

RouterScenario