***
title: "Job"
generated: true
---------------
## Job
A Job represents a piece of work to be run in the background, i.e. outside the request-response cycle.
It is intended to be used for long-running work triggered by API requests. Jobs should now generally
be directly instantiated. Rather, the [JobQueue](/current/core/reference/typescript-api/job-queue/#jobqueue) `add()` method should be used to create and
add a new Job to a queue.
```ts title="Signature"
class Job = any> {
readonly id: number | string | null;
readonly queueName: string;
readonly retries: number;
readonly createdAt: Date;
name: string
data: T
state: JobState
progress: number
result: any
error: any
isSettled: boolean
startedAt: Date | undefined
settledAt: Date | undefined
duration: number
attempts: number
constructor(config: JobConfig)
start() => ;
setProgress(percent: number) => ;
complete(result?: any) => ;
fail(err?: any) => ;
cancel() => ;
defer() => ;
on(eventType: JobEventType, listener: JobEventListener) => ;
off(eventType: JobEventType, listener: JobEventListener) => ;
}
```
### id
\
### queueName
\
### retries
\
### createdAt
\
### name
\
### data
\
### state
\
JobState`} />
### progress
\
### result
\
### error
\
### isSettled
\
### startedAt
\
### settledAt
\
### duration
\
### attempts
\
### start
\ `} />
Calling this signifies that the job work has started. This method should be
called in the [JobQueueStrategy](/current/core/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy) `next()` method.
### setProgress
\ `} />
Sets the progress (0 - 100) of the job.
### complete
\ `} />
Calling this method signifies that the job succeeded. The result
will be stored in the `Job.result` property.
### fail
\ `} />
Calling this method signifies that the job failed.
### cancel
\ `} />
### defer
\ `} />
Sets a RUNNING job back to PENDING. Should be used when the JobQueue is being
destroyed before the job has been completed.
### on
\JobEventType, listener: JobEventListener) => `} />
Used to register event handler for job events
### off
\JobEventType, listener: JobEventListener) => `} />