SystemSettingsManager

System Settings Manager

Manages low-level system settings with key-value storage. For application-level settings, use AppSettingsManager instead.

Example

const settings = client.admin.settings.system

// List all system settings
const { settings } = await settings.list()

// Get specific setting
const setting = await settings.get('app.auth.enable_signup')

// Update setting
await settings.update('app.auth.enable_signup', {
  value: { value: true },
  description: 'Enable user signup'
})

// Delete setting
await settings.delete('app.auth.enable_signup')

Constructors

new SystemSettingsManager()

new SystemSettingsManager(fetch): SystemSettingsManager

Parameters

Parameter	Type
fetch	FluxbaseFetch

Returns

SystemSettingsManager

Methods

delete()

delete(key): Promise<void>

Delete a system setting

Parameters

Parameter	Type	Description
key	string	Setting key to delete

Returns

Promise<void>

Promise

Example

await client.admin.settings.system.delete('app.auth.enable_signup')

---

get()

get(key): Promise<SystemSetting>

Get a specific system setting by key

Parameters

Parameter	Type	Description
key	string	Setting key (e.g., ‘app.auth.enable_signup’)

Returns

Promise<SystemSetting>

Promise resolving to SystemSetting

Example

const setting = await client.admin.settings.system.get('app.auth.enable_signup')
console.log(setting.value)

---

list()

list(): Promise<ListSystemSettingsResponse>

List all system settings

Returns

Promise<ListSystemSettingsResponse>

Promise resolving to ListSystemSettingsResponse

Example

const response = await client.admin.settings.system.list()
console.log(response.settings)

---

update()

update(key, request): Promise<SystemSetting>

Update or create a system setting

Parameters

Parameter	Type	Description
key	string	Setting key
request	UpdateSystemSettingRequest	Update request with value and optional description

Returns

Promise<SystemSetting>

Promise resolving to SystemSetting

Example

const updated = await client.admin.settings.system.update('app.auth.enable_signup', {
  value: { value: true },
  description: 'Enable user signup'
})