Skip to content

Meilisearch JS / index / Task

Type Alias: Task

Task = SafeOmit<EnqueuedTask, "taskUid"> & object

Defined in: src/types/task-and-batch.ts:157

https://www.meilisearch.com/docs/reference/api/tasks#task-object

Type Declaration

batchUid

batchUid: number | null

canceledBy

canceledBy: number | null

customMetadata?

optional customMetadata?: string

Arbitrary metadata attached to the task at enqueue time.

See

https://www.meilisearch.com/docs/reference/api/async-task-management/get-task#response-custom-metadata-one-of-0

details?

optional details?: TaskDetails

duration

duration: string | null

error

error: MeilisearchErrorResponse | null

finishedAt

finishedAt: string | null

network?

optional network?: NetworkOrigin | NetworkRemoteTasks

https://www.meilisearch.com/docs/reference/api/tasks#network

startedAt

startedAt: string | null

uid

uid: number

See

meilisearch_types::task_view::TaskView