Welshman

Appearance

Welshman Docs / @welshman/router / RouterScenario

Class: RouterScenario ​

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

Constructors ​

Constructor ​

new RouterScenario(router, selections, options): RouterScenario

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

Parameters ​

router ​

Router

selections ​

Selection[]

options ​

RouterScenarioOptions = {}

Returns ​

RouterScenario

Properties ​

options ​

readonly options: RouterScenarioOptions = {}

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

router ​

readonly router: Router

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

selections ​

readonly selections: Selection[]

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

Methods ​

allowInsecure() ​

allowInsecure(allowInsecure): RouterScenario

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

Parameters ​

allowInsecure ​

boolean

Returns ​

RouterScenario

allowLocal() ​

allowLocal(allowLocal): RouterScenario

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

Parameters ​

allowLocal ​

boolean

Returns ​

RouterScenario

allowOnion() ​

allowOnion(allowOnion): RouterScenario

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

Parameters ​

allowOnion ​

boolean

Returns ​

RouterScenario

clone() ​

clone(options): RouterScenario

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

Parameters ​

options ​

RouterScenarioOptions

Returns ​

RouterScenario

filter() ​

filter(f): RouterScenario

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

Parameters ​

f ​

(selection) => boolean

Returns ​

RouterScenario

getLimit() ​

getLimit(): number

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

Returns ​

number

getPolicy() ​

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

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

Returns ​

(count, limit): number

Parameters ​
count ​

number

limit ​

number

Returns ​

number

getUrl() ​

getUrl(): undefined | string

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

Returns ​

undefined | string

getUrls() ​

getUrls(): string[]

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

Returns ​

string[]

limit() ​

limit(limit): RouterScenario

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

Parameters ​

limit ​

number

Returns ​

RouterScenario

policy() ​

policy(policy): RouterScenario

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

Parameters ​

policy ​

FallbackPolicy

Returns ​

RouterScenario

update() ​

update(f): RouterScenario

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

Parameters ​

f ​

(selection) => Selection

Returns ​

RouterScenario

weight() ​

weight(scale): RouterScenario

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

Parameters ​

scale ​

number

Returns ​

RouterScenario