Class: WorkflowType
Represents the identifier used by a workflow author to define the workflow. Typically, the name of a function. This is sometimes referred to as the workflow's "name"
Properties
name
• name: string
WorkflowType name.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowType to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowType & $Properties
Creates a new WorkflowType instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowType instance
▸ create(properties?): WorkflowType
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowType & $Properties
Decodes a WorkflowType 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
WorkflowType
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowType & $Properties
Decodes a WorkflowType message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowType
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 WorkflowType message. Does not implicitly temporal.api.common.v1.WorkflowType.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowType message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowType message, length delimited. Does not implicitly temporal.api.common.v1.WorkflowType.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowType message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowType
Creates a WorkflowType message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowType
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowType message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowType | WorkflowType |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object