Welshman

Appearance

Welshman Docs / @welshman/router / Router

Class: Router ​

Defined in: router/src/index.ts:125

Constructors ​

Constructor ​

new Router(options): Router

Defined in: router/src/index.ts:136

Parameters ​

options ​

RouterOptions

Returns ​

Router

Properties ​

options ​

readonly options: RouterOptions

Defined in: router/src/index.ts:126

Methods ​

Default() ​

Default(): RouterScenario

Defined in: router/src/index.ts:169

Returns ​

RouterScenario

Event() ​

Event(event): RouterScenario

Defined in: router/src/index.ts:190

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

EventAncestors() ​

EventAncestors(event, type): RouterScenario

Defined in: router/src/index.ts:215

Parameters ​

event ​

TrustedEvent

type ​

"roots" | "replies" | "mentions"

Returns ​

RouterScenario

EventMentions() ​

EventMentions(event): RouterScenario

Defined in: router/src/index.ts:236

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

EventParents() ​

EventParents(event): RouterScenario

Defined in: router/src/index.ts:238

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

EventRoots() ​

EventRoots(event): RouterScenario

Defined in: router/src/index.ts:240

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

ForPubkey() ​

ForPubkey(pubkey): RouterScenario

Defined in: router/src/index.ts:177

Parameters ​

pubkey ​

string

Returns ​

RouterScenario

ForPubkeys() ​

ForPubkeys(pubkeys): RouterScenario

Defined in: router/src/index.ts:184

Parameters ​

pubkeys ​

string[]

Returns ​

RouterScenario

ForUser() ​

ForUser(): RouterScenario

Defined in: router/src/index.ts:171

Returns ​

RouterScenario

FromPubkey() ​

FromPubkey(pubkey): RouterScenario

Defined in: router/src/index.ts:179

Parameters ​

pubkey ​

string

Returns ​

RouterScenario

FromPubkeys() ​

FromPubkeys(pubkeys): RouterScenario

Defined in: router/src/index.ts:186

Parameters ​

pubkeys ​

string[]

Returns ​

RouterScenario

FromRelays() ​

FromRelays(relays): RouterScenario

Defined in: router/src/index.ts:163

Parameters ​

relays ​

string[]

Returns ​

RouterScenario

FromUser() ​

FromUser(): RouterScenario

Defined in: router/src/index.ts:173

Returns ​

RouterScenario

getRelaysForPubkey() ​

getRelaysForPubkey(pubkey, mode?): string[]

Defined in: router/src/index.ts:142

Parameters ​

pubkey ​

string

mode? ​

RelayMode

Returns ​

string[]

getRelaysForPubkeys() ​

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

Defined in: router/src/index.ts:145

Parameters ​

pubkeys ​

string[]

mode? ​

RelayMode

Returns ​

string[][]

getRelaysForUser() ​

getRelaysForUser(mode?): string[]

Defined in: router/src/index.ts:148

Parameters ​

mode? ​

RelayMode

Returns ​

string[]

Index() ​

Index(): RouterScenario

Defined in: router/src/index.ts:167

Returns ​

RouterScenario

merge() ​

merge(scenarios): RouterScenario

Defined in: router/src/index.ts:158

Parameters ​

scenarios ​

RouterScenario[]

Returns ​

RouterScenario

PubkeyInbox() ​

PubkeyInbox(pubkey): RouterScenario

Defined in: router/src/index.ts:181

Parameters ​

pubkey ​

string

Returns ​

RouterScenario

PubkeyInboxes() ​

PubkeyInboxes(pubkeys): RouterScenario

Defined in: router/src/index.ts:188

Parameters ​

pubkeys ​

string[]

Returns ​

RouterScenario

PublishEvent() ​

PublishEvent(event): RouterScenario

Defined in: router/src/index.ts:242

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

Quote() ​

Quote(event, value, relays): RouterScenario

Defined in: router/src/index.ts:196

Parameters ​

event ​

TrustedEvent

value ​

string

relays ​

string[] = []

Returns ​

RouterScenario

Replies() ​

Replies(event): RouterScenario

Defined in: router/src/index.ts:193

Parameters ​

event ​

TrustedEvent

Returns ​

RouterScenario

scenario() ​

scenario(selections): RouterScenario

Defined in: router/src/index.ts:156

Parameters ​

selections ​

Selection[]

Returns ​

RouterScenario

Search(): RouterScenario

Defined in: router/src/index.ts:165

Returns ​

RouterScenario

UserInbox() ​

UserInbox(): RouterScenario

Defined in: router/src/index.ts:175

Returns ​

RouterScenario

configure() ​

static configure(options): void

Defined in: router/src/index.ts:128

Parameters ​

options ​

RouterOptions

Returns ​

void

get() ​

static get(): Router

Defined in: router/src/index.ts:132

Returns ​

Router