Skip to main content

Class: DataBlob

common.v1.DataBlob

Represents a DataBlob.

Properties​

data​

• data: Uint8Array

DataBlob data.


encodingType​

• encodingType: EncodingType

DataBlob encodingType.

Methods​

toJSON​

▸ toJSON(): Object

Converts this DataBlob to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): DataBlob & $Properties

Creates a new DataBlob instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

DataBlob & $Properties

DataBlob instance

▸ create(properties?): DataBlob

Parameters​

NameType
properties?$Properties

Returns​

DataBlob


decode​

▸ decode(reader, length?): DataBlob & $Properties

Decodes a DataBlob message from the specified reader or buffer.

Parameters​

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

Returns​

DataBlob & $Properties

DataBlob

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): DataBlob & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

DataBlob & $Properties

DataBlob

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 DataBlob message. Does not implicitly temporal.api.common.v1.DataBlob.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesDataBlob message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified DataBlob message, length delimited. Does not implicitly temporal.api.common.v1.DataBlob.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesDataBlob message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): DataBlob

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

DataBlob

DataBlob


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageDataBlobDataBlob
options?IConversionOptionsConversion options

Returns​

Object

Plain object