Class: Memo
A user-defined set of unindexed fields that are exposed when listing/searching workflows
Implements
Constructors
constructor
• new Memo(properties?): Memo
Constructs a new Memo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMemo | Properties to set |
Returns
Properties
fields
• fields: Object
Memo fields.
Index signature
▪ [k: string]: IPayload
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Memo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Memo
Creates a new Memo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMemo | Properties to set |
Returns
Memo instance
decode
▸ decode(reader, length?): Memo
Decodes a Memo 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
Memo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Memo
Decodes a Memo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Memo
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 Memo message. Does not implicitly temporal.api.common.v1.Memo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMemo | Memo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Memo message, length delimited. Does not implicitly temporal.api.common.v1.Memo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMemo | Memo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Memo
Creates a Memo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Memo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Memo
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 Memo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Memo | Memo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object