Appearance

On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / deleteItem

Function: deleteItem() ​

deleteItem<Schema, Collection>(collection, key): RestCommand<void, Schema>

Delete an existing item.

Type parameters ​

• Schema extends object

• Collection extends string | number | symbol

Parameters ​

• collection: Collection

The collection of the item

• key: string | number

The primary key of the item

Returns ​

RestCommand<void, Schema>

Nothing

Throws ​

Will throw if collection is empty

Throws ​

Will throw if collection is a core collection

Throws ​

Will throw if key is empty

Source ​

rest/commands/delete/items.ts:54