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 / deleteItems

Function: deleteItems() ​

deleteItems<Schema, Collection, TQuery>(collection, keysOrQuery): RestCommand<void, Schema>

Delete multiple existing items.

Type parameters ​

• Schema extends object

• Collection extends string | number | symbol

• TQuery extends Query<Schema, Schema[Collection]>

Parameters ​

• collection: Collection

The collection of the items

• keysOrQuery: string[] | number[] | TQuery

The primary keys or a query

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 keysOrQuery is empty

Source ​

rest/commands/delete/items.ts:17