StructBuilder
Defined in: packages/schema/src/builders/struct.ts:15
Extends
Section titled “Extends”Builder<TIn,ExtractOutputFromTypes<TMembers>,TType>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”TIn
TMemberIn
Section titled “TMemberIn”TMemberIn
TMembers
Section titled “TMembers”TMembers extends Record<string, Type<TMemberIn, any>>
TType extends StructType<TIn, TMemberIn, TMembers>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new StructBuilder<
TIn,TMemberIn,TMembers,TType>(members_):StructBuilder<TIn,TMemberIn,TMembers,TType>
Defined in: packages/schema/src/builders/struct.ts:23
Parameters
Section titled “Parameters”members_
Section titled “members_”TMembers
Returns
Section titled “Returns”StructBuilder<TIn, TMemberIn, TMembers, TType>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:TIn
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_:TType
Defined in: packages/schema/src/builders/base.ts:11
Inherited from
Section titled “Inherited from”validators_
Section titled “validators_”
protectedvalidators_:Validator<ExtractOutputFromTypes<TMembers>>[]
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():
StructTypeParams<TMemberIn,TMembers>
Defined in: packages/schema/src/builders/struct.ts:27
Returns
Section titled “Returns”StructTypeParams<TMemberIn, TMembers>
Overrides
Section titled “Overrides”Methods
Section titled “Methods”build()
Section titled “build()”
abstractbuild():TType
Defined in: packages/schema/src/builders/base.ts:19
Returns
Section titled “Returns”TType
Inherited from
Section titled “Inherited from”clone()
Section titled “clone()”clone():
this
Defined in: packages/schema/src/builders/struct.ts:35
Returns
Section titled “Returns”this
Overrides
Section titled “Overrides”oneOf()
Section titled “oneOf()”oneOf(
values,equal?):StructBuilder<TIn,TMemberIn,TMembers,TType>
Defined in: packages/schema/src/builders/base.ts:42
Parameters
Section titled “Parameters”values
Section titled “values”ExtractOutputFromTypes<TMembers>[]
equal?
Section titled “equal?”(value, other) => boolean
Returns
Section titled “Returns”StructBuilder<TIn, TMemberIn, TMembers, TType>
Inherited from
Section titled “Inherited from”prefix()
Section titled “prefix()”prefix(
prefix):this
Defined in: packages/schema/src/builders/struct.ts:42
Parameters
Section titled “Parameters”prefix
Section titled “prefix”string | undefined
Returns
Section titled “Returns”this
test()
Section titled “test()”test(
func,message?):this
Defined in: packages/schema/src/builders/base.ts:33
Parameters
Section titled “Parameters”ValidatorFunction<ExtractOutputFromTypes<TMembers>>
message?
Section titled “message?”string
Returns
Section titled “Returns”this