Class FlowGraphThrottleBlock
Hierarchy
- FlowGraphExecutionBlockWithOutSignal
- FlowGraphThrottleBlock
Constructors
constructor
-
Parameters
Optionalconfig: IFlowGraphBlockConfiguration
Returns FlowGraphThrottleBlock
Properties
Optionalconfig
the configuration of the block
data
The data inputs of the block.
data
The data outputs of the block.
Readonlyduration
Input connection: The duration of the throttle, in seconds.
Readonlyerror
An output connection that can be used to signal an error, if the block defines it.
Readonlyin
Input connection: The input signal of the block.
Readonlylast
Output connection: The time remaining before the throttle is triggering again, in seconds.
metadata
Metadata that can be used by the block.
name
The name of the block.
Readonlyout
Output connection: The signal that is synchronous triggered when the execution of this block is done.
Note that is case of events or async you might want to use the done signal instead.
Readonlypriority
The priority of the block. Higher priority blocks will be executed first. Note that priority cannot be change AFTER the block was added as sorting happens when the block is added to the execution queue.
Readonlyreset
Input connection: Resets the throttle.
signal
Input connections that activate the block.
signal
Output connections that can activate downstream blocks.
unique
A randomly generated GUID for each block.
Methods
deserialize
-
Deserializes from an object
Parameters
- serializationObject: any
the object to deserialize from
Returns void
- serializationObject: any
get
-
Returns string
class name of the block.
get
-
Given the name of a data input, returns the connection if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
Given the name of a data output, returns the connection if it exists
Parameters
- name: string
the name of the output
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
Given a name of a signal input, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
get
-
Given a name of a signal output, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
register
-
registerDataInput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data input on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
register
-
registerDataOutput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data output on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
serialize
-
Serializes this block
Parameters
- serializationObject: any = {}
the object to serialize in
Returns void
- serializationObject: any = {}
A block that throttles the execution of its output flow.