DocumentStructBuilder
Defined in: packages/schema/src/builders/struct.ts:57
Extends
Section titled “Extends”StructBuilder<Document,Node,TMembers,DocumentStructType<TMembers>>
Type Parameters
Section titled “Type Parameters”TMembers
Section titled “TMembers”TMembers extends Record<string, Type<Node, any>>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DocumentStructBuilder<
TMembers>(members_):DocumentStructBuilder<TMembers>
Defined in: packages/schema/src/builders/struct.ts:23
Parameters
Section titled “Parameters”members_
Section titled “members_”TMembers
Returns
Section titled “Returns”DocumentStructBuilder<TMembers>
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:Document
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_:DocumentStructType
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>
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”build()
Section titled “build()”build():
DocumentStructType<TMembers>
Defined in: packages/schema/src/builders/struct.ts:65
Returns
Section titled “Returns”DocumentStructType<TMembers>
Overrides
Section titled “Overrides”clone()
Section titled “clone()”clone():
this
Defined in: packages/schema/src/builders/struct.ts:35
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”extend()
Section titled “extend()”extend<
TExtension>(extension):DocumentStructBuilder<TMembers&TExtension>
Defined in: packages/schema/src/builders/struct.ts:69
Type Parameters
Section titled “Type Parameters”TExtension
Section titled “TExtension”TExtension extends Record<string, Type<Node, any>>
Parameters
Section titled “Parameters”extension
Section titled “extension”TExtension
Returns
Section titled “Returns”DocumentStructBuilder<TMembers & TExtension>
extend_()
Section titled “extend_()”
protectedextend_<TExtension>(newMembers):any
Defined in: packages/schema/src/builders/struct.ts:48
Type Parameters
Section titled “Type Parameters”TExtension
Section titled “TExtension”TExtension extends Record<string, Type<Node, any>>
Parameters
Section titled “Parameters”newMembers
Section titled “newMembers”TExtension
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”oneOf()
Section titled “oneOf()”oneOf(
values,equal?):DocumentStructBuilder<TMembers>
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”DocumentStructBuilder<TMembers>
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
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<ExtractOutputFromTypes<TMembers>>
message?
Section titled “message?”string
Returns
Section titled “Returns”this