workflow.md
February 26, 2024 ยท View on GitHub
workflow package
Classes
| Class | Description |
|---|---|
| BaseNode | |
| Codebook | |
| CodebookProfile | |
| DataPackage | |
| DataShape | |
| DataTable | |
| DataTableProfile | |
| DefaultGraph | |
| Named | |
| ObservableNode | |
| Observed | |
| ParserOptions | |
| Resource | |
| ResourceReference | |
| StepNode | |
| TableBundle | |
| TableBundleProfile | |
| UnknownResource | Represents an instance of an unknown resource type. This allows us to load and display arbitrary resources that have not been explicitly registered. |
| UnknownResourceProfile | |
| Workflow | |
| WorkflowProfile |
Enumerations
| Enumeration | Description |
|---|---|
| NodeInput | |
| NodeOutput |
Functions
| Function | Description |
|---|---|
| argsHasOutputColumn(args) | |
| cloneStep(step, columnNames) | |
| createNode(step) | |
| fetchFile(url) | |
| fetchJson(url) | |
| isDataTypeSupported(verb, type) | Indicates whether the specified data type is supported by the step. |
| isInputColumnListStep(verb) | Indicates whether the supplied step requires multiple input columns. |
| isInputColumnRecordStep(verb) | Indicates whether the supplied step requires a map of input columns. |
| isInputColumnStep(verb) | Indicates whether the supplied step requires a single input column. |
| isInputKeyValueStep(verb) | Indicates whether the supplied step requires an input key and value column. |
| isInputTableListStep(verb) | Indicates whether this step requires more than one input table. |
| isNoArgsStep(verb) | Indicates whether this step accepts arguments |
| isNumericInputStep(verb) | |
| isOutputColumnStep(verb) | Indicates whether the supplied step requires a single output column. |
| isReferenceSchema(entry) | |
| join(id) | |
| lookup(id) | |
| nextColumnName(name, columnNames) | Suggests a new column name given the list passed. If the name is used, this will append numbers to the end. e.g. "column" may result in "column 1" or "column 2" if there are collisions |
| observableNode(id, source) | |
| readStep({ verb, args, id, input }, previous) | Factory function to create new verb configs with as many reasonable defaults as possible. |
| stepNodeFactory(stepFunction) | |
| verbs(filter) | Returns all verbs, subject to optional filter. |
| workflow(id) |
Interfaces
| Interface | Description |
|---|---|
| Configurable | Implement this to signal that your resource is configurable. Implementors must supply their own management of the config object/observable. See the webapp's TestAppResource for an example. |
| Emitter | A data emitter for a type of output |
| Graph | |
| Node_2 | A graph processing node |
| NodeBinding | A binding for a value being emitted from a node |
| NodeStats | An interface for node statistics. |
| ProfileHandler | A custom profile handler |
| ProfileInitializationContext | |
| ResourceConstructor | A constructor for a resource |
| Step | Resolved step data, used in living workflows |
| StepApi | The API available to step functions. |
| StepInput | Step input data for parsing workflow schemas |
| TableExportOptions | Options for exporting data-tables within Workflow instances.w |
| Transformer_2 | A transformer for a type of I/O |
Variables
Type Aliases
| Type Alias | Description |
|---|---|
| CopyWithPartial | |
| Handler | Function callback for general activity listener. |
| HandlerOf | |
| Maybe | |
| NodeId | |
| Readable | |
| SocketName | |
| StepFunction | |
| TableEmitter | An emitter for TableContainers |
| TableObservable | The workflow object manages mutable data for a workflow specification |
| TableTransformer | |
| Unsubscribe | |
| VariadicNodeBinding |