Skip to main content

Class: BytesValue

google.protobuf.BytesValue

Represents a BytesValue.

Implements

Constructors

constructor

new BytesValue(properties?)

Constructs a new BytesValue.

Parameters

NameTypeDescription
properties?IBytesValueProperties to set

Properties

value

value: Uint8Array

BytesValue value.

Implementation of

IBytesValue.value

Methods

toJSON

toJSON(): Object

Converts this BytesValue to JSON.

Returns

Object

JSON object


create

Static create(properties?): BytesValue

Creates a new BytesValue instance using the specified properties.

Parameters

NameTypeDescription
properties?IBytesValueProperties to set

Returns

BytesValue

BytesValue instance


decode

Static decode(reader, length?): BytesValue

Decodes a BytesValue message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

BytesValue

BytesValue


decodeDelimited

Static decodeDelimited(reader): BytesValue

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

BytesValue

BytesValue


encode

Static encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): BytesValue

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

BytesValue

BytesValue


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for BytesValue

Parameters

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

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageBytesValueBytesValue
options?IConversionOptionsConversion options

Returns

Object

Plain object