DiscriminatedUnionType
Defined in: packages/schema/src/types/discriminated-union.ts:17
Extends
Section titled “Extends”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 DiscriminatedUnionType<
TOut,TMapping>(__namedParameters):DiscriminatedUnionType<TOut,TMapping>
Defined in: packages/schema/src/types/discriminated-union.ts:23
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”DiscriminatedUnionTypeParams<TOut, TMapping>
Returns
Section titled “Returns”DiscriminatedUnionType<TOut, TMapping>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:Node
Defined in: packages/schema/src/types/base.ts:34
Inherited from
Section titled “Inherited from”output_
Section titled “output_”
readonlyoutput_:TOut
Defined in: packages/schema/src/types/base.ts:35
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”mapping
Section titled “mapping”Get Signature
Section titled “Get Signature”get mapping():
TMapping
Defined in: packages/schema/src/types/discriminated-union.ts:31
Returns
Section titled “Returns”TMapping
Methods
Section titled “Methods”parse()
Section titled “parse()”parse(
value,ctx):Result<TOut,SchemaError>
Defined in: packages/schema/src/types/base.ts:58
Parameters
Section titled “Parameters”Node | undefined
Returns
Section titled “Returns”Result<TOut, SchemaError>
Inherited from
Section titled “Inherited from”parse_()
Section titled “parse_()”
protectedparse_(value,ctx):Result<TOut,SchemaError>
Defined in: packages/schema/src/types/discriminated-union.ts:35
Parameters
Section titled “Parameters”Node | undefined
Returns
Section titled “Returns”Result<TOut, SchemaError>
Overrides
Section titled “Overrides”validate_()
Section titled “validate_()”
protectedvalidate_(value):Result<void,string>
Defined in: packages/schema/src/types/base.ts:48
Parameters
Section titled “Parameters”TOut
Returns
Section titled “Returns”Result<void, string>