@pdfking/taskmaker

Types

types

TaskOptions

type TaskOptions = EnumType<
  WireEnum.TASK,
  {
    // set when the run asked to drop this task's cached response and re-run
    cache_evict?: boolean
    guid: StringGUID
    value: { name: string; data: Struct }
  }
>

WireInput

type WireInput = EnumType<WireEnum.INPUT, { value: unknown }>

WireOutput

type WireOutput = EnumType<WireEnum.OUTPUT, { value: unknown }>

WireTracking

type WireTracking = EnumType<WireEnum.TRACKING, { value: TrackingMessage }>

WireRequest

type WireRequest = TaskOptions | WireInput

WireResponse

type WireResponse = WireOutput | WireTracking

EngineOptions

type EngineOptions = {
  cache?: CacheBackend<WireResponse[]>
  tracking?: TrackingCallback
}

ExecutionContext

type ExecutionContext = {
  cache_evict?: boolean
}

WorkerEngineOptions

type WorkerEngineOptions = {
  worker: string | URL
  workers?: number
} & EngineOptions

TaskEngineOptions

type TaskEngineOptions = {
  worker?: string | URL
  workers?: number
} & EngineOptions

TaskModule

type TaskModule<TM extends TaskMap> = {
  Tasks: TaskImplementations<TM, ExecutionContext>
  TasksDescriptor: TaskDescriptor
}