DocumentRecordType
Defined in: packages/schema/src/types/record.ts:85
Extends
Section titled “Extends”RecordType<Document,Node,TItemOut,TValue>
Type Parameters
Section titled “Type Parameters”TItemOut
Section titled “TItemOut”TItemOut
TValue
Section titled “TValue”TValue extends Type<Node, TItemOut>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DocumentRecordType<
TItemOut,TValue>(__namedParameters):DocumentRecordType<TItemOut,TValue>
Defined in: packages/schema/src/types/record.ts:30
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”RecordTypeParams<Node, TItemOut, TValue>
Returns
Section titled “Returns”DocumentRecordType<TItemOut, TValue>
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_:Map
Defined in: packages/schema/src/types/base.ts:35
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”prefix
Section titled “prefix”Get Signature
Section titled “Get Signature”get prefix():
string|undefined
Defined in: packages/schema/src/types/record.ts:44
Returns
Section titled “Returns”string | undefined
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get value():
TValue
Defined in: packages/schema/src/types/record.ts:40
Returns
Section titled “Returns”TValue
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”getItems()
Section titled “getItems()”
protectedgetItems(value): [string,Node][]
Defined in: packages/schema/src/types/record.ts:89
Parameters
Section titled “Parameters”Document
Returns
Section titled “Returns”[string, Node][]
Overrides
Section titled “Overrides”parse()
Section titled “parse()”parse(
value,ctx):Result<Map<string,TItemOut>,SchemaError>
Defined in: packages/schema/src/types/base.ts:58
Parameters
Section titled “Parameters”Document | undefined
Returns
Section titled “Returns”Result<Map<string, TItemOut>, SchemaError>
Inherited from
Section titled “Inherited from”parse_()
Section titled “parse_()”
protectedparse_(value,ctx):Result<Map<string,TItemOut>,SchemaError>
Defined in: packages/schema/src/types/record.ts:48
Parameters
Section titled “Parameters”Document | undefined
Returns
Section titled “Returns”Result<Map<string, TItemOut>, 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”Map
Returns
Section titled “Returns”Result<void, string>