Home > git-documentdb > DeleteOptions

DeleteOptions type

Options for delete

Signature:

export declare type DeleteOptions = {

commitMessage?: string;

taskId?: string;

enqueueCallback?: (taskMetadata: TaskMetadata) => void;

};

References:

TaskMetadata

Remarks

• commitMessage: Git commit message. Default is 'delete: path/to/the/file( < fileOid > )'.

• taskId: taskId is used in TaskQueue to distinguish CRUD and synchronization tasks. It is usually generated automatically. Set it if you would like to monitor this delete task explicitly.

• enqueueCallback: A callback function called just after this delete task is enqueued to TaskQueue.