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