Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

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>

Defined in: rest/commands/delete/items.ts:54

Delete an existing item.

Type Parameters ​

• Schema

• Collection extends string | number | symbol

Parameters ​

collection ​

Collection

The collection of the item

key ​

The primary key of the item

string | number

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