@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / OptionBase

Class: abstract OptionBase

Extended by

• Option

Constructors

new OptionBase()

protected new OptionBase(isSome, isForcedSome): OptionBase

Parameters

• isSome: Bool

• isForcedSome: Bool

Returns

OptionBase

Defined in

packages/protocol/src/model/Option.ts:22

Properties

isForcedSome

isForcedSome: Bool

Defined in

packages/protocol/src/model/Option.ts:24

isSome

isSome: Bool

Defined in

packages/protocol/src/model/Option.ts:23

Accessors

treeValue

Get Signature

get treeValue(): Field

Returns

Field

Tree representation of the current value

Defined in

packages/protocol/src/model/Option.ts:34

Methods

clone()

abstract protected clone(): OptionBase

Returns

OptionBase

Defined in

packages/protocol/src/model/Option.ts:29

encodeValueToFields()

abstract protected encodeValueToFields(): Field[]

Returns

Field[]

Defined in

packages/protocol/src/model/Option.ts:27

forceSome()

forceSome(): void

Returns

void

Defined in

packages/protocol/src/model/Option.ts:44

toFields()

toFields(): Field[]

Returns the to-value as decoded as a list of fields Not in circuit

Returns

Field[]

Defined in

packages/protocol/src/model/Option.ts:53

toJSON()

toJSON(): object

Returns

object

isForcedSome

isForcedSome: boolean

isSome

isSome: boolean

value

value: string[]

Defined in

packages/protocol/src/model/Option.ts:70

toProvable()

toProvable(): ProvableOption

Returns

ProvableOption

Provable representation of the current option.

Defined in

packages/protocol/src/model/Option.ts:63