Welshman

Appearance

Welshman Docs / @welshman/util / RelayScenario

Class: RelayScenario ​

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

Constructors ​

Constructor ​

new RelayScenario(selections, options): RelayScenario

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

Parameters ​

selections ​

Selection[]

options ​

RelayScenarioOptions = {}

Returns ​

RelayScenario

Properties ​

options ​

readonly options: RelayScenarioOptions = {}

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

selections ​

readonly selections: Selection[]

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

Methods ​

allowInsecure() ​

allowInsecure(allowInsecure): RelayScenario

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

Parameters ​

allowInsecure ​

boolean

Returns ​

RelayScenario

allowLocal() ​

allowLocal(allowLocal): RelayScenario

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

Parameters ​

allowLocal ​

boolean

Returns ​

RelayScenario

allowOnion() ​

allowOnion(allowOnion): RelayScenario

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

Parameters ​

allowOnion ​

boolean

Returns ​

RelayScenario

clone() ​

clone(options): RelayScenario

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

Parameters ​

options ​

RelayScenarioOptions

Returns ​

RelayScenario

getLimit() ​

getLimit(): number

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

Returns ​

number

getPolicy() ​

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

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

Returns ​

(count, limit): number

Parameters ​
count ​

number

limit ​

number

Returns ​

number

getUrl() ​

getUrl(): undefined | string

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

Returns ​

undefined | string

getUrls() ​

getUrls(): string[]

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

Returns ​

string[]

limit() ​

limit(limit): RelayScenario

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

Parameters ​

limit ​

number

Returns ​

RelayScenario

policy() ​

policy(policy): RelayScenario

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

Parameters ​

policy ​

FallbackPolicy

Returns ​

RelayScenario