Skip to main content

Read All Settings from a Domain (xui.read)

Declaration​

settings = xui.read(domain)

Parameters​

  • domain
    String. The defaults domain identifier used by the config UI.

Returns​

  • settings
    Table. All key-value pairs under the specified domain. Returns an empty table if the domain does not exist.

Description​

This function is used to optimize reading multiple settings at once.
It does not validate value types. If you need to ensure value types are valid, call xui.setup first to validate/correct, then read.
See the config UI standard: XUI

Examples​

xui.setup('interface.xui')
local dict = xui.read('com.yourcompany.A-Script-Bundle')
local enabled = dict['enabled']