Class JobManager

Coordinates queued job execution, persistence, and subscriber notification.

Constructors

constructor

new JobManager(options?: JobManagerOptions): JobManager
Constructs a new JobManager with the given options.
Parameters
- Optionaloptions: JobManagerOptions
  Configuration for concurrency, persistence, and hooks.
Returns JobManager
- Defined in src/core/jobs/JobManager.ts:152

Methods

abortJob

abortJob(id: string, reason?: string): void
Aborts a job by ID, removing it from the queue and signaling cancellation.
Parameters
- id: string
  The job identifier.
- Optionalreason: string
  Optional human-readable abort reason.
Returns void
Nothing.

Throws
Thrown when the job cannot be found.
- Defined in src/core/jobs/JobManager.ts:617

addJob

addJob<TInput, TOutput>(job: GenericJob<TInput, TOutput>): void
Adds a new job to the manager. Throws if the job ID already exists.
Type Parameters
- TInput
  Input type for the job.
- TOutput
  Output type for the job.
Parameters
- job: GenericJob<TInput, TOutput>
  The job to register.
Returns void
Nothing.

Throws
Thrown when a job with the same identifier already exists.
- Defined in src/core/jobs/JobManager.ts:424

getJob

getJob<TInput, TOutput>(id: string): GenericJob<TInput, TOutput> | undefined
Retrieves a job by its ID.
Type Parameters
- TInput
  Expected input type for the job.
- TOutput
  Expected output type for the job.
Parameters
- id: string
  The job identifier.
Returns GenericJob<TInput, TOutput> | undefined
The job instance, or undefined when no such job exists.
- Defined in src/core/jobs/JobManager.ts:444

getMaxConcurrency

getMaxConcurrency(): number | undefined
Gets the maximum number of jobs that can run concurrently.

Returns number | undefined
The configured concurrency limit, or undefined when unbounded.
- Defined in src/core/jobs/JobManager.ts:169

getMaxQueueSize

getMaxQueueSize(): number | undefined
Gets the maximum number of jobs allowed in the queue.

Returns number | undefined
The configured queue size limit.
- Defined in src/core/jobs/JobManager.ts:220

getMaxRawBytesPerJob

getMaxRawBytesPerJob(): number | undefined
Gets the maximum number of raw bytes to store per job.

Returns number | undefined
The raw-response byte budget for each job.
- Defined in src/core/jobs/JobManager.ts:295

getMaxStoredResponseChunks

getMaxStoredResponseChunks(): number | undefined
Gets the maximum number of response chunks stored per job.

Returns number | undefined
The configured chunk retention limit.
- Defined in src/core/jobs/JobManager.ts:193

getQueueLength

getQueueLength(): number
Gets the current number of jobs in the queue.

Returns number
The number of jobs currently waiting to run.
- Defined in src/core/jobs/JobManager.ts:319

getRunningCount

getRunningCount(): number
Gets the current number of jobs running.

Returns number
The number of jobs currently executing.
- Defined in src/core/jobs/JobManager.ts:328

getStoreRawResponses

getStoreRawResponses(): boolean | undefined
Gets whether raw responses are stored for jobs.

Returns boolean | undefined
Whether raw provider responses are retained.
- Defined in src/core/jobs/JobManager.ts:244

getStripBinaryPayloadsInSnapshotsAndTimeline

getStripBinaryPayloadsInSnapshotsAndTimeline(): boolean | undefined
Gets whether binary-heavy fields are stripped from snapshots and timeline artifacts.

Returns boolean | undefined
Whether binary-heavy data is stripped before persistence.
- Defined in src/core/jobs/JobManager.ts:268

listJobs

listJobs(): JobSnapshot<any, any>[]
Lists all jobs managed by this instance as snapshots.

Returns JobSnapshot<any, any>[]
Snapshots for every known job.
- Defined in src/core/jobs/JobManager.ts:645

rerunJob

rerunJob<TInput, TOutput>(
    id: string,
    ctx: MultiModalExecutionContext,
    onChunk?: (chunk: JobChunk<TOutput>) => void,
): GenericJob<TInput, TOutput>
Resets and reruns a job by ID. Throws if not found or already running.
Type Parameters
- TInput
  Expected input type for the job.
- TOutput
  Expected output type for the job.
Parameters
- id: string
  The job identifier.
- ctx: MultiModalExecutionContext
  The execution context passed to the job executor.
- OptionalonChunk: (chunk: JobChunk<TOutput>) => void
  Optional progress callback for streamed chunks.
Returns GenericJob<TInput, TOutput>
The reset and requeued job instance.

Throws
Thrown when the job is missing or currently running.
- Defined in src/core/jobs/JobManager.ts:502

runJob

runJob<TInput, TOutput>(
    id: string,
    ctx: MultiModalExecutionContext,
    onChunk?: (chunk: JobChunk<TOutput>) => void,
): GenericJob<TInput, TOutput>
Queues a job for execution. Throws if already running, queued, or not found.
Type Parameters
- TInput
  Expected input type for the job.
- TOutput
  Expected output type for the job.
Parameters
- id: string
  The job identifier.
- ctx: MultiModalExecutionContext
  The execution context passed to the job executor.
- OptionalonChunk: (chunk: JobChunk<TOutput>) => void
  Optional progress callback for streamed chunks.
Returns GenericJob<TInput, TOutput>
The queued job instance.

Throws
Thrown when execution is disabled, the queue is full, or the job is missing/already queued.
- Defined in src/core/jobs/JobManager.ts:459

setMaxConcurrency

setMaxConcurrency(maxConcurrency: number | undefined): void
Sets the maximum number of jobs that can run concurrently.
Parameters
- maxConcurrency: number | undefined
  The new concurrency limit.
Returns void
Nothing.

Throws
Thrown when the value is not a non-negative integer.
- Defined in src/core/jobs/JobManager.ts:180

setMaxQueueSize

setMaxQueueSize(maxQueueSize: number | undefined): void
Sets the maximum number of jobs allowed in the queue.
Parameters
- maxQueueSize: number | undefined
  The new queue size limit.
Returns void
Nothing.

Throws
Thrown when the value is not a non-negative integer.
- Defined in src/core/jobs/JobManager.ts:231

setMaxRawBytesPerJob

setMaxRawBytesPerJob(maxRawBytesPerJob: number | undefined): void
Sets the maximum number of raw bytes to store per job.
Parameters
- maxRawBytesPerJob: number | undefined
  The new raw-response byte limit.
Returns void
Nothing.

Throws
Thrown when the value is not a non-negative integer.
- Defined in src/core/jobs/JobManager.ts:306

setMaxStoredResponseChunks

setMaxStoredResponseChunks(maxStoredResponseChunks: number | undefined): void
Sets the maximum number of response chunks stored per job.
Parameters
- maxStoredResponseChunks: number | undefined
  The new chunk retention limit.
Returns void
Nothing.

Throws
Thrown when the value is not a non-negative integer.
- Defined in src/core/jobs/JobManager.ts:204

setStoreRawResponses

setStoreRawResponses(storeRawResponses: boolean | undefined): void
Sets whether raw responses are stored for jobs.
Parameters
- storeRawResponses: boolean | undefined
  Whether raw provider responses should be retained.
Returns void
Nothing.

Throws
Thrown when the value is not a boolean.
- Defined in src/core/jobs/JobManager.ts:255

setStripBinaryPayloadsInSnapshotsAndTimeline

setStripBinaryPayloadsInSnapshotsAndTimeline(
stripBinaryPayloadsInSnapshotsAndTimeline: boolean | undefined,
): void
Sets whether binary-heavy fields are stripped from snapshots and timeline artifacts.
Parameters
- stripBinaryPayloadsInSnapshotsAndTimeline: boolean | undefined
  Whether binary-heavy fields should be stripped.
Returns void
Nothing.

Throws
Thrown when the value is not a boolean.
- Defined in src/core/jobs/JobManager.ts:279

subscribe<TInput, TOutput>(
jobId: string,
subscriber: JobSubscriber<TInput, TOutput>,
): () => boolean | undefined
Subscribes to status updates for a specific job.
Type Parameters
- TInput
- TOutput
Parameters
- jobId: string
  The job ID
- subscriber: JobSubscriber<TInput, TOutput>
  The callback to invoke on updates
Returns () => boolean | undefined
Unsubscribe function
- Defined in src/core/jobs/JobManager.ts:698

Class JobManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns JobManager

Methods

abortJob

Parameters

Returns void

Throws

addJob

Type Parameters

Parameters

Returns void

Throws

getJob

Type Parameters

Parameters

Returns GenericJob<TInput, TOutput> | undefined

getMaxConcurrency

Returns number | undefined

getMaxQueueSize

Returns number | undefined

getMaxRawBytesPerJob

Returns number | undefined

getMaxStoredResponseChunks

Returns number | undefined

getQueueLength

Returns number

getRunningCount

Returns number

getStoreRawResponses

Returns boolean | undefined

getStripBinaryPayloadsInSnapshotsAndTimeline

Returns boolean | undefined

listJobs

Returns JobSnapshot<any, any>[]

rerunJob

Type Parameters

Parameters

Returns GenericJob<TInput, TOutput>

Throws

runJob

Type Parameters

Parameters

Returns GenericJob<TInput, TOutput>

Throws

setMaxConcurrency

Parameters

Returns void

Throws

setMaxQueueSize

Parameters

Returns void

Throws

setMaxRawBytesPerJob

Parameters

Returns void

Throws

setMaxStoredResponseChunks

Parameters

Returns void

Throws

setStoreRawResponses

Parameters

Returns void

Throws

setStripBinaryPayloadsInSnapshotsAndTimeline

Parameters

Returns void

Throws

subscribe

Type Parameters

Parameters

Returns () => boolean | undefined

Settings

On This Page