Welshman Docs / @welshman/app / RouterScenario

Class: RouterScenario

Defined in: app/src/router.ts:327

Constructors

Constructor

new RouterScenario(router, selections, options): RouterScenario

Defined in: app/src/router.ts:328

Parameters

router

Router

selections

Selection[]

options

RouterScenarioOptions = {}

Returns

RouterScenario

Properties

options

readonly options: RouterScenarioOptions = {}

Defined in: app/src/router.ts:331

---

router

readonly router: Router

Defined in: app/src/router.ts:329

---

selections

readonly selections: Selection[]

Defined in: app/src/router.ts:330

Methods

allowInsecure()

allowInsecure(allowInsecure): RouterScenario

Defined in: app/src/router.ts:359

Parameters

allowInsecure

boolean

Returns

RouterScenario

---

allowLocal()

allowLocal(allowLocal): RouterScenario

Defined in: app/src/router.ts:355

Parameters

allowLocal

boolean

Returns

RouterScenario

---

allowOnion()

allowOnion(allowOnion): RouterScenario

Defined in: app/src/router.ts:357

Parameters

allowOnion

boolean

Returns

RouterScenario

---

clone()

clone(options): RouterScenario

Defined in: app/src/router.ts:334

Parameters

options

RouterScenarioOptions

Returns

RouterScenario

---

filter()

filter(f): RouterScenario

Defined in: app/src/router.ts:337

Parameters

f

(selection) => boolean

Returns

RouterScenario

---

getLimit()

getLimit(): number

Defined in: app/src/router.ts:366

Returns

number

---

getPolicy()

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

Defined in: app/src/router.ts:364

Returns

(count, limit): number

Parameters

count

number

limit

number

Returns

number

---

getUrl()

getUrl(): undefined | string

Defined in: app/src/router.ts:411

Returns

undefined | string

---

getUrls()

getUrls(): string[]

Defined in: app/src/router.ts:368

Returns

string[]

---

limit()

limit(limit): RouterScenario

Defined in: app/src/router.ts:353

Parameters

limit

number

Returns

RouterScenario

---

policy()

policy(policy): RouterScenario

Defined in: app/src/router.ts:351

Parameters

policy

FallbackPolicy

Returns

RouterScenario

---

update()

update(f): RouterScenario

Defined in: app/src/router.ts:344

Parameters

f

(selection) => Selection

Returns

RouterScenario

---

weight()

weight(scale): RouterScenario

Defined in: app/src/router.ts:361

Parameters

scale

number

Returns

RouterScenario