Welshman

Appearance

Welshman Docs / @welshman/util / RelayScenario

Class: RelayScenario ​

Defined in: packages/util/src/RelaySelection.ts:110

Constructors ​

Constructor ​

new RelayScenario(selections, options?): RelayScenario

Defined in: packages/util/src/RelaySelection.ts:111

Parameters ​

selections ​

Selection[]

options? ​

RelayScenarioOptions = {}

Returns ​

RelayScenario

Properties ​

options ​

readonly options: RelayScenarioOptions = {}

Defined in: packages/util/src/RelaySelection.ts:113

selections ​

readonly selections: Selection[]

Defined in: packages/util/src/RelaySelection.ts:112

Methods ​

allowInsecure() ​

allowInsecure(allowInsecure): RelayScenario

Defined in: packages/util/src/RelaySelection.ts:127

Parameters ​

allowInsecure ​

boolean

Returns ​

RelayScenario

allowLocal() ​

allowLocal(allowLocal): RelayScenario

Defined in: packages/util/src/RelaySelection.ts:123

Parameters ​

allowLocal ​

boolean

Returns ​

RelayScenario

allowOnion() ​

allowOnion(allowOnion): RelayScenario

Defined in: packages/util/src/RelaySelection.ts:125

Parameters ​

allowOnion ​

boolean

Returns ​

RelayScenario

clone() ​

clone(options): RelayScenario

Defined in: packages/util/src/RelaySelection.ts:116

Parameters ​

options ​

RelayScenarioOptions

Returns ​

RelayScenario

getAllUrls() ​

getAllUrls(): string[]

Defined in: packages/util/src/RelaySelection.ts:133

Returns ​

string[]

getLimit() ​

getLimit(): number

Defined in: packages/util/src/RelaySelection.ts:129

Returns ​

number

getPolicy() ​

getPolicy(): (count, limit) => number

Defined in: packages/util/src/RelaySelection.ts:131

Returns ​

(count, limit) => number

getUrl() ​

getUrl(): string | undefined

Defined in: packages/util/src/RelaySelection.ts:178

Returns ​

string | undefined

getUrls() ​

getUrls(): string[]

Defined in: packages/util/src/RelaySelection.ts:135

Returns ​

string[]

limit() ​

limit(limit): RelayScenario

Defined in: packages/util/src/RelaySelection.ts:119

Parameters ​

limit ​

number

Returns ​

RelayScenario

policy() ​

policy(policy): RelayScenario

Defined in: packages/util/src/RelaySelection.ts:121

Parameters ​

policy ​

FallbackPolicy

Returns ​

RelayScenario