TamsFlowMetadata interface
Client-supplied identity and metadata for a pushed flow. Anything omitted is left to the engine, so this can be as little as a label.
Signature:
export interface TamsFlowMetadata
Properties
| Property | Type | Description |
|---|---|---|
string |
(Optional) Recorded as both |
|
string |
(Optional) |
|
string |
(Optional) Register under this flow id rather than a generated one. Must be a uuid. A flow’s essence parameters are fixed for its lifetime and can change between runs, so reusing an id across runs is a decision only you can make; omitting this gets a fresh flow each time, which is usually right. |
|
string |
(Optional) Human-readable name. Defaults to |
|
string |
(Optional) The source this flow is one encoding of. Must be a uuid. Omitting it means a fresh source per run, so successive runs of the same push look like unrelated programmes in the store. Supply a stable value to have them collect under one source. |
|
Record<string, string> |
(Optional) |