Directus / @directus/sdk / rest / updateRole
Function: updateRole() ​
updateRole<
Schema,TQuery>(key,item,query?):RestCommand<IfAny<Schema,Record<string,any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_roles" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_roles" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, (...) 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 role.
Type Parameters ​
• Schema
• TQuery extends Query<Schema, DirectusRole<Schema>>
Parameters ​
• key: DirectusRole<Schema>["id"]
• item: Partial<DirectusRole<Schema>>
• query?: TQuery
Returns ​
RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_roles" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_roles" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, (...) 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 role object for the updated role.
Throws ​
Will throw if key is empty