README
¶
sleep Task
Description
The sleep task is designed to introduce a pause or delay in the execution flow for a specified duration. This task is useful in scenarios where a time-based delay is necessary between operations, such as waiting for certain conditions to be met or simulating real-time interactions.
Configuration Parameters
duration:
The length of time for which the task should pause execution. The duration is specified in a time format (e.g., '5s' for five seconds, '1m' for one minute). A duration of '0s' means no delay.
Defaults
Default settings for the sleep task:
- name: sleep
config:
duration: 0s
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( TaskName = "sleep" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Sleeps for a specified duration.", Category: "utility", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{}, NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
Duration helper.Duration `yaml:"duration" json:"duration" require:"A" desc:"Duration to sleep (e.g., '10s', '5m', '1h')."`
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
func (*Task) LoadConfig ¶
Source Files
Click to show internal directories.
Click to hide internal directories.