workflow

Types

Backoff

pub type Backoff {
  Constant
  Linear
  Exponential
}

Constructors

```
Constant
```
```
Linear
```
```
Exponential
```

CreateOptions

</>

pub type CreateOptions {
  CreateOptions(id: option.Option(String), params: json.Json)
}

Constructors

CreateOptions(id: option.Option(String), params: json.Json)

Duration

</>

pub type Duration {
  Milliseconds(Int)
  Seconds(Int)
  Minutes(Int)
  Hours(Int)
  Days(Int)
  Weeks(Int)
  Months(Int)
  Years(Int)
}

Constructors

```
Milliseconds(Int)
```
```
Seconds(Int)
```
```
Minutes(Int)
```
```
Hours(Int)
```
```
Days(Int)
```
```
Weeks(Int)
```
```
Months(Int)
```
```
Years(Int)
```

Entrypoint

</>

pub type Entrypoint

InitialEvent

</>

pub type InitialEvent(t) {
  InitialEvent(
    payload: t,
    timestamp: String,
    instance_id: String,
  )
}

Constructors

InitialEvent(payload: t, timestamp: String, instance_id: String)

Instance

</>

pub type Instance

InstanceStatus

</>

pub type InstanceStatus {
  InstanceStatus(
    status: String,
    error: option.Option(String),
    output: dynamic.Dynamic,
  )
}

Constructors

InstanceStatus(
  status: String,
  error: option.Option(String),
  output: dynamic.Dynamic,
)

Retries

</>

pub type Retries {
  Retries(limit: Int, delay: Duration, backoff: Backoff)
}

Constructors

Retries(limit: Int, delay: Duration, backoff: Backoff)

SentEvent

</>

pub type SentEvent(t) {
  SentEvent(type_: String, payload: t, timestamp: String)
}

Constructors

SentEvent(type_: String, payload: t, timestamp: String)

Step

</>

pub type Step

StepConfig

</>

pub type StepConfig {
  StepConfig(
    retries: option.Option(Retries),
    timeout: option.Option(Duration),
  )
}

Constructors

StepConfig(
  retries: option.Option(Retries),
  timeout: option.Option(Duration),
)

Workflow

</>

pub type Workflow

Values

create

</>

pub fn create(
  workflow: Workflow,
  options: CreateOptions,
) -> promise.Promise(Instance)

create_batch

</>

pub fn create_batch(
  workflow: Workflow,
  options: List(CreateOptions),
) -> promise.Promise(array.Array(Instance))

default

</>

pub fn default() -> StepConfig

do

</>

pub fn do(
  step: Step,
  name: String,
  config: StepConfig,
  callback: fn() -> promise.Promise(json.Json),
) -> promise.Promise(dynamic.Dynamic)

get

</>

pub fn get(
  workflow: Workflow,
  id: String,
) -> promise.Promise(Result(Instance, String))

id

</>

pub fn id(instance: Instance) -> String

initial_event_decoder

</>

pub fn initial_event_decoder(
  payload_decoder: decode.Decoder(a),
) -> decode.Decoder(InitialEvent(a))

pause

</>

pub fn pause(instance: Instance) -> promise.Promise(Nil)

restart

</>

pub fn restart(instance: Instance) -> promise.Promise(Nil)

resume

</>

pub fn resume(instance: Instance) -> promise.Promise(Nil)

send_event

</>

pub fn send_event(
  instance: Instance,
  type_: String,
  payload: json.Json,
) -> promise.Promise(Nil)

sent_event_decoder

</>

pub fn sent_event_decoder(
  payload_decoder: decode.Decoder(a),
) -> decode.Decoder(SentEvent(a))

sleep

</>

pub fn sleep(
  step: Step,
  name: String,
  duration: Duration,
) -> promise.Promise(Nil)

sleep_until

</>

pub fn sleep_until(
  step: Step,
  name: String,
  until: Int,
) -> promise.Promise(Nil)

status

</>

pub fn status(
  instance: Instance,
) -> promise.Promise(InstanceStatus)

terminate

</>

pub fn terminate(instance: Instance) -> promise.Promise(Nil)

wait_for_event

</>

pub fn wait_for_event(
  step: Step,
  name: String,
  type_: String,
  timeout: option.Option(Duration),
) -> promise.Promise(Result(dynamic.Dynamic, String))

returns an error if it timed out