DocumentArrayBuilder
Defined in: packages/schema/src/builders/array.ts:63
Extends
Section titled “Extends”ArrayBuilder<Document,Node,TItemOut,TWrapped,DocumentArrayType<TItemOut,TWrapped>>
Type Parameters
Section titled “Type Parameters”TItemOut
Section titled “TItemOut”TItemOut
TWrapped
Section titled “TWrapped”TWrapped extends Type<Node, TItemOut>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DocumentArrayBuilder<
TItemOut,TWrapped>(wrapped_):DocumentArrayBuilder<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:21
Parameters
Section titled “Parameters”wrapped_
Section titled “wrapped_”TWrapped
Returns
Section titled “Returns”DocumentArrayBuilder<TItemOut, TWrapped>
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_:TItemOut[]
Defined in: packages/schema/src/builders/base.ts:10
Inherited from
Section titled “Inherited from”
readonlytype_:DocumentArrayType
Defined in: packages/schema/src/builders/base.ts:11
Inherited from
Section titled “Inherited from”validators_
Section titled “validators_”
protectedvalidators_:Validator<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():
ArrayTypeParams<TItemIn,TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:25
Returns
Section titled “Returns”ArrayTypeParams<TItemIn, TItemOut, TWrapped>
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”build()
Section titled “build()”build():
DocumentArrayType<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:73
Returns
Section titled “Returns”DocumentArrayType<TItemOut, TWrapped>
Overrides
Section titled “Overrides”clone()
Section titled “clone()”clone():
this
Defined in: packages/schema/src/builders/array.ts:32
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”every()
Section titled “every()”every(
predicate):DocumentArrayBuilder<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:38
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, index, array) => boolean
Returns
Section titled “Returns”DocumentArrayBuilder<TItemOut, TWrapped>
Inherited from
Section titled “Inherited from”length()
Section titled “length()”length(
length):DocumentArrayBuilder<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:50
Parameters
Section titled “Parameters”length
Section titled “length”number
Returns
Section titled “Returns”DocumentArrayBuilder<TItemOut, TWrapped>
Inherited from
Section titled “Inherited from”max(
max):DocumentArrayBuilder<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:54
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”DocumentArrayBuilder<TItemOut, TWrapped>
Inherited from
Section titled “Inherited from”min(
min):DocumentArrayBuilder<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:58
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”DocumentArrayBuilder<TItemOut, TWrapped>
Inherited from
Section titled “Inherited from”oneOf()
Section titled “oneOf()”oneOf(
values,equal?):DocumentArrayBuilder<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/base.ts:42
Parameters
Section titled “Parameters”values
Section titled “values”TItemOut[][]
equal?
Section titled “equal?”(value, other) => boolean
Returns
Section titled “Returns”DocumentArrayBuilder<TItemOut, TWrapped>
Inherited from
Section titled “Inherited from”some()
Section titled “some()”some(
predicate):DocumentArrayBuilder<TItemOut,TWrapped>
Defined in: packages/schema/src/builders/array.ts:44
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, index, array) => boolean
Returns
Section titled “Returns”DocumentArrayBuilder<TItemOut, TWrapped>
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<TItemOut[]>
message?
Section titled “message?”string
Returns
Section titled “Returns”this