Directus / @directus/sdk / rest / readSettings

Function: readSettings() ​

readSettings<Schema, TQuery>(query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { auth_login_attempts: number; auth_password_policy: (...) | (...); basemaps: (...) | (...); custom_aspect_ratios: (...) | (...); custom_css: (...) | (...); default_language: string; id: 1; mapbox_key: (...) | (...); module_bar: (...) | (...); project_color: (...) | (...); project_descriptor: (...) | (...); project_logo: (...) | (...); project_name: string; project_url: string; public_background: (...) | (...); public_foreground: (...) | (...); public_note: (...) | (...); report_bug_url: (...) | (...); report_error_url: (...) | (...); report_feature_url: (...) | (...); storage_asset_presets: (...) | (...); storage_asset_transform: (...) | (...) | (...); storage_default_folder: (...) | (...) | (...) }, "directus_settings" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { 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 FF ? MapFlatFields<UnpackList<IfAny<Schema, { auth_login_attempts: number; auth_password_policy: (...) | (...); basemaps: (...) | (...); custom_aspect_ratios: (...) | (...); custom_css: (...) | (...); default_language: string; id: 1; mapbox_key: (...) | (...); module_bar: (...) | (...); project_color: (...) | (...); project_descriptor: (...) | (...); project_logo: (...) | (...); project_name: string; project_url: string; public_background: (...) | (...); public_foreground: (...) | (...); public_note: (...) | (...); report_bug_url: (...) | (...); report_error_url: (...) | (...); report_feature_url: (...) | (...); storage_asset_presets: (...) | (...); storage_asset_transform: (...) | (...) | (...); storage_default_folder: (...) | (...) | (...) }, "directus_settings" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { 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: ... }>>, FieldsWildcard<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 (...) ? (...) : (...)>>, 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>

Defined in: rest/commands/read/settings.ts:19

Retrieve Settings.

Type Parameters ​

• Schema

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

Parameters ​

query? ​

TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { auth_login_attempts: number; auth_password_policy: (...) | (...); basemaps: (...) | (...); custom_aspect_ratios: (...) | (...); custom_css: (...) | (...); default_language: string; id: 1; mapbox_key: (...) | (...); module_bar: (...) | (...); project_color: (...) | (...); project_descriptor: (...) | (...); project_logo: (...) | (...); project_name: string; project_url: string; public_background: (...) | (...); public_foreground: (...) | (...); public_note: (...) | (...); report_bug_url: (...) | (...); report_error_url: (...) | (...); report_feature_url: (...) | (...); storage_asset_presets: (...) | (...); storage_asset_transform: (...) | (...) | (...); storage_default_folder: (...) | (...) | (...) }, "directus_settings" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { 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 FF ? MapFlatFields<UnpackList<IfAny<Schema, { auth_login_attempts: number; auth_password_policy: (...) | (...); basemaps: (...) | (...); custom_aspect_ratios: (...) | (...); custom_css: (...) | (...); default_language: string; id: 1; mapbox_key: (...) | (...); module_bar: (...) | (...); project_color: (...) | (...); project_descriptor: (...) | (...); project_logo: (...) | (...); project_name: string; project_url: string; public_background: (...) | (...); public_foreground: (...) | (...); public_note: (...) | (...); report_bug_url: (...) | (...); report_error_url: (...) | (...); report_feature_url: (...) | (...); storage_asset_presets: (...) | (...); storage_asset_transform: (...) | (...) | (...); storage_default_folder: (...) | (...) | (...) }, "directus_settings" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { 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: ... }>>, FieldsWildcard<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 (...) ? (...) : (...)>>, 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 settings object.