OptionalType
Defined in: packages/schema/src/types/optional.ts:14
Extends
Section titled “Extends”ExpressionValueType<TOut|undefined>
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 OptionalType<
TOut,TWrapped>(__namedParameters):OptionalType<TOut,TWrapped>
Defined in: packages/schema/src/types/optional.ts:20
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”OptionalTypeParams<TOut, TWrapped>
Returns
Section titled “Returns”OptionalType<TOut, TWrapped>
Overrides
Section titled “Overrides”ExpressionValueType<TOut | undefined>.constructor
Properties
Section titled “Properties”input_
Section titled “input_”
readonlyinput_:Value
Defined in: packages/schema/src/types/base.ts:34
Inherited from
Section titled “Inherited from”ExpressionValueType.input_
output_
Section titled “output_”
readonlyoutput_:TOut|undefined
Defined in: packages/schema/src/types/base.ts:35
Inherited from
Section titled “Inherited from”ExpressionValueType.output_
Accessors
Section titled “Accessors”wrapped
Section titled “wrapped”Get Signature
Section titled “Get Signature”get wrapped():
TWrapped
Defined in: packages/schema/src/types/optional.ts:25
Returns
Section titled “Returns”TWrapped
Methods
Section titled “Methods”cast()
Section titled “cast()”cast(
value):TOut|undefined
Defined in: packages/schema/src/types/expression.ts:43
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”TOut | undefined
Inherited from
Section titled “Inherited from”ExpressionValueType.cast
cast_()
Section titled “cast_()”
protectedcast_(value):TOut|undefined
Defined in: packages/schema/src/types/optional.ts:29
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”TOut | undefined
Overrides
Section titled “Overrides”ExpressionValueType.cast_
parse()
Section titled “parse()”parse(
value,ctx):Result<TOut|undefined,SchemaError>
Defined in: packages/schema/src/types/base.ts:58
Parameters
Section titled “Parameters”Value | undefined
Returns
Section titled “Returns”Result<TOut | undefined, SchemaError>
Inherited from
Section titled “Inherited from”ExpressionValueType.parse
parse_()
Section titled “parse_()”
protectedparse_(value):Result<TOut|undefined,SchemaError>
Defined in: packages/schema/src/types/expression.ts:31
Parameters
Section titled “Parameters”Value | undefined
Returns
Section titled “Returns”Result<TOut | undefined, SchemaError>
Inherited from
Section titled “Inherited from”ExpressionValueType.parse_
validate_()
Section titled “validate_()”
protectedvalidate_(value):Result<void,string>
Defined in: packages/schema/src/types/base.ts:48
Parameters
Section titled “Parameters”TOut | undefined
Returns
Section titled “Returns”Result<void, string>
Inherited from
Section titled “Inherited from”ExpressionValueType.validate_