Class: CompanionCommitment

Defined in: WAProto/index.d.ts:9085

Represents a CompanionCommitment.

Implements

• ICompanionCommitment

Constructors

new CompanionCommitment()

new CompanionCommitment(properties?): CompanionCommitment

Defined in: WAProto/index.d.ts:9091

Constructs a new CompanionCommitment.

Parameters

properties?

ICompanionCommitment

Properties to set

Returns

CompanionCommitment

Properties

hash?

optional hash: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:9094

CompanionCommitment hash.

Implementation of

ICompanionCommitment.hash

Methods

toJSON()

toJSON(): object

Defined in: WAProto/index.d.ts:9164

Converts this CompanionCommitment to JSON.

Returns

object

JSON object

---

create()

static create(properties?): CompanionCommitment

Defined in: WAProto/index.d.ts:9101

Creates a new CompanionCommitment instance using the specified properties.

Parameters

properties?

ICompanionCommitment

Properties to set

Returns

CompanionCommitment

CompanionCommitment instance

---

decode()

static decode(reader, length?): CompanionCommitment

Defined in: WAProto/index.d.ts:9127

Decodes a CompanionCommitment message from the specified reader or buffer.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?

number

Message length if known beforehand

Returns

CompanionCommitment

CompanionCommitment

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): CompanionCommitment

Defined in: WAProto/index.d.ts:9136

Decodes a CompanionCommitment message from the specified reader or buffer, length delimited.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

CompanionCommitment

CompanionCommitment

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:9109

Encodes the specified CompanionCommitment message. Does not implicitly verify messages.

Parameters

message

ICompanionCommitment

CompanionCommitment message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:9117

Encodes the specified CompanionCommitment message, length delimited. Does not implicitly verify messages.

Parameters

message

ICompanionCommitment

CompanionCommitment message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): CompanionCommitment

Defined in: WAProto/index.d.ts:9150

Creates a CompanionCommitment message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

CompanionCommitment

CompanionCommitment

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:9171

Gets the default type url for CompanionCommitment

Parameters

typeUrlPrefix?

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject()

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:9158

Creates a plain object from a CompanionCommitment message. Also converts values to other types if specified.

Parameters

message

CompanionCommitment

CompanionCommitment

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

Defined in: WAProto/index.d.ts:9143

Verifies a CompanionCommitment message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not