Class: Struct
Represents a Struct.
Implements
Constructors
constructor
• new Struct(properties?): Struct
Constructs a new Struct.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStruct | Properties to set |
Returns
Properties
fields
• fields: Object
Struct fields.
Index signature
▪ [k: string]: IValue
Implementation of
Methods
create
▸ create(properties?): Struct
Creates a new Struct instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStruct | Properties to set |
Returns
Struct instance
decode
▸ decode(reader, length?): Struct
Decodes a Struct 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
Struct
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Struct
Decodes a Struct message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Struct
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 Struct message. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStruct | Struct message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Struct message, length delimited. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStruct | Struct message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Struct
Creates a Struct message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Struct
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Struct
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toJSON
▸ toJSON(): Object
Converts this Struct to JSON.
Returns
Object
JSON object
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Struct message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Struct | Struct |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object
verify
▸ verify(message): string
Verifies a Struct message.
Parameters
| Name | Type | Description |
|---|---|---|
message | Object | Plain object to verify |
Returns
string
null if valid, otherwise the reason why it is not