Welshman

Appearance

Welshman Docs / @welshman/app / RouterScenario

Class: RouterScenario ​

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

Constructors ​

new RouterScenario() ​

new RouterScenario(router, selections, options): RouterScenario

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

Parameters ​

router ​

Router

selections ​

Selection[]

options ​

RouterScenarioOptions = {}

Returns ​

RouterScenario

Properties ​

options ​

readonly options: RouterScenarioOptions = {}

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

router ​

readonly router: Router

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

selections ​

readonly selections: Selection[]

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

Methods ​

allowInsecure() ​

allowInsecure(allowInsecure): RouterScenario

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

Parameters ​

allowInsecure ​

boolean

Returns ​

RouterScenario

allowLocal() ​

allowLocal(allowLocal): RouterScenario

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

Parameters ​

allowLocal ​

boolean

Returns ​

RouterScenario

allowOnion() ​

allowOnion(allowOnion): RouterScenario

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

Parameters ​

allowOnion ​

boolean

Returns ​

RouterScenario

clone() ​

clone(options): RouterScenario

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

Parameters ​

options ​

RouterScenarioOptions

Returns ​

RouterScenario

filter() ​

filter(f): RouterScenario

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

Parameters ​

f ​

(selection) => boolean

Returns ​

RouterScenario

getLimit() ​

getLimit(): number

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

Returns ​

number

getPolicy() ​

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

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

Returns ​

Function

Parameters ​
count ​

number

limit ​

number

Returns ​

number

getUrl() ​

getUrl(): string

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

Returns ​

string

getUrls() ​

getUrls(): string[]

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

Returns ​

string[]

limit() ​

limit(limit): RouterScenario

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

Parameters ​

limit ​

number

Returns ​

RouterScenario

policy() ​

policy(policy): RouterScenario

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

Parameters ​

policy ​

FallbackPolicy

Returns ​

RouterScenario

update() ​

update(f): RouterScenario

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

Parameters ​

f ​

(selection) => Selection

Returns ​

RouterScenario

weight() ​

weight(scale): RouterScenario

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

Parameters ​

scale ​

number

Returns ​

RouterScenario