Exqute v0.1.3 Exqute.Schedule.ScheduleOpts View Source

Schedule Options for the Scheduler

Link to this section Summary

Functions

Creates a new struct containing the options for the schedule

Link to this section Types

Link to this type

t()

View Source
t() :: %Exqute.Schedule.ScheduleOpts{
  enabled: boolean(),
  include_metadata: boolean()
}

Link to this section Functions

Link to this function

new(opts \\ %{})

View Source
new(map()) :: t()

Creates a new struct containing the options for the schedule

iex> Exqute.Schedule.ScheduleOpts.new(%{enabled: false, include_metadata: true})
%Exqute.Schedule.ScheduleOpts{enabled: false, include_metadata: true}
iex> Exqute.Schedule.ScheduleOpts.new(%{})
%Exqute.Schedule.ScheduleOpts{enabled: true, include_metadata: false}