secretary library

Classes

ErrorEvent<K, T>

ExecutionParams<K, T>

Parameters passed to RecurringValidator and TaskBuilder functions. These represent the state of a RecurringTask at the time of execution.

FailureEvent<K, T>

InvalidValueError<T>

RecurringTask<K, T>

RecurringTaskFinishedEvent<K, T>

RecurringTaskState<K, T>

RecurringValidators

A collection of common RecurringValidator generators.

Result<T, E>

An object that can contain either a successful result (of type T), or an error (of type E). Use the Result.ok and Result.error constructors to create these.

RetryEvent<K, T>

RetryIf

A collection of common RetryTest generators.

Secretary<K, T>

A task manager.

SecretaryError

SecretaryEvent<K, T>

SecretaryState<K, T>

SecretaryTask<K, T>

SuccessEvent<K, T>

TaskBuilders

A collection of common TaskBuilder generators.

TaskNotFoundError<K>

TaskOverrides<T>

A collection of optional parameters that can be used to override the base values in the parent Secretary when creating tasks.

TaskState<K, T>

Validators

A collection of coommon Validator generators.

Enums

QueuePolicy

Dictates what to do with a task that needs to be queued, such as a retried task, i.e. should it return to the back of the queue or be retried immediately?

RecurringTaskStatus

SecretaryStatus

StopPolicy

Dictates what the Secretary will wait for when stop() or dispose() are called.

Typedefs

Callback<T> = void Function(T e)

RecurringValidator<K, T> = bool Function(ExecutionParams<K, T> params)

RetryTest = bool Function(Object?)

Task<T> = Future<T> Function()

TaskBuilder<K, T> = Task<T> Function(ExecutionParams<K, T> params)

Validator<T> = Object? Function(T e)

VoidCallback = void Function()