Directus / @directus/sdk / rest / updateSingleton
Function: updateSingleton() ​
updateSingleton<
Schema
,Collection
,TQuery
,Item
>(collection
,item
,query
?):RestCommand
<IfAny
<Schema
,Record
<string
,any
>,Merge
<MappedFunctionFields
<Schema
,UnpackList
<IfAny
<Schema
,any
,Collection
extends keyofSchema
?UnpackList
<...[...]> extendsobject
?object
&UnpackList
<...> :never
:never
>>> extendsFF
?MapFlatFields
<UnpackList
<IfAny
<Schema
,any
,Collection
extends keyofSchema
?UnpackList
<...[...]> extendsobject
?object
&UnpackList
<...> :never
:never
>>,FieldsWildcard
<UnpackList
<IfAny
<Schema
,any
,Collection
extends keyofSchema
?UnpackList
<...> extendsobject
? ... & ... :never
:never
>>,Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>,PickRelationalFields
<UnpackList
<Mutable
<...>>> extendsnever
?never
:AllKeys
<UnpackList
<...> extendsField
? ... extends ... ? ... : ... :never
>>>,FF
extendsRecord
<string
,string
> ?FF
<FF
> :Record
<string
,string
>> :never
,PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extendsnever
?never
:{ [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>> ? Extract<UnpackList<IfAny<(...), (...), (...)>>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<(...), (...), (...)>>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>,Schema
>
Update a singleton item
Type parameters ​
• Schema
• Collection extends string
| number
| symbol
• TQuery extends Query
<Schema
, Schema
[Collection
]>
• Item = Schema
[Collection
]
Parameters ​
• collection: Collection
The collection of the items
• item: Partial
<Item
>
• query?: TQuery
The query parameters
Returns ​
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, Merge
<MappedFunctionFields
<Schema
, UnpackList
<IfAny
<Schema
, any
, Collection
extends keyof Schema
? UnpackList
<...[...]> extends object
? object
& UnpackList
<...> : never
: never
>>> extends FF
? MapFlatFields
<UnpackList
<IfAny
<Schema
, any
, Collection
extends keyof Schema
? UnpackList
<...[...]> extends object
? object
& UnpackList
<...> : never
: never
>>, FieldsWildcard
<UnpackList
<IfAny
<Schema
, any
, Collection
extends keyof Schema
? UnpackList
<...> extends object
? ... & ... : never
: never
>>, 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 UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>> ? Extract<UnpackList<IfAny<(...), (...), (...)>>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<(...), (...), (...)>>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>, Schema
>
An array of up to limit item objects. If no items are available, data will be an empty array.
Throws ​
Will throw if collection is a core collection
Throws ​
Will throw if collection is empty