Skip to main content

@nest-boot/bullmq-mikro-orm

Enumerations​

JobStatus​

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:1

Enumeration Members​

ACTIVE​
ACTIVE: "active";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:2

COMPLETED​
COMPLETED: "completed";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:3

DELAYED​
DELAYED: "delayed";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:4

FAILED​
FAILED: "failed";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:5

PRIORITIZED​
PRIORITIZED: "prioritized";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:6

UNKNOWN​
UNKNOWN: "unknown";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:7

WAITING​
WAITING: "waiting";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:8

WAITING_CHILDREN​
WAITING_CHILDREN: "waiting-children";

Defined in: packages/bullmq-mikro-orm/src/enums/job-status.enum.ts:9

Classes​

BullMQMikroORMModule​

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm.module.ts:14

Extends​

  • ConfigurableModuleClass

Indexable​

[key: string]: any

Constructors​

Constructor​
new BullMQMikroORMModule(): BullMQMikroORMModule;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns​

BullMQMikroORMModule

Inherited from​
ConfigurableModuleClass.constructor

Methods​

forRoot()​
static forRoot<T>(options): DynamicModule;

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm.module.ts:15

Type Parameters​
Type Parameter
T extends JobEntity
Parameters​
ParameterType
optionsBullMQMikroORMModuleOptions<T>
Returns​

DynamicModule

Overrides​
ConfigurableModuleClass.forRoot
forRootAsync()​
static forRootAsync<T>(options): DynamicModule;

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm.module.ts:21

Type Parameters​
Type Parameter
T extends JobEntity
Parameters​
ParameterType
optionsConfigurableModuleAsyncOptions<BullMQMikroORMModuleOptions<T>>
Returns​

DynamicModule

Overrides​
ConfigurableModuleClass.forRootAsync

abstract JobEntity​

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:15

Constructors​

Constructor​
new JobEntity(): JobEntity;
Returns​

JobEntity

Properties​

createdAt​
createdAt: Opt<Date>;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:54

data​
data: any;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:27

failedReason?​
optional failedReason: string;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:33

finishedAt?​
optional finishedAt: Date;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:50

id​
id: string;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:17

name​
name: string;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:24

priority​
priority: number;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:36

progress​
progress: Opt<JobProgress>;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:40

queueName​
queueName: string;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:20

returnValue?​
optional returnValue: any;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:30

startedAt?​
optional startedAt: Date;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:47

status​
status: string;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:44

updatedAt​
updatedAt: Opt<Date>;

Defined in: packages/bullmq-mikro-orm/src/entities/job.entity.ts:62

Interfaces​

BullMQMikroORMModuleOptions​

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm-module-options.interface.ts:6

Type Parameters​

Type Parameter
T extends JobEntity

Properties​

convertJobToEntityData()?​
optional convertJobToEntityData: (job) => EntityData<T> | Promise<EntityData<T>>;

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm-module-options.interface.ts:11

Parameters​
ParameterType
jobJob
Returns​

EntityData<T> | Promise<EntityData<T>>

excludeQueues?​
optional excludeQueues: string[];

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm-module-options.interface.ts:14

includeQueues?​
optional includeQueues: string[];

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm-module-options.interface.ts:13

jobEntity​
jobEntity: EntityClass<T>;

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm-module-options.interface.ts:7

jobTTL?​
optional jobTTL: number;

Defined in: packages/bullmq-mikro-orm/src/bullmq-mikro-orm-module-options.interface.ts:9