EnumBuilder

Defined in: packages/schema/src/builders/enum.ts:4

Extends

• Builder<Value, T, EnumType<T>>

Type Parameters

T

T extends string

Constructors

Constructor

new EnumBuilder<T>(values_): EnumBuilder<T>

Defined in: packages/schema/src/builders/enum.ts:9

Parameters

values_

T[]

Returns

EnumBuilder<T>

Overrides

Builder.constructor

Properties

input_

readonly input_: Value

Defined in: packages/schema/src/builders/base.ts:9

Inherited from

Builder.input_

---

output_

readonly output_: T

Defined in: packages/schema/src/builders/base.ts:10

Inherited from

Builder.output_

---

type_

readonly type_: EnumType

Defined in: packages/schema/src/builders/base.ts:11

Inherited from

Builder.type_

---

validators_

protected validators_: Validator<T>[]

Defined in: packages/schema/src/builders/base.ts:13

Inherited from

Builder.validators_

Accessors

params

Get Signature

get params(): EnumTypeParams<T>

Defined in: packages/schema/src/builders/enum.ts:13

Returns

EnumTypeParams<T>

Overrides

Builder.params

Methods

build()

build(): EnumType<T>

Defined in: packages/schema/src/builders/enum.ts:26

Returns

EnumType<T>

Overrides

Builder.build

---

clone()

clone(): this

Defined in: packages/schema/src/builders/enum.ts:20

Returns

this

Overrides

Builder.clone

---

oneOf()

oneOf(values, equal?): EnumBuilder<T>

Defined in: packages/schema/src/builders/base.ts:42

Parameters

values

T[]

equal?

(value, other) => boolean

Returns

EnumBuilder<T>

Inherited from

Builder.oneOf

---

test()

test(func, message?): this

Defined in: packages/schema/src/builders/base.ts:33

Parameters

func

ValidatorFunction<T>

message?

string

Returns

this

Inherited from

Builder.test