JSDoc
Classes
TaskboxError
classclass TaskboxError
Members
code
propertycode: "E_SCHEMA_INVALID" | "E_RUNTIME_UNAVAILABLE" | "E_IMAGE_PULL_FAILED" | "E_PROXY_INVALID" | "E_PROXY_CONNECT_FAILED" | "E_NETWORK_FAILED" | "E_TIMEOUT" | "E_OUTPUT_TOO_LARGE" | "E_TOOL_EXIT_NONZERO" | "E_ARTIFACT_MISSING" | "E_UNSUPPORTED_FORMAT"
category
propertycategory: "proxy" | "validation" | "runtime" | "image" | "network" | "timeout" | "resource" | "tool" | "artifact" | "unknown"
retryable
propertyretryable: boolean
details
propertydetails: Record<string, unknown>
stderrTail
propertystderrTail: string
suggestions
propertysuggestions: string[]
constructor
constructorconstructor(init: TaskboxErrorInit): TaskboxError
serialize
methodserialize(): TaskboxError$1
EventBus
classclass EventBus
Members
constructor
constructorconstructor(eventsJsonlPath: string): EventBus
emit
methodemit(event: unknown): void
on
methodon(cb: EventCallback): () => void
close
methodclose(): void
events
methodevents(): AsyncIterableIterator<TaskEvent>
[Symbol.asyncIterator]
method[Symbol.asyncIterator](): AsyncIterableIterator<TaskEvent>
Functions
createTaskbox
functioncreateTaskbox(config: TaskboxConfig): { prepare(): Promise<PrepareResult>; runTask(spec: unknown, opts?: { onEvent?: (e: TaskEvent) => void; }): Promise<TaskResult>; media: { downloadSubtitles(input: unknown, opts?: DownloadSubtitlesOptions): Promise<TaskResult>; }; }Interfaces
RuntimeAdapter
interfaceinterface RuntimeAdapter
Members
name
propertyname: string
available
methodavailable(): Promise<{ ok: boolean; details?: Record<string, unknown>; }>prepareImage
methodprepareImage(ref: string): Promise<{ digest?: string; }>runTask
methodrunTask(args: { spec: TaskSpec; workspace: Workspace; bus: EventBus; signal?: AbortSignal; }): Promise<{ exitCode: number; durationMs: number; rawResult?: unknown; }>TaskboxConfig
interfaceinterface TaskboxConfig
Members
runtime
propertyruntime: RuntimeAdapter
image
propertyimage: string
defaults
propertydefaults: { timeoutMs?: number; networkMode?: "none" | "direct" | "proxy"; defaultProxy?: ProxyConfig; }DownloadSubtitlesOptions
interfaceinterface DownloadSubtitlesOptions
Members
onEvent
propertyonEvent: (e: TaskEvent) => void
PrepareResult
interfaceinterface PrepareResult
Members
runtime
propertyruntime: string
image
propertyimage: { ref: string; digest?: string; }Constants
defaultImageRef
constconst defaultImageRef: "taskbox/kitchen-sink:0.1.0"
TaskboxErrorSchema
constconst TaskboxErrorSchema: z.ZodObject<{ code: z$1.ZodEnum<["E_SCHEMA_INVALID", "E_RUNTIME_UNAVAILABLE", "E_IMAGE_PULL_FAILED", "E_PROXY_INVALID", "E_PROXY_CONNECT_FAILED", "E_NETWORK_FAILED", "E_TIMEOUT", "E_OUTPUT_TOO_LARGE", "E_TOOL_EXIT_NONZERO", "E_ARTIFACT_MISSING", "E_UNSUPPORTED_FORMAT"]>; message: z$1.ZodString; retryable: z$1.ZodDefault<z$1.ZodBoolean>; category: z$1.ZodEnum<["validation", "runtime", "image", "network", "proxy", "timeout", "resource", "tool", "artifact", "unknown"]>; details: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodUnknown>>; stderrTail: z$1.ZodOptional<z$1.ZodString>; suggestions: z$1.ZodDefault<z$1.ZodArray<z$1.ZodString, "many">>; }, "strip", z.ZodTypeAny, { code: "E_SCHEMA_INVALID" | "E_RUNTIME_UNAVAILABLE" | "E_IMAGE_PULL_FAILED" | "E_PROXY_INVALID" | "E_PROXY_CONNECT_FAILED" | "E_NETWORK_FAILED" | "E_TIMEOUT" | "E_OUTPUT_TOO_LARGE" | "E_TOOL_EXIT_NONZERO" | "E_ARTIFACT_MISSING" | "E_UNSUPPORTED_FORMAT"; message: string; retryable: boolean; category: "validation" | "unknown" | "proxy" | "image" | "runtime" | "network" | "timeout" | "resource" | "tool" | "artifact"; suggestions: string[]; details?: Record<string, unknown> | undefined; stderrTail?: string | undefined; }, { code: "E_SCHEMA_INVALID" | "E_RUNTIME_UNAVAILABLE" | "E_IMAGE_PULL_FAILED" | "E_PROXY_INVALID" | "E_PROXY_CONNECT_FAILED" | "E_NETWORK_FAILED" | "E_TIMEOUT" | "E_OUTPUT_TOO_LARGE" | "E_TOOL_EXIT_NONZERO" | "E_ARTIFACT_MISSING" | "E_UNSUPPORTED_FORMAT"; message: string; category: "validation" | "unknown" | "proxy" | "image" | "runtime" | "network" | "timeout" | "resource" | "tool" | "artifact"; retryable?: boolean | undefined; details?: Record<string, unknown> | undefined; stderrTail?: string | undefined; suggestions?: string[] | undefined; }>