Skip to main content

Class: OneofOptions

google.protobuf.OneofOptions

Represents an OneofOptions.

Implements

Constructors

constructor

new OneofOptions(properties?): OneofOptions

Constructs a new OneofOptions.

Parameters

NameTypeDescription
properties?IOneofOptionsProperties to set

Returns

OneofOptions

Properties

uninterpretedOption

uninterpretedOption: IUninterpretedOption[]

OneofOptions uninterpretedOption.

Implementation of

IOneofOptions.uninterpretedOption

Methods

toJSON

toJSON(): Object

Converts this OneofOptions to JSON.

Returns

Object

JSON object


create

create(properties?): OneofOptions

Creates a new OneofOptions instance using the specified properties.

Parameters

NameTypeDescription
properties?IOneofOptionsProperties to set

Returns

OneofOptions

OneofOptions instance


decode

decode(reader, length?): OneofOptions

Decodes an OneofOptions message from the specified reader or buffer.

Parameters

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

Returns

OneofOptions

OneofOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): OneofOptions

Decodes an OneofOptions message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

OneofOptions

OneofOptions

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 OneofOptions message. Does not implicitly google.protobuf.OneofOptions.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): OneofOptions

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

OneofOptions

OneofOptions


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for OneofOptions

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

Parameters

NameTypeDescription
messageOneofOptionsOneofOptions
options?IConversionOptionsConversion options

Returns

Object

Plain object