Skip to content
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 / updateCollectionsBatch

Function: updateCollectionsBatch()

updateCollectionsBatch<Schema, TQuery>(items, query?): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, FieldsWildcard<DirectusCollection<Schema>, Exclude<UnpackList<Mutable<TQuery["fields"]>>, PickRelationalFields<UnpackList<Mutable<...>>> extends never ? never : AllKeys<UnpackList<...> extends Field ? ... extends ... ? ... : ... : never>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof DirectusCollection<Schema> ? Extract<DirectusCollection<Schema>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<DirectusCollection<Schema>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }>>, Schema>

Update multiple collections as batch.

Type parameters

Schema

TQuery extends Query<Schema, DirectusCollection<Schema>>

Parameters

items: NestedPartial<DirectusCollection<Schema>>[]

query?: TQuery

Returns

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, FieldsWildcard<DirectusCollection<Schema>, Exclude<UnpackList<Mutable<TQuery["fields"]>>, PickRelationalFields<UnpackList<Mutable<...>>> extends never ? never : AllKeys<UnpackList<...> extends Field ? ... extends ... ? ... : ... : never>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof DirectusCollection<Schema> ? Extract<DirectusCollection<Schema>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<DirectusCollection<Schema>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }>>, Schema>

Returns the collection objects for the updated collections.

Source

rest/commands/update/collections.ts:44