Directus / @directus/sdk / rest / updateShares

Function: updateShares() ​

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

Update multiple existing shares.

Type parameters ​

• Schema extends object

• TQuery extends Query<Schema, DirectusShare<Schema>>

Parameters ​

• keys: DirectusShare<Schema>["id"][]

• item: Partial<DirectusShare<Schema>>

• query?: TQuery

Returns ​

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

Returns the share objects for the updated shares.

Throws ​

Will throw if keys is empty

Source ​

rest/commands/update/shares.ts:21