Skip to main content
Version: 57.2.0

BackgroundTaskModel

Extends​

Constructors​

Constructor​

new BackgroundTaskModel<DocType>(doc?, fields?, options?): Document<unknown, Record<string, never>, BackgroundTaskDocument, { }, DefaultSchemaOptions> & Omit<BackgroundTaskDocument & Required<{ }> & object, "id" | keyof BackgroundTaskMethods> & HydratedDocumentOverrides<BackgroundTaskMethods & object>

Parameters​

doc?​

DocType

fields?​

any

options?​

AnyObject

Returns​

Document<unknown, Record<string, never>, BackgroundTaskDocument, { }, DefaultSchemaOptions> & Omit<BackgroundTaskDocument & Required<{ }> & object, "id" | keyof BackgroundTaskMethods> & HydratedDocumentOverrides<BackgroundTaskMethods & object>

Inherited from​

Model<BackgroundTaskDocument, Record<string, never>, BackgroundTaskMethods>.constructor

Properties​

checkCancellation​

checkCancellation: (taskId) => Promise<void>

Parameters​

taskId​

string

Returns​

Promise<void>

Inherited from​

BackgroundTaskStatics.checkCancellation