Class RecurringExecution

Hierarchy (View Summary)

ModelShape<RecurringExecutionsTable, this>
- RecurringExecution

Index

Constructors

constructor

new RecurringExecution(
    attrs: {
        createdAt: Date;
        id: number;
        jobId: number;
        runAt: Date;
        taskKey: string;
    },
): RecurringExecution
Parameters
- attrs: { createdAt: Date; id: number; jobId: number; runAt: Date; taskKey: string }
Returns RecurringExecution
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).constructor
- Defined in packages/core/src/models/base.ts:9

Properties

discard

discard: () => Promise<void>

job

job: () => Promise<Job>

`Static`table

table: "sideloop_recurring_executions" = TABLE

Methods

attr

attr<K extends NonNeverSelectKeys<RecurringExecutionsTable>>(
    name: K,
): {
    createdAt: Date;
    id: number;
    jobId: number;
    runAt: Date;
    taskKey: string;
}[K]
Type Parameters
- K extends NonNeverSelectKeys<RecurringExecutionsTable>
Parameters
- name: K
Returns { createdAt: Date; id: number; jobId: number; runAt: Date; taskKey: string }[K]
Inherited from ModelShape.attr
- Defined in packages/core/src/models/base.ts:35

attrs

attrs(): {
    createdAt: Date;
    id: number;
    jobId: number;
    runAt: Date;
    taskKey: string;
}
Returns { createdAt: Date; id: number; jobId: number; runAt: Date; taskKey: string }
Inherited from ModelShape.attrs
- Defined in packages/core/src/models/base.ts:34

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from ModelShape.destroy
- Defined in packages/core/src/models/base.ts:37

reload

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

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: {
        createdAt?: Date;
        id?: number;
        jobId?: number;
        runAt?: string;
        taskKey?: string;
    },
): Promise<void>
Parameters
- attrs: {
      createdAt?: Date;
      id?: number;
      jobId?: number;
      runAt?: string;
      taskKey?: string;
  }
Returns Promise<void>
Inherited from ModelShape.update
- Defined in packages/core/src/models/base.ts:38

`Static`all

all(): Promise<RecurringExecution[]>
Returns Promise<RecurringExecution[]>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).all
- Defined in packages/core/src/models/base.ts:24

`Static`attributesFromJob

attributesFromJob(
job: Job,
): { jobId: number; priority: number; queueName: string }
Parameters
- job: Job
Returns { jobId: number; priority: number; queueName: string }
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).attributesFromJob
- Defined in packages/core/src/models/execution.ts:9

`Static`count

count(): Promise<number>
Returns Promise<number>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).count
- Defined in packages/core/src/models/base.ts:30

`Static`create

create(
    attrs: { jobId: number; taskKey: string } & {
        createdAt?: Date;
        id?: number;
        runAt?: string;
    },
    options?: {
        ignoreConflict:
            | NonNullableInsertKeys<RecurringExecutionsTable>
            | NullableInsertKeys<RecurringExecutionsTable>;
    },
): Promise<RecurringExecution>
Parameters
- attrs: { jobId: number; taskKey: string } & {
      createdAt?: Date;
      id?: number;
      runAt?: string;
  }
- Optionaloptions: {
      ignoreConflict:
          | NonNullableInsertKeys<RecurringExecutionsTable>
          | NullableInsertKeys<RecurringExecutionsTable>;
  }
Returns Promise<RecurringExecution>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).create
- Defined in packages/core/src/models/base.ts:11

`Static`createAll

createAll(
    attrs: (
        { jobId: number; taskKey: string } & {
            createdAt?: Date;
            id?: number;
            runAt?: string;
        }
    )[],
): Promise<RecurringExecution[]>
Parameters
- attrs: (
      { jobId: number; taskKey: string } & {
          createdAt?: Date;
          id?: number;
          runAt?: string;
      }
  )[]
Returns Promise<RecurringExecution[]>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).createAll
- Defined in packages/core/src/models/base.ts:17

`Static`createAllFromJobs

createAllFromJobs(jobs: Job[]): Promise<void>
Parameters
- jobs: Job[]
Returns Promise<void>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).createAllFromJobs
- Defined in packages/core/src/models/execution.ts:8

`Static`createUnique

createUnique(
    attrs: { jobId: number; taskKey: string } & {
        createdAt?: Date;
        id?: number;
        runAt?: string;
    },
    uniqueBy:
        | NonNullableInsertKeys<RecurringExecutionsTable>
        | NullableInsertKeys<RecurringExecutionsTable>,
): Promise<null | RecurringExecution>
Parameters
- attrs: { jobId: number; taskKey: string } & {
      createdAt?: Date;
      id?: number;
      runAt?: string;
  }
- uniqueBy:
  | NonNullableInsertKeys<RecurringExecutionsTable>
  | NullableInsertKeys<RecurringExecutionsTable>
Returns Promise<null | RecurringExecution>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).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 execution<RecurringExecution, typeof TABLE>(TABLE).destroy
- Defined in packages/core/src/models/base.ts:29

`Static`discardAllFromJobs

discardAllFromJobs(jobs: Job[]): Promise<void>
Parameters
- jobs: Job[]
Returns Promise<void>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).discardAllFromJobs
- Defined in packages/core/src/models/execution.ts:11

`Static`discardAllInBatches

discardAllInBatches(
opts?: { batchSize?: number; queue?: string },
): Promise<void>
Parameters
- Optionalopts: { batchSize?: number; queue?: string }
Returns Promise<void>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).discardAllInBatches
- Defined in packages/core/src/models/execution.ts:10

`Static`findAll

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

`Static`findById

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

`Static`findByIdOrThrow

findByIdOrThrow(id: number): Promise<RecurringExecution>
Parameters
- id: number
Returns Promise<RecurringExecution>
Inherited from execution<RecurringExecution, typeof TABLE>(TABLE).findByIdOrThrow
- Defined in packages/core/src/models/base.ts:20

`Static`findOne

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

`Static`findOneOrThrow

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

`Static`last

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

`Static`record

record(
    taskKey: string,
    runAt: Date,
    callback: () => Promise<Job>,
): Promise<void>
Parameters
- taskKey: string
- runAt: Date
- callback: () => Promise<Job>
Returns Promise<void>
- Defined in packages/core/src/models/recurring-execution.ts:13

`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 execution<RecurringExecution, typeof TABLE>(TABLE).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 execution<RecurringExecution, typeof TABLE>(TABLE).updateAll
- Defined in packages/core/src/models/base.ts:28

Class RecurringExecution

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RecurringExecution

Properties

discard

job

Statictable

Methods

attr

Type Parameters

Parameters

Returns { createdAt: Date; id: number; jobId: number; runAt: Date; taskKey: string }[K]

attrs

Returns { createdAt: Date; id: number; jobId: number; runAt: Date; taskKey: string }

destroy

Returns Promise<void>

reload

Returns Promise<RecurringExecution>

transaction

Parameters

Returns Promise<unknown>

update

Parameters

Returns Promise<void>

Staticall

Returns Promise<RecurringExecution[]>

StaticattributesFromJob

Parameters

Returns { jobId: number; priority: number; queueName: string }

Staticcount

Returns Promise<number>

Staticcreate

Parameters

Returns Promise<RecurringExecution>

StaticcreateAll

Parameters

Returns Promise<RecurringExecution[]>

StaticcreateAllFromJobs

Parameters

Returns Promise<void>

StaticcreateUnique

Parameters

Returns Promise<null | RecurringExecution>

Staticdestroy

Parameters

Returns Promise<number>

StaticdiscardAllFromJobs

Parameters

Returns Promise<void>

StaticdiscardAllInBatches

Parameters

Returns Promise<void>

StaticfindAll

Parameters

Returns Promise<RecurringExecution[]>

StaticfindById

Parameters

Returns Promise<null | RecurringExecution>

StaticfindByIdOrThrow

Parameters

Returns Promise<RecurringExecution>

StaticfindOne

Parameters

Returns Promise<null | RecurringExecution>

StaticfindOneOrThrow

Parameters

Returns Promise<RecurringExecution>

Staticlast

Returns Promise<null | RecurringExecution>

Parameters

Returns Promise<null | RecurringExecution>

Parameters

Returns Promise<RecurringExecution[]>

`Static`table

`Static`all

`Static`attributesFromJob

`Static`count

`Static`create

`Static`createAll

`Static`createAllFromJobs

`Static`createUnique

`Static`destroy

`Static`discardAllFromJobs

`Static`discardAllInBatches

`Static`findAll

`Static`findById

`Static`findByIdOrThrow

`Static`findOne

`Static`findOneOrThrow

`Static`last

`Static`record

`Static`transaction

`Static`updateAll