Interface IMongoQueueTaskDocument

A document in a MongoDb collection for a queue task.

interface IMongoQueueTaskDocument {
    _id: ObjectId;
    createdAt: Date;
    createdBy?: string;
    data: QueueTaskData;
    errors: IMongoQueueTaskError[];
    key: string;
    status: MongoQueueTaskStatus;
    updatedAt?: Date;
    updatedBy?: string;
    uuid: string;
}

Properties

_id createdAt createdBy? data errors key status updatedAt? updatedBy? uuid

Properties

_id

_id: ObjectId

The Mongo ID

createdAt

createdAt: Date

The timestamp, document has been created.

Optional createdBy

createdBy?: string

A string indicating, which system / process / pod created the entry.

data

data: QueueTaskData

The current data.

errors

errors: IMongoQueueTaskError[]

List of occured errors.

key

key: string

The key of the task.

status

status: MongoQueueTaskStatus

The status.

Optional updatedAt

updatedAt?: Date

The timestamp, document has been updated.

Optional updatedBy

updatedBy?: string

A string indicating, which system / process / pod updated the entry.

uuid

uuid: string

The UUID.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc