UnionBuilder
Defined in: packages/schema/src/builders/union.ts:11
Extends
Section titled “Extends”Builder<Value,ExtractOutputFromType<TTypes[number]>,UnionType<TTypes>>
Type Parameters
Section titled “Type Parameters”TTypes
Section titled “TTypes”TTypes extends Type<Value, any> & IExpressionValueType<any>[]
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UnionBuilder<
TTypes>(types_):UnionBuilder<TTypes>
Defined in: packages/schema/src/builders/union.ts:18
Parameters
Section titled “Parameters”types_
Section titled “types_”[...TTypes[]]
Returns
Section titled “Returns”UnionBuilder<TTypes>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:Value
Defined in: packages/schema/src/builders/base.ts:9
Inherited from
Section titled “Inherited from”output_
Section titled “output_”
readonlyoutput_:ExtractOutputFromType
Defined in: packages/schema/src/builders/base.ts:10
Inherited from
Section titled “Inherited from”
readonlytype_:UnionType
Defined in: packages/schema/src/builders/base.ts:11
Inherited from
Section titled “Inherited from”validators_
Section titled “validators_”
protectedvalidators_:Validator<ExtractOutputFromType<TTypes[number]>>[]
Defined in: packages/schema/src/builders/base.ts:13
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”params
Section titled “params”Get Signature
Section titled “Get Signature”get params():
UnionTypeParams<TTypes>
Defined in: packages/schema/src/builders/union.ts:22
Returns
Section titled “Returns”UnionTypeParams<TTypes>
Overrides
Section titled “Overrides”Methods
Section titled “Methods”build()
Section titled “build()”build():
UnionType<TTypes>
Defined in: packages/schema/src/builders/union.ts:29
Returns
Section titled “Returns”UnionType<TTypes>
Overrides
Section titled “Overrides”clone()
Section titled “clone()”clone():
this
Defined in: packages/schema/src/builders/base.ts:27
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”oneOf()
Section titled “oneOf()”oneOf(
values,equal?):UnionBuilder<TTypes>
Defined in: packages/schema/src/builders/base.ts:42
Parameters
Section titled “Parameters”values
Section titled “values”ExtractOutputFromType<TTypes[number]>[]
equal?
Section titled “equal?”(value, other) => boolean
Returns
Section titled “Returns”UnionBuilder<TTypes>
Inherited from
Section titled “Inherited from”test()
Section titled “test()”test(
func,message?):this
Defined in: packages/schema/src/builders/base.ts:33
Parameters
Section titled “Parameters”ValidatorFunction<ExtractOutputFromType<TTypes[number]>>
message?
Section titled “message?”string
Returns
Section titled “Returns”this