Class: ServiceOptions
Represents a ServiceOptions.
Properties
name
name:
string
Nexus service name (defaults to proto service full name).
tags
tags:
string[]
Tags to attach to the service. Used by code generators to include and exclude services.
Methods
toJSON()
toJSON():
object
Converts this ServiceOptions to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):ServiceOptions&$Properties
Creates a new ServiceOptions instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ServiceOptions & $Properties
ServiceOptions instance
Call Signature
staticcreate(properties?):ServiceOptions
Creates a new ServiceOptions instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ServiceOptions
ServiceOptions instance
decode()
staticdecode(reader,length?):ServiceOptions&$Properties
Decodes a ServiceOptions message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
ServiceOptions & $Properties
ServiceOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):ServiceOptions&$Properties
Decodes a ServiceOptions message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
ServiceOptions & $Properties
ServiceOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified ServiceOptions message. Does not implicitly nexusannotations.v1.ServiceOptions.verify|verify messages.
Parameters
message
ServiceOptions message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified ServiceOptions message, length delimited. Does not implicitly nexusannotations.v1.ServiceOptions.verify|verify messages.
Parameters
message
ServiceOptions message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):ServiceOptions
Creates a ServiceOptions message from a plain object. Also converts values to their respective internal types.
Parameters
object
{[k: string]: any; }
Plain object
Returns
ServiceOptions
ServiceOptions
toObject()
statictoObject(message,options?):object
Creates a plain object from a ServiceOptions message. Also converts values to other types if specified.
Parameters
message
ServiceOptions
ServiceOptions
options?
IConversionOptions
Conversion options
Returns
object
Plain object