Class Job

Hierarchy (View Summary)

ModelShape<JobsTable, this>
- Job

Constructors

constructor

new Job(
    attrs: {
        arguments: SuperJSONResult;
        className: string;
        concurrencyKey: null | string;
        createdAt: Date;
        finishedAt: null | string;
        id: number;
        priority: number;
        queueName: string;
        scheduledAt: Date;
        updatedAt: Date;
    },
): Job
Parameters
- attrs: {
      arguments: SuperJSONResult;
      className: string;
      concurrencyKey: null | string;
      createdAt: Date;
      finishedAt: null | string;
      id: number;
      priority: number;
      queueName: string;
      scheduledAt: Date;
      updatedAt: Date;
  }
Returns Job
Overrides model<Job, typeof tables.jobs>(tables.jobs).constructor
- Defined in packages/core/src/models/job.ts:36

Properties

`Static`table

table: "sideloop_jobs" = tables.jobs

Accessors

arguments

get arguments(): JobArguments
Returns JobArguments
- Defined in packages/core/src/models/job.ts:153

concurrencyController

get concurrencyController(): ConcurrencyController
Returns ConcurrencyController
- Defined in packages/core/src/models/job.ts:67

concurrencyDuration

get concurrencyDuration(): number
Returns number
- Defined in packages/core/src/models/job.ts:149

concurrencyLimit

get concurrencyLimit(): null | number
Returns null | number
- Defined in packages/core/src/models/job.ts:145

executor

get executor(): Executor
Returns Executor
- Defined in packages/core/src/models/job.ts:59

isConcurrencyLimited

get isConcurrencyLimited(): boolean
Returns boolean
- Defined in packages/core/src/models/job.ts:75

isDue

get isDue(): boolean
Returns boolean
- Defined in packages/core/src/models/job.ts:71

isFinished

get isFinished(): boolean
Returns boolean
- Defined in packages/core/src/models/job.ts:157

scheduler

get scheduler(): Scheduler
Returns Scheduler
- Defined in packages/core/src/models/job.ts:63

`Static`concurrencyController

get concurrencyController(): typeof ConcurrencyController
Returns typeof ConcurrencyController
- Defined in packages/core/src/models/job.ts:55

`Static`executor

get executor(): typeof Executor
Returns typeof Executor
- Defined in packages/core/src/models/job.ts:47

`Static`scheduler

get scheduler(): typeof Scheduler
Returns typeof Scheduler
- Defined in packages/core/src/models/job.ts:51

Methods

attr

attr<K extends NonNeverSelectKeys<JobsTable>>(
    name: K,
): {
    arguments: SuperJSONResult;
    className: string;
    concurrencyKey: null | string;
    createdAt: Date;
    finishedAt: null | string;
    id: number;
    priority: number;
    queueName: string;
    scheduledAt: Date;
    updatedAt: Date;
}[K]
Type Parameters
- K extends NonNeverSelectKeys<JobsTable>
Parameters
- name: K
Returns {
    arguments: SuperJSONResult;
    className: string;
    concurrencyKey: null | string;
    createdAt: Date;
    finishedAt: null | string;
    id: number;
    priority: number;
    queueName: string;
    scheduledAt: Date;
    updatedAt: Date;
}[K]
Inherited from ModelShape.attr
- Defined in packages/core/src/models/base.ts:35

attrs

attrs(): {
    arguments: SuperJSONResult;
    className: string;
    concurrencyKey: null
    | string;
    createdAt: Date;
    finishedAt: null | string;
    id: number;
    priority: number;
    queueName: string;
    scheduledAt: Date;
    updatedAt: Date;
}
Returns {
    arguments: SuperJSONResult;
    className: string;
    concurrencyKey: null | string;
    createdAt: Date;
    finishedAt: null | string;
    id: number;
    priority: number;
    queueName: string;
    scheduledAt: Date;
    updatedAt: Date;
}
Inherited from ModelShape.attrs
- Defined in packages/core/src/models/base.ts:34

destroy

destroy(): Promise<void>
Returns Promise<void>
Overrides ModelShape.destroy
- Defined in packages/core/src/models/job.ts:197

discard

discard(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/models/job.ts:193

failedWith

failedWith(error: unknown): Promise<FailedExecution>
Parameters
- error: unknown
Returns Promise<FailedExecution>
- Defined in packages/core/src/models/job.ts:181

finish

finish(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/models/job.ts:177

isBlocked

isBlocked(): Promise<null | BlockedExecution>
Returns Promise<null | BlockedExecution>
- Defined in packages/core/src/models/job.ts:173

isClaimed

isClaimed(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/core/src/models/job.ts:165

isFailed

isFailed(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/core/src/models/job.ts:169

isReady

isReady(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/core/src/models/job.ts:161

reload

reload(): Promise<Job>
Returns Promise<Job>
Inherited from ModelShape.reload
- Defined in packages/core/src/models/base.ts:39

resetExecutionCounters

resetExecutionCounters(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/models/job.ts:189

retry

retry(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/models/job.ts:185

transaction

transaction(
cb: (tx: Transaction<Database>) => Promise<unknown>,
): Promise<unknown>
Parameters
- cb: (tx: Transaction<Database>) => Promise<unknown>
Returns Promise<unknown>
Inherited from ModelShape.transaction
- Defined in packages/core/src/models/base.ts:36

update

update(
    attrs: {
        arguments?: string;
        className?: string;
        concurrencyKey?: null | string;
        createdAt?: Date;
        finishedAt?: null | string;
        id?: number;
        priority?: number;
        queueName?: string;
        scheduledAt?: string;
        updatedAt?: Date;
    },
): Promise<void>
Parameters
- attrs: {
      arguments?: string;
      className?: string;
      concurrencyKey?: null | string;
      createdAt?: Date;
      finishedAt?: null | string;
      id?: number;
      priority?: number;
      queueName?: string;
      scheduledAt?: string;
      updatedAt?: Date;
  }
Returns Promise<void>
Inherited from ModelShape.update
- Defined in packages/core/src/models/base.ts:38

`Static`all

all(): Promise<Job[]>
Returns Promise<Job[]>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).all
- Defined in packages/core/src/models/base.ts:24

`Static`clearFinishedInBatches

clearFinishedInBatches(
    __namedParameters?: {
        batchSize?: number;
        className?: string;
        finishedBefore?: number;
        sleepBetweenBatches?: number;
    },
): Promise<void>
Parameters
- __namedParameters: {
      batchSize?: number;
      className?: string;
      finishedBefore?: number;
      sleepBetweenBatches?: number;
  } = {}
Returns Promise<void>
- Defined in packages/core/src/models/job.ts:99

`Static`count

count(): Promise<number>
Returns Promise<number>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).count
- Defined in packages/core/src/models/base.ts:30

`Static`create

create(
    attrs: { arguments: string; className: string; queueName: string } & {
        concurrencyKey?: null | string;
        createdAt?: Date;
        finishedAt?: null | string;
        id?: number;
        priority?: number;
        scheduledAt?: string;
        updatedAt?: Date;
    },
    options?: {
        ignoreConflict:
            | NonNullableInsertKeys<JobsTable>
            | NullableInsertKeys<JobsTable>;
    },
): Promise<Job>
Parameters
- attrs: { arguments: string; className: string; queueName: string } & {
      concurrencyKey?: null | string;
      createdAt?: Date;
      finishedAt?: null | string;
      id?: number;
      priority?: number;
      scheduledAt?: string;
      updatedAt?: Date;
  }
- Optionaloptions: {
      ignoreConflict:
          | NonNullableInsertKeys<JobsTable>
          | NullableInsertKeys<JobsTable>;
  }
Returns Promise<Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).create
- Defined in packages/core/src/models/base.ts:11

`Static`createAll

createAll(
    attrs: (
        { arguments: string; className: string; queueName: string } & {
            concurrencyKey?: null | string;
            createdAt?: Date;
            finishedAt?: null | string;
            id?: number;
            priority?: number;
            scheduledAt?: string;
            updatedAt?: Date;
        }
    )[],
): Promise<Job[]>
Parameters
- attrs: (
      { arguments: string; className: string; queueName: string } & {
          concurrencyKey?: null | string;
          createdAt?: Date;
          finishedAt?: null | string;
          id?: number;
          priority?: number;
          scheduledAt?: string;
          updatedAt?: Date;
      }
  )[]
Returns Promise<Job[]>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).createAll
- Defined in packages/core/src/models/base.ts:17

`Static`createUnique

createUnique(
    attrs: { arguments: string; className: string; queueName: string } & {
        concurrencyKey?: null | string;
        createdAt?: Date;
        finishedAt?: null | string;
        id?: number;
        priority?: number;
        scheduledAt?: string;
        updatedAt?: Date;
    },
    uniqueBy: NonNullableInsertKeys<JobsTable> | NullableInsertKeys<JobsTable>,
): Promise<null | Job>
Parameters
- attrs: { arguments: string; className: string; queueName: string } & {
      concurrencyKey?: null | string;
      createdAt?: Date;
      finishedAt?: null | string;
      id?: number;
      priority?: number;
      scheduledAt?: string;
      updatedAt?: Date;
  }
- uniqueBy: NonNullableInsertKeys<JobsTable> | NullableInsertKeys<JobsTable>
Returns Promise<null | Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).createUnique
- Defined in packages/core/src/models/base.ts:18

`Static`destroy

destroy(cb: (db: Kysely<Database>) => CompiledQuery): Promise<number>
Parameters
- cb: (db: Kysely<Database>) => CompiledQuery
Returns Promise<number>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).destroy
- Defined in packages/core/src/models/base.ts:29

`Static`enqueue

enqueue(sideJob: SideJobShape): Promise<Job>
Parameters
- sideJob: SideJobShape
Returns Promise<Job>
- Defined in packages/core/src/models/job.ts:79

`Static`enqueueAll

enqueueAll(sideJobs: SideJobShape<unknown>[]): Promise<void>
Parameters
- sideJobs: SideJobShape<unknown>[]
Returns Promise<void>
- Defined in packages/core/src/models/job.ts:85

`Static`findAll

findAll(cb: (db: Kysely<Database>) => CompiledQuery): Promise<Job[]>
Parameters
- cb: (db: Kysely<Database>) => CompiledQuery
Returns Promise<Job[]>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).findAll
- Defined in packages/core/src/models/base.ts:23

`Static`findById

findById(id: number): Promise<null | Job>
Parameters
- id: number
Returns Promise<null | Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).findById
- Defined in packages/core/src/models/base.ts:19

`Static`findByIdOrThrow

findByIdOrThrow(id: number): Promise<Job>
Parameters
- id: number
Returns Promise<Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).findByIdOrThrow
- Defined in packages/core/src/models/base.ts:20

`Static`findOne

findOne(cb: (db: Kysely<Database>) => CompiledQuery): Promise<null | Job>
Parameters
- cb: (db: Kysely<Database>) => CompiledQuery
Returns Promise<null | Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).findOne
- Defined in packages/core/src/models/base.ts:21

`Static`findOneOrThrow

findOneOrThrow(cb: (db: Kysely<Database>) => CompiledQuery): Promise<Job>
Parameters
- cb: (db: Kysely<Database>) => CompiledQuery
Returns Promise<Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).findOneOrThrow
- Defined in packages/core/src/models/base.ts:22

`Static`finished

finished(): Promise<Job[]>
Returns Promise<Job[]>
- Defined in packages/core/src/models/job.ts:90

`Static`last

last(): Promise<null | Job>
Returns Promise<null | Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).last
- Defined in packages/core/src/models/base.ts:25
last(limit: 1): Promise<null | Job>
Parameters
- limit: 1
Returns Promise<null | Job>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).last
- Defined in packages/core/src/models/base.ts:26
last(limit: number): Promise<Job[]>
Parameters
- limit: number
Returns Promise<Job[]>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).last
- Defined in packages/core/src/models/base.ts:27

`Static`transaction

transaction<T>(cb: (tx: Transaction<Database>) => Promise<T>): Promise<T>
Type Parameters
- T
Parameters
- cb: (tx: Transaction<Database>) => Promise<T>
Returns Promise<T>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).transaction
- Defined in packages/core/src/models/base.ts:10

`Static`updateAll

updateAll(cb: (db: Kysely<Database>) => CompiledQuery): Promise<number>
Parameters
- cb: (db: Kysely<Database>) => CompiledQuery
Returns Promise<number>
Inherited from model<Job, typeof tables.jobs>(tables.jobs).updateAll
- Defined in packages/core/src/models/base.ts:28

Class Job

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Job

Properties

Statictable

Accessors

arguments

Returns JobArguments

concurrencyController

Returns ConcurrencyController

concurrencyDuration

Returns number

concurrencyLimit

Returns null | number

executor

Returns Executor

isConcurrencyLimited

Returns boolean

isDue

Returns boolean

isFinished

Returns boolean

scheduler

Returns Scheduler

StaticconcurrencyController

Returns typeof ConcurrencyController

Staticexecutor

Returns typeof Executor

Staticscheduler

Returns typeof Scheduler

Methods

attr

Type Parameters

Parameters

Returns { arguments: SuperJSONResult; className: string; concurrencyKey: null | string; createdAt: Date; finishedAt: null | string; id: number; priority: number; queueName: string; scheduledAt: Date; updatedAt: Date;}[K]

attrs

Returns { arguments: SuperJSONResult; className: string; concurrencyKey: null | string; createdAt: Date; finishedAt: null | string; id: number; priority: number; queueName: string; scheduledAt: Date; updatedAt: Date;}

destroy

Returns Promise<void>

discard

Returns Promise<void>

failedWith

Parameters

Returns Promise<FailedExecution>

finish

Returns Promise<void>

isBlocked

Returns Promise<null | BlockedExecution>

isClaimed

Returns Promise<boolean>

isFailed

Returns Promise<boolean>

isReady

Returns Promise<boolean>

reload

Returns Promise<Job>

resetExecutionCounters

Returns Promise<void>

retry

Returns Promise<void>

transaction

Parameters

Returns Promise<unknown>

update

Parameters

Returns Promise<void>

Staticall

Returns Promise<Job[]>

StaticclearFinishedInBatches

Parameters

Returns Promise<void>

Staticcount

`Static`table

`Static`concurrencyController

`Static`executor

`Static`scheduler

Returns {
arguments: SuperJSONResult;
className: string;
concurrencyKey: null | string;
createdAt: Date;
finishedAt: null | string;
id: number;
priority: number;
queueName: string;
scheduledAt: Date;
updatedAt: Date;
}[K]

Returns {
arguments: SuperJSONResult;
className: string;
concurrencyKey: null | string;
createdAt: Date;
finishedAt: null | string;
id: number;
priority: number;
queueName: string;
scheduledAt: Date;
updatedAt: Date;
}

`Static`all

`Static`clearFinishedInBatches

`Static`count

`Static`create

`Static`createAll

`Static`createUnique

`Static`destroy

`Static`enqueue

`Static`enqueueAll

`Static`findAll

`Static`findById

`Static`findByIdOrThrow

`Static`findOne

`Static`findOneOrThrow

`Static`finished

`Static`last

`Static`transaction

`Static`updateAll