Directus / @directus/sdk / rest / updateItem
Function: updateItem() ​
updateItem<
Schema,Collection,TQuery,Item>(collection,key,item,query?):RestCommand<IfAny<Schema,Record<string,any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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 UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>,Schema>
Update an existing item.
Type Parameters ​
• Schema
• Collection extends string | number | symbol
• TQuery extends Query<Schema, Schema[Collection]>
• Item = UnpackList<Schema[Collection]>
Parameters ​
• collection: Collection
The collection of the item
• key: string | number
The primary key of the item
• item: Partial<Item>
The item data to update
• query?: TQuery
Optional return data query
Returns ​
RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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 UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>
Returns the item object of the item that was updated.
Throws ​
Will throw if key is empty
Throws ​
Will throw if collection is empty
Throws ​
Will throw if collection is a core collection