FluxbaseSettings

Settings Manager

Provides access to system-level, application-level, and email settings. AppSettingsManager handles both structured framework settings and custom key-value settings. EmailSettingsManager provides direct access to email provider configuration.

Example

const settings = client.admin.settings

// Access system settings
const systemSettings = await settings.system.list()

// Access app settings (structured)
const appSettings = await settings.app.get()
await settings.app.enableSignup()

// Access custom settings (key-value)
await settings.app.setSetting('billing.tiers', { free: 1000, pro: 10000 })
const tiers = await settings.app.getSetting('billing.tiers')

// Access email settings
const emailSettings = await settings.email.get()
await settings.email.update({ provider: 'sendgrid', sendgrid_api_key: 'SG.xxx' })
await settings.email.test('admin@yourapp.com')

Constructors

new FluxbaseSettings()

new FluxbaseSettings(fetch): FluxbaseSettings

Parameters

Parameter	Type
fetch	FluxbaseFetch

Returns

FluxbaseSettings

Properties

Property	Modifier	Type
app	public	AppSettingsManager
email	public	EmailSettingsManager
system	public	SystemSettingsManager