DocumentStructType
Defined in: packages/schema/src/types/struct.ts:81
Extends
Section titled “Extends”StructType<Document,Node,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 DocumentStructType<
TMembers>(__namedParameters):DocumentStructType<TMembers>
Defined in: packages/schema/src/types/struct.ts:29
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”StructTypeParams<Node, TMembers>
Returns
Section titled “Returns”DocumentStructType<TMembers>
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:Document
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”members
Section titled “members”Get Signature
Section titled “Get Signature”get members():
TMembers
Defined in: packages/schema/src/types/struct.ts:39
Returns
Section titled “Returns”TMembers
Inherited from
Section titled “Inherited from”prefix
Section titled “prefix”Get Signature
Section titled “Get Signature”get prefix():
string|undefined
Defined in: packages/schema/src/types/struct.ts:43
Returns
Section titled “Returns”string | undefined
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”getItems()
Section titled “getItems()”
protectedgetItems(value):Record<string,Node>
Defined in: packages/schema/src/types/struct.ts:84
Parameters
Section titled “Parameters”Document
Returns
Section titled “Returns”Record<string, Node>
Overrides
Section titled “Overrides”parse()
Section titled “parse()”parse(
value,ctx):Result<ExtractOutputFromTypes<TMembers>,SchemaError>
Defined in: packages/schema/src/types/base.ts:58
Parameters
Section titled “Parameters”Document | undefined
Returns
Section titled “Returns”Result<ExtractOutputFromTypes<TMembers>, SchemaError>
Inherited from
Section titled “Inherited from”parse_()
Section titled “parse_()”
protectedparse_(value,ctx):Result<ExtractOutputFromTypes<TMembers>,SchemaError>
Defined in: packages/schema/src/types/struct.ts:47
Parameters
Section titled “Parameters”Document | undefined
Returns
Section titled “Returns”Result<ExtractOutputFromTypes<TMembers>, SchemaError>
Inherited from
Section titled “Inherited from”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>