Class: FieldOptions
Represents a FieldOptions.
Implements
Constructors
constructor
• new FieldOptions(properties?): FieldOptions
Constructs a new FieldOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFieldOptions | Properties to set |
Returns
Properties
ctype
• ctype: CType
The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release -- sorry, we'll try to include other types in a future version!
Implementation of
debugRedact
• debugRedact: boolean
Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
Implementation of
deprecated
• deprecated: boolean
Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
Implementation of
editionDefaults
• editionDefaults: IEditionDefault[]
FieldOptions editionDefaults.
Implementation of
features
• Optional features: null | IFeatureSet
Any features defined in the specific edition.
Implementation of
jstype
• jstype: JSType
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent.
This option is an enum to permit additional types to be added, e.g. goog.math.Integer.
Implementation of
lazy
• lazy: boolean
Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.
This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it.
This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access.
Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outer message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either always check its required fields, or never check its required fields, regardless of whether or not the message has been parsed.
As of May 2022, lazy verifies the contents of the byte stream during parsing. An invalid byte stream will cause the overall parsing to fail.
Implementation of
packed
• packed: boolean
The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding.
Implementation of
retention
• retention: OptionRetention
FieldOptions retention.
Implementation of
targets
• targets: OptionTargetType[]
FieldOptions targets.
Implementation of
uninterpretedOption
• uninterpretedOption: IUninterpretedOption[]
The parser stores options it doesn't recognize here. See above.
Implementation of
IFieldOptions.uninterpretedOption
unverifiedLazy
• unverifiedLazy: boolean
unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
Implementation of
weak
• weak: boolean
For Google-internal migration only. Do not use.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this FieldOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): FieldOptions
Creates a new FieldOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFieldOptions | Properties to set |
Returns
FieldOptions instance
decode
▸ decode(reader, length?): FieldOptions
Decodes a FieldOptions message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
FieldOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): FieldOptions
Decodes a FieldOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
FieldOptions
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 FieldOptions message. Does not implicitly google.protobuf.FieldOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFieldOptions | FieldOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified FieldOptions message, length delimited. Does not implicitly google.protobuf.FieldOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFieldOptions | FieldOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): FieldOptions
Creates a FieldOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
FieldOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for FieldOptions
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a FieldOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | FieldOptions | FieldOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object