Directus / @directus/sdk / rest / updateSettings

Function: updateSettings() ​

updateSettings<Schema, TQuery>(item, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { auth_login_attempts: ...; auth_password_policy: ...; basemaps: ...; custom_aspect_ratios: ...; custom_css: ...; default_language: ...; id: ...; mapbox_key: ...; module_bar: ...; project_color: ...; project_descriptor: ...; project_logo: ...; project_name: ...; project_url: ...; public_background: ...; public_foreground: ...; public_note: ...; report_bug_url: ...; report_error_url: ...; report_feature_url: ...; storage_asset_presets: ...; storage_asset_transform: ...; storage_default_folder: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { auth_login_attempts: ...; auth_password_policy: ...; basemaps: ...; custom_aspect_ratios: ...; custom_css: ...; default_language: ...; id: ...; mapbox_key: ...; module_bar: ...; project_color: ...; project_descriptor: ...; project_logo: ...; project_name: ...; project_url: ...; public_background: ...; public_foreground: ...; public_note: ...; report_bug_url: ...; report_error_url: ...; report_feature_url: ...; storage_asset_presets: ...; storage_asset_transform: ...; storage_default_folder: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

Defined in: rest/commands/update/settings.ts:18

Update Settings

Type Parameters ​

• Schema

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

Parameters ​

item ​

Partial<DirectusSettings<Schema>>

query? ​

TQuery

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { auth_login_attempts: ...; auth_password_policy: ...; basemaps: ...; custom_aspect_ratios: ...; custom_css: ...; default_language: ...; id: ...; mapbox_key: ...; module_bar: ...; project_color: ...; project_descriptor: ...; project_logo: ...; project_name: ...; project_url: ...; public_background: ...; public_foreground: ...; public_note: ...; report_bug_url: ...; report_error_url: ...; report_feature_url: ...; storage_asset_presets: ...; storage_asset_transform: ...; storage_default_folder: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { auth_login_attempts: ...; auth_password_policy: ...; basemaps: ...; custom_aspect_ratios: ...; custom_css: ...; default_language: ...; id: ...; mapbox_key: ...; module_bar: ...; project_color: ...; project_descriptor: ...; project_logo: ...; project_name: ...; project_url: ...; public_background: ...; public_foreground: ...; public_note: ...; report_bug_url: ...; report_error_url: ...; report_feature_url: ...; storage_asset_presets: ...; storage_asset_transform: ...; storage_default_folder: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

Returns the settings object.