View Source Tarearbol.Scheduler.Job (tarearbol v1.12.0)

A struct holding the job description. Used internally by Tarearbol.Scheduler to preserve a list of scheduled jobs.

Summary

Types

t()

The struct containing the information about the job

Types

@type t() :: %Tarearbol.Scheduler.Job{
  name: binary(),
  runner: Tarearbol.Scheduler.runner(),
  schedule: Tarearbol.Scheduler.repeated_schedule(),
  once?: boolean()
}

The struct containing the information about the job

Functions

Link to this function

create(name, runner, schedule)

View Source
@spec create(
  name :: binary(),
  runner :: Tarearbol.Scheduler.runner(),
  schedule ::
    Tarearbol.Scheduler.repeated_schedule()
    | Tarearbol.Scheduler.once_schedule()
) :: t()

Produces a Tarearbol.Scheduler.Job by parameters given