DiscriminatedUnionBuilder
Defined in: packages/schema/src/builders/discriminated-union.ts:9
Extends
Section titled “Extends”Builder<Node,TOut,DiscriminatedUnionType<TOut,TMapping>>
Type Parameters
Section titled “Type Parameters”TOut
TMapping
Section titled “TMapping”TMapping extends Record<string, Type<Node, TOut>>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DiscriminatedUnionBuilder<
TOut,TMapping>(mapping_):DiscriminatedUnionBuilder<TOut,TMapping>
Defined in: packages/schema/src/builders/discriminated-union.ts:13
Parameters
Section titled “Parameters”mapping_
Section titled “mapping_”TMapping
Returns
Section titled “Returns”DiscriminatedUnionBuilder<TOut, TMapping>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:Node
Defined in: packages/schema/src/builders/base.ts:9
Inherited from
Section titled “Inherited from”output_
Section titled “output_”
readonlyoutput_:TOut
Defined in: packages/schema/src/builders/base.ts:10
Inherited from
Section titled “Inherited from”
readonlytype_:DiscriminatedUnionType
Defined in: packages/schema/src/builders/base.ts:11
Inherited from
Section titled “Inherited from”validators_
Section titled “validators_”
protectedvalidators_:Validator<TOut>[]
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():
DiscriminatedUnionTypeParams<TOut,TMapping>
Defined in: packages/schema/src/builders/discriminated-union.ts:17
Returns
Section titled “Returns”DiscriminatedUnionTypeParams<TOut, TMapping>
Overrides
Section titled “Overrides”Methods
Section titled “Methods”build()
Section titled “build()”build():
DiscriminatedUnionType<TOut,TMapping>
Defined in: packages/schema/src/builders/discriminated-union.ts:30
Returns
Section titled “Returns”DiscriminatedUnionType<TOut, TMapping>
Overrides
Section titled “Overrides”clone()
Section titled “clone()”clone():
this
Defined in: packages/schema/src/builders/discriminated-union.ts:24
Returns
Section titled “Returns”this
Overrides
Section titled “Overrides”extend()
Section titled “extend()”extend<
TExtension>(types):DiscriminatedUnionBuilder<TOut,TMapping&TExtension>
Defined in: packages/schema/src/builders/discriminated-union.ts:34
Type Parameters
Section titled “Type Parameters”TExtension
Section titled “TExtension”TExtension extends Record<string, Type<Node, TOut>>
Parameters
Section titled “Parameters”TExtension
Returns
Section titled “Returns”DiscriminatedUnionBuilder<TOut, TMapping & TExtension>
oneOf()
Section titled “oneOf()”oneOf(
values,equal?):DiscriminatedUnionBuilder<TOut,TMapping>
Defined in: packages/schema/src/builders/base.ts:42
Parameters
Section titled “Parameters”values
Section titled “values”TOut[]
equal?
Section titled “equal?”(value, other) => boolean
Returns
Section titled “Returns”DiscriminatedUnionBuilder<TOut, TMapping>
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<TOut>
message?
Section titled “message?”string
Returns
Section titled “Returns”this