Interface JobRequest<Type, Data, CustomHeaders, CustomOptions>

interface JobRequest<
    Type extends string = string,
    Data = unknown,
    CustomHeaders extends Record<string, any> = AnyHeaders,
    CustomOptions extends Record<string, any> = AnyOptions,
> {
    data: Data;
    jobUserId: string;
    options?: Options<CustomHeaders, CustomOptions>;
    type?: Type;
}

Type Parameters

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

Hierarchy (View Summary)

JobRequest
- JobObject

Index

Properties

data jobUserId options? type?

Properties

data

data: Data

Job payload

jobUserId

jobUserId: string

User job request identifier, defined by the user

`Optional`options

options?: Options<CustomHeaders, CustomOptions>

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

`Optional`type

type?: Type

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