@robbiemu/handy-typescript

@robbiemu/handy-typescript / Modules / BetweenBuilder

Class: BetweenBuilder

Description

general factory helper to populate a generator with a collection of values

Table of contents

Constructors

• constructor

Properties

• arity
• bounds
• generator

Methods

• and
• between
• setBounds
• assertBeforeWithInitialValue
• build
• completeBefore

Constructors

constructor

• new BetweenBuilder(generator, arity)

Parameters

Name	Type
generator	Function
arity	number

Defined in

src/utility/between-builder.ts:14

Properties

arity

• Private arity: number

Defined in

src/utility/between-builder.ts:14

---

bounds

• bounds: List<unknown>

Defined in

src/utility/between-builder.ts:12

---

generator

• Private generator: Function

Defined in

src/utility/between-builder.ts:14

Methods

and

▸ and(this, value): any

Method

and

Description

add a bound to the collection of bounds, optionally completing the factory setup by executing the generator function

Parameters

Name	Type
this	BetweenBuilder
value	unknown

Returns

any

either this BetweenBuilder or the result of the generator function if all bounds have been collected

Defined in

src/utility/between-builder.ts:52

---

between

▸ between(value): BetweenBuilder

Method

between

Description

add a bound to the collection of bounds, optionally completing the factory setup by executing the generator function

Parameters

Name	Type
value	unknown

Returns

BetweenBuilder

either this BetweenBuilder or the result of the generator function if all bounds have been collected

Defined in

src/utility/between-builder.ts:65

---

setBounds

▸ setBounds(bounds): BetweenBuilder

Method

bounds

Description

add bounds to the collection of bounds, optionally completing the factory setup by executing the generator function

Parameters

Name	Type
bounds	unknown[]

Returns

BetweenBuilder

either this BetweenBuilder or the result of the generator function if all bounds have been collected

Defined in

src/utility/between-builder.ts:78

---

assertBeforeWithInitialValue

▸ Static assertBeforeWithInitialValue(this): void

Static

Method

assertBeforeWithInitialValue

Description

static psuedo-private method used in decorator to assert that the method is called after setting an initial value

Parameters

Name	Type
this	BetweenBuilder

Returns

void

Defined in

src/utility/between-builder.ts:31

---

build

▸ Static build(generator, arity?): BetweenBuilder

Static

Method

build

Parameters

Name	Type	Default value	Description
generator	Function	undefined	function accepting bounds
arity	number	2	-

Returns

BetweenBuilder

Defined in

src/utility/between-builder.ts:22

---

completeBefore

▸ Static completeBefore(this): void

Static

Method

completeBefore

Description

static psuedo-private method used in decorator to detect completion of setting the first value, deleting the between method

Parameters

Name	Type
this	BetweenBuilder

Returns

void

Defined in

src/utility/between-builder.ts:40