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