Skip to main content

Class: Empty

google.protobuf.Empty

Represents an Empty.

Implements

Constructors

constructor

new Empty(properties?)

Constructs a new Empty.

Parameters

NameTypeDescription
properties?IEmptyProperties to set

Methods

toJSON

toJSON(): Object

Converts this Empty to JSON.

Returns

Object

JSON object


create

Static create(properties?): Empty

Creates a new Empty instance using the specified properties.

Parameters

NameTypeDescription
properties?IEmptyProperties to set

Returns

Empty

Empty instance


decode

Static decode(reader, length?): Empty

Decodes an Empty 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

Empty

Empty


decodeDelimited

Static decodeDelimited(reader): Empty

Decodes an Empty 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

Empty

Empty


encode

Static encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): Empty

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Empty

Empty


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Empty

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 an Empty message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageEmptyEmpty
options?IConversionOptionsConversion options

Returns

Object

Plain object