@proto-kit/protocol • Docs
Documentation / @proto-kit/protocol / Option
Class: Option<Value>
Option facilitating in-circuit values that may or may not exist.
Extends
Type Parameters
• Value
Constructors
new Option()
new Option<
Value>(isSome,value,valueType,isForcedSome):Option<Value>
Parameters
• isSome: Bool
• value: Value
• valueType: FlexibleProvablePure<Value>
• isForcedSome: Bool = ...
Returns
Option<Value>
Overrides
Defined in
packages/protocol/src/model/Option.ts:122
Properties
isForcedSome
isForcedSome:
Bool
Inherited from
Defined in
packages/protocol/src/model/Option.ts:24
isSome
isSome:
Bool
Inherited from
Defined in
packages/protocol/src/model/Option.ts:23
value
value:
Value
Defined in
packages/protocol/src/model/Option.ts:124
valueType
valueType:
FlexibleProvablePure<Value>
Defined in
packages/protocol/src/model/Option.ts:125
Accessors
treeValue
Get Signature
get treeValue():
Field
Returns
Field
Tree representation of the current value
Inherited from
Defined in
packages/protocol/src/model/Option.ts:34
Methods
clone()
clone():
Option<Value>
Returns
Option<Value>
Overrides
Defined in
packages/protocol/src/model/Option.ts:135
encodeValueToFields()
encodeValueToFields():
Field[]
Returns
Field[]
Overrides
OptionBase.encodeValueToFields
Defined in
packages/protocol/src/model/Option.ts:131
forceSome()
forceSome():
void
Returns
void
Inherited from
Defined in
packages/protocol/src/model/Option.ts:44
orElse()
orElse(
defaultValue):Value
Parameters
• defaultValue: Value
Returns
Value
Returns the value of this option if it isSome, otherwise returns the given defaultValue
Defined in
packages/protocol/src/model/Option.ts:148
toConstant()
toConstant():
Option<Value>
Returns
Option<Value>
Defined in
packages/protocol/src/model/Option.ts:157
toFields()
toFields():
Field[]
Returns the to-value as decoded as a list of fields
Not in circuit
Returns
Field[]
Inherited from
Defined in
packages/protocol/src/model/Option.ts:53
toJSON()
toJSON():
object
Returns
object
isForcedSome
isForcedSome:
boolean
isSome
isSome:
boolean
value
value:
string[]
Inherited from
Defined in
packages/protocol/src/model/Option.ts:70
toProvable()
toProvable():
ProvableOption
Returns
Provable representation of the current option.
Inherited from
Defined in
packages/protocol/src/model/Option.ts:63
from()
staticfrom<Value>(isSome,value,valueType):Option<Value>
Creates a new Option from the provided parameters
Type Parameters
• Value
Parameters
• isSome: Bool
• value: Value
• valueType: FlexibleProvablePure<Value>
Returns
Option<Value>
New option from the provided parameters.
Defined in
packages/protocol/src/model/Option.ts:93
fromValue()
staticfromValue<Value>(value,valueType):Option<Value>
Creates a new Option from the provided parameters
Type Parameters
• Value
Parameters
• value: Value
• valueType: FlexibleProvablePure<Value>
Returns
Option<Value>
New option from the provided parameters.
Defined in
packages/protocol/src/model/Option.ts:108
none()
staticnone():Option<Field>
Returns
Option<Field>
Empty / none option