Skip to main content

Class: BoolValue

google.protobuf.BoolValue

Represents a BoolValue.

Implements

Constructors

constructor

new BoolValue(properties?): BoolValue

Constructs a new BoolValue.

Parameters

NameTypeDescription
properties?IBoolValueProperties to set

Returns

BoolValue

Properties

value

value: boolean

BoolValue value.

Implementation of

IBoolValue.value

Methods

toJSON

toJSON(): Object

Converts this BoolValue to JSON.

Returns

Object

JSON object


create

create(properties?): BoolValue

Creates a new BoolValue instance using the specified properties.

Parameters

NameTypeDescription
properties?IBoolValueProperties to set

Returns

BoolValue

BoolValue instance


decode

decode(reader, length?): BoolValue

Decodes a BoolValue message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

BoolValue

BoolValue

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): BoolValue

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

BoolValue

BoolValue

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified BoolValue message. Does not implicitly google.protobuf.BoolValue.verify|verify messages.

Parameters

NameTypeDescription
messageIBoolValueBoolValue message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified BoolValue message, length delimited. Does not implicitly google.protobuf.BoolValue.verify|verify messages.

Parameters

NameTypeDescription
messageIBoolValueBoolValue message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): BoolValue

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

BoolValue

BoolValue


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for BoolValue

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageBoolValueBoolValue
options?IConversionOptionsConversion options

Returns

Object

Plain object