Class RecurringTask

Hierarchy (View Summary)

ModelShape<RecurringTasksTable, this>
- RecurringTask

Index

Constructors

constructor

Properties

table

Constructors

constructor

new RecurringTask(
    attrs: {
        arguments: SuperJSONResult;
        className: null | string;
        createdAt: Date;
        description: null | string;
        id: number;
        key: string;
        priority: null | number;
        queueName: null | string;
        schedule: string;
        static: boolean;
        updatedAt: Date;
    },
): RecurringTask
Parameters
- attrs: {
      arguments: SuperJSONResult;
      className: null | string;
      createdAt: Date;
      description: null | string;
      id: number;
      key: string;
      priority: null | number;
      queueName: null | string;
      schedule: string;
      static: boolean;
      updatedAt: Date;
  }
Returns RecurringTask
Overrides model<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).constructor
- Defined in packages/core/src/models/recurring-task.ts:24

Properties

`Static`table

table: "sideloop_recurring_tasks" = tables.recurringTasks

Methods

attr

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

attributesForUpsert

attributesForUpsert(): {
    arguments: string;
    className: null
    | string;
    description: null | string;
    key: string;
    priority: null | number;
    queueName: null | string;
    schedule: string;
    static: boolean;
    updatedAt: string;
}
Returns {
    arguments: string;
    className: null | string;
    description: null | string;
    key: string;
    priority: null | number;
    queueName: null | string;
    schedule: string;
    static: boolean;
    updatedAt: string;
}
- Defined in packages/core/src/models/recurring-task.ts:81

attrs

attrs(): {
    arguments: SuperJSONResult;
    className: null
    | string;
    createdAt: Date;
    description: null | string;
    id: number;
    key: string;
    priority: null | number;
    queueName: null | string;
    schedule: string;
    static: boolean;
    updatedAt: Date;
}
Returns {
    arguments: SuperJSONResult;
    className: null | string;
    createdAt: Date;
    description: null | string;
    id: number;
    key: string;
    priority: null | number;
    queueName: null | string;
    schedule: string;
    static: boolean;
    updatedAt: Date;
}
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

enqueue

enqueue(at: Date): Promise<void>
Parameters
- at: Date
Returns Promise<void>
- Defined in packages/core/src/models/recurring-task.ts:76

reload

reload(): Promise<RecurringTask>
Returns Promise<RecurringTask>
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: {
        arguments?: string;
        className?: null | string;
        createdAt?: Date;
        description?: null | string;
        id?: number;
        key?: string;
        priority?: null | number;
        queueName?: null | string;
        schedule?: string;
        static?: boolean;
        updatedAt?: string;
    },
): Promise<void>
Parameters
- attrs: {
      arguments?: string;
      className?: null | string;
      createdAt?: Date;
      description?: null | string;
      id?: number;
      key?: string;
      priority?: null | number;
      queueName?: null | string;
      schedule?: string;
      static?: boolean;
      updatedAt?: string;
  }
Returns Promise<void>
Inherited from ModelShape.update
- Defined in packages/core/src/models/base.ts:38

`Static`all

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

`Static`count

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

`Static`create

create(
    attrs: { arguments: string; key: string; schedule: string } & {
        className?: null | string;
        createdAt?: Date;
        description?: null | string;
        id?: number;
        priority?: null | number;
        queueName?: null | string;
        static?: boolean;
        updatedAt?: string;
    },
    options?: {
        ignoreConflict:
            | NonNullableInsertKeys<RecurringTasksTable>
            | NullableInsertKeys<RecurringTasksTable>;
    },
): Promise<RecurringTask>
Parameters
- attrs: { arguments: string; key: string; schedule: string } & {
      className?: null | string;
      createdAt?: Date;
      description?: null | string;
      id?: number;
      priority?: null | number;
      queueName?: null | string;
      static?: boolean;
      updatedAt?: string;
  }
- Optionaloptions: {
      ignoreConflict:
          | NonNullableInsertKeys<RecurringTasksTable>
          | NullableInsertKeys<RecurringTasksTable>;
  }
Returns Promise<RecurringTask>
Inherited from model<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).create
- Defined in packages/core/src/models/base.ts:11

`Static`createAll

createAll(
    attrs: (
        { arguments: string; key: string; schedule: string } & {
            className?: null | string;
            createdAt?: Date;
            description?: null | string;
            id?: number;
            priority?: null | number;
            queueName?: null | string;
            static?: boolean;
            updatedAt?: string;
        }
    )[],
): Promise<RecurringTask[]>
Parameters
- attrs: (
      { arguments: string; key: string; schedule: string } & {
          className?: null | string;
          createdAt?: Date;
          description?: null | string;
          id?: number;
          priority?: null | number;
          queueName?: null | string;
          static?: boolean;
          updatedAt?: string;
      }
  )[]
Returns Promise<RecurringTask[]>
Inherited from model<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).createAll
- Defined in packages/core/src/models/base.ts:17

`Static`createOrUpdateAll

createOrUpdateAll(tasks: RecurringTask[]): Promise<void>
Parameters
- tasks: RecurringTask[]
Returns Promise<void>
- Defined in packages/core/src/models/recurring-task.ts:55

`Static`createUnique

createUnique(
    attrs: { arguments: string; key: string; schedule: string } & {
        className?: null | string;
        createdAt?: Date;
        description?: null | string;
        id?: number;
        priority?: null | number;
        queueName?: null | string;
        static?: boolean;
        updatedAt?: string;
    },
    uniqueBy:
        | NonNullableInsertKeys<RecurringTasksTable>
        | NullableInsertKeys<RecurringTasksTable>,
): Promise<null | RecurringTask>
Parameters
- attrs: { arguments: string; key: string; schedule: string } & {
      className?: null | string;
      createdAt?: Date;
      description?: null | string;
      id?: number;
      priority?: null | number;
      queueName?: null | string;
      static?: boolean;
      updatedAt?: string;
  }
- uniqueBy:
  | NonNullableInsertKeys<RecurringTasksTable>
  | NullableInsertKeys<RecurringTasksTable>
Returns Promise<null | RecurringTask>
Inherited from model<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).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<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).destroy
- Defined in packages/core/src/models/base.ts:29

`Static`findAll

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

`Static`findById

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

`Static`findByIdOrThrow

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

`Static`findOne

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

`Static`findOneOrThrow

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

`Static`last

last(): Promise<null | RecurringTask>
Returns Promise<null | RecurringTask>
Inherited from model<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).last
- Defined in packages/core/src/models/base.ts:25
last(limit: 1): Promise<null | RecurringTask>
Parameters
- limit: 1
Returns Promise<null | RecurringTask>
Inherited from model<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).last
- Defined in packages/core/src/models/base.ts:26
last(limit: number): Promise<RecurringTask[]>
Parameters
- limit: number
Returns Promise<RecurringTask[]>
Inherited from model<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).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<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).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<RecurringTask, typeof tables.recurringTasks>(tables.recurringTasks).updateAll
- Defined in packages/core/src/models/base.ts:28

`Static`wrap

wrap(task: RecurringTaskAttributes | RecurringTask): RecurringTask
Parameters
- task: RecurringTaskAttributes | RecurringTask
Returns RecurringTask
- Defined in packages/core/src/models/recurring-task.ts:35

Class RecurringTask

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RecurringTask

Properties

Statictable

Methods

attr

Type Parameters

Parameters

Returns { arguments: SuperJSONResult; className: null | string; createdAt: Date; description: null | string; id: number; key: string; priority: null | number; queueName: null | string; schedule: string; static: boolean; updatedAt: Date;}[K]

attributesForUpsert

Returns { arguments: string; className: null | string; description: null | string; key: string; priority: null | number; queueName: null | string; schedule: string; static: boolean; updatedAt: string;}

attrs

Returns { arguments: SuperJSONResult; className: null | string; createdAt: Date; description: null | string; id: number; key: string; priority: null | number; queueName: null | string; schedule: string; static: boolean; updatedAt: Date;}

destroy

Returns Promise<void>

enqueue

Parameters

Returns Promise<void>

reload

Returns Promise<RecurringTask>

transaction

Parameters

Returns Promise<unknown>

update

Parameters

Returns Promise<void>

Staticall

Returns Promise<RecurringTask[]>

Staticcount

Returns Promise<number>

Staticcreate

Parameters

Returns Promise<RecurringTask>

StaticcreateAll

Parameters

Returns Promise<RecurringTask[]>

StaticcreateOrUpdateAll

Parameters

Returns Promise<void>

StaticcreateUnique

Parameters

Returns Promise<null | RecurringTask>

Staticdestroy

Parameters

Returns Promise<number>

StaticfindAll

Parameters

Returns Promise<RecurringTask[]>

StaticfindById

Parameters

Returns Promise<null | RecurringTask>

StaticfindByIdOrThrow

Parameters

Returns Promise<RecurringTask>

StaticfindOne

Parameters

Returns Promise<null | RecurringTask>

StaticfindOneOrThrow

Parameters

Returns Promise<RecurringTask>

Staticlast

Returns Promise<null | RecurringTask>

Parameters

Returns Promise<null | RecurringTask>

Parameters

Returns Promise<RecurringTask[]>

Statictransaction

Type Parameters

Parameters

Returns Promise<T>

StaticupdateAll

Parameters

`Static`table

Returns {
arguments: SuperJSONResult;
className: null | string;
createdAt: Date;
description: null | string;
id: number;
key: string;
priority: null | number;
queueName: null | string;
schedule: string;
static: boolean;
updatedAt: Date;
}[K]

Returns {
arguments: string;
className: null | string;
description: null | string;
key: string;
priority: null | number;
queueName: null | string;
schedule: string;
static: boolean;
updatedAt: string;
}

Returns {
arguments: SuperJSONResult;
className: null | string;
createdAt: Date;
description: null | string;
id: number;
key: string;
priority: null | number;
queueName: null | string;
schedule: string;
static: boolean;
updatedAt: Date;
}

`Static`all

`Static`count

`Static`create

`Static`createAll

`Static`createOrUpdateAll

`Static`createUnique

`Static`destroy

`Static`findAll

`Static`findById

`Static`findByIdOrThrow

`Static`findOne

`Static`findOneOrThrow

`Static`last

`Static`transaction

`Static`updateAll

`Static`wrap