OptionalBuilder
Defined in: packages/schema/src/builders/optional.ts:10
Extends
Section titled “Extends”Builder<Value,TOut|undefined,OptionalType<TOut,TWrapped>>
Type Parameters
Section titled “Type Parameters”TOut
TWrapped
Section titled “TWrapped”TWrapped extends Type<Value, TOut> & IExpressionValueType<TOut>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OptionalBuilder<
TOut,TWrapped>(wrapped_):OptionalBuilder<TOut,TWrapped>
Defined in: packages/schema/src/builders/optional.ts:14
Parameters
Section titled “Parameters”wrapped_
Section titled “wrapped_”TWrapped
Returns
Section titled “Returns”OptionalBuilder<TOut, TWrapped>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:Value
Defined in: packages/schema/src/builders/base.ts:9
Inherited from
Section titled “Inherited from”output_
Section titled “output_”
readonlyoutput_:TOut|undefined
Defined in: packages/schema/src/builders/base.ts:10
Inherited from
Section titled “Inherited from”
readonlytype_:OptionalType
Defined in: packages/schema/src/builders/base.ts:11
Inherited from
Section titled “Inherited from”validators_
Section titled “validators_”
protectedvalidators_:Validator<TOut|undefined>[]
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():
OptionalTypeParams<TOut,TWrapped>
Defined in: packages/schema/src/builders/optional.ts:18
Returns
Section titled “Returns”OptionalTypeParams<TOut, TWrapped>
Overrides
Section titled “Overrides”Methods
Section titled “Methods”build()
Section titled “build()”build():
OptionalType<TOut,TWrapped>
Defined in: packages/schema/src/builders/optional.ts:31
Returns
Section titled “Returns”OptionalType<TOut, TWrapped>
Overrides
Section titled “Overrides”clone()
Section titled “clone()”clone():
this
Defined in: packages/schema/src/builders/optional.ts:25
Returns
Section titled “Returns”this
Overrides
Section titled “Overrides”oneOf()
Section titled “oneOf()”oneOf(
values,equal?):OptionalBuilder<TOut,TWrapped>
Defined in: packages/schema/src/builders/base.ts:42
Parameters
Section titled “Parameters”values
Section titled “values”(TOut | undefined)[]
equal?
Section titled “equal?”(value, other) => boolean
Returns
Section titled “Returns”OptionalBuilder<TOut, 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<TOut | undefined>
message?
Section titled “message?”string
Returns
Section titled “Returns”this