DocumentRecordBuilder
Defined in: packages/schema/src/builders/record.ts:48
Extends
Section titled “Extends”RecordBuilder<Document,Node,TItemOut,TValue,DocumentRecordType<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 DocumentRecordBuilder<
TItemOut,TValue>(value_):DocumentRecordBuilder<TItemOut,TValue>
Defined in: packages/schema/src/builders/record.ts:23
Parameters
Section titled “Parameters”value_
Section titled “value_”TValue
Returns
Section titled “Returns”DocumentRecordBuilder<TItemOut, TValue>
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_:Map
Defined in: packages/schema/src/builders/base.ts:10
Inherited from
Section titled “Inherited from”
readonlytype_:DocumentRecordType
Defined in: packages/schema/src/builders/base.ts:11
Inherited from
Section titled “Inherited from”validators_
Section titled “validators_”
protectedvalidators_:Validator<Map<string,TItemOut>>[]
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():
RecordTypeParams<TItemIn,TItemOut,TValue>
Defined in: packages/schema/src/builders/record.ts:27
Returns
Section titled “Returns”RecordTypeParams<TItemIn, TItemOut, TValue>
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”build()
Section titled “build()”build():
DocumentRecordType<TItemOut,TValue>
Defined in: packages/schema/src/builders/record.ts:58
Returns
Section titled “Returns”DocumentRecordType<TItemOut, TValue>
Overrides
Section titled “Overrides”clone()
Section titled “clone()”clone():
this
Defined in: packages/schema/src/builders/record.ts:35
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”oneOf()
Section titled “oneOf()”oneOf(
values,equal?):DocumentRecordBuilder<TItemOut,TValue>
Defined in: packages/schema/src/builders/base.ts:42
Parameters
Section titled “Parameters”values
Section titled “values”Map<string, TItemOut>[]
equal?
Section titled “equal?”(value, other) => boolean
Returns
Section titled “Returns”DocumentRecordBuilder<TItemOut, TValue>
Inherited from
Section titled “Inherited from”prefix()
Section titled “prefix()”prefix(
prefix):this
Defined in: packages/schema/src/builders/record.ts:41
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<Map<string, TItemOut>>
message?
Section titled “message?”string
Returns
Section titled “Returns”this