Interface JobObject<Type, Data, CustomHeaders, CustomOptions>

Job object

interface JobObject<
    Type extends string = string,
    Data = any,
    CustomHeaders extends Record<string, any> = AnyHeaders,
    CustomOptions extends Record<string, any> = AnyOptions,
> {
    data: Data;
    jobUserId: string;
    jobUserUUID: string;
    options?: Options<CustomHeaders, CustomOptions>;
    status: Jobs.Status;
    type: Type;
    uuid: string;
}

Type Parameters

  • Type extends string = string
  • Data = any
  • CustomHeaders extends Record<string, any> = AnyHeaders
  • CustomOptions extends Record<string, any> = AnyOptions

Hierarchy (View Summary)

Implemented by

Properties

data jobUserId jobUserUUID options? status type uuid

Properties

data

data: Data

Job payload

jobUserId

jobUserId: string

User job request identifier, defined by the user

jobUserUUID

jobUserUUID: string

Unique user job request identification, generated by UUID V5 standard and based on jobUserId

Optionaloptions

options?: Options<CustomHeaders, CustomOptions>

Job meta information, used to pass specific information for job processors

status

status: Jobs.Status

Job status

type

type: Type

Job type identification, used to identify specific job handlers to be applied

uuid

uuid: string

Unique job processing identification

Settings

Member Visibility

On This Page

Properties