Home > SYS_Storage > setExtensionAllUserConfigs

SYS_Storage.setExtensionAllUserConfigs() method

Set all user configurations of the extension

Signature

function setExtensionAllUserConfigs(configs: Record<string, any>): Promise<boolean>;

Parameters

Parameter	Type	Description
configs	Record<string, any>	All user configurations of the extension

Returns

Promise<boolean>

Whether the operation is successful

Remarks

This will overwrite all user configuration information of the current extension. Please operate with caution

Note: This API is only valid for extensions. Calling it in a standalone script environment will always throw Error

Example

// 1. 备份当前全部配置（整体覆盖前必做）
const backup = eda.sys_Storage.getExtensionAllUserConfigs();

// 2. 整体写入一份新配置，原有配置被覆盖
const ok = await eda.sys_Storage.setExtensionAllUserConfigs({
	嘉立创示例_单位: 'mil',
	嘉立创示例_检查更新: true,
});

// 3. 把备份的原配置写回，还原存储现场
const restored = await eda.sys_Storage.setExtensionAllUserConfigs(backup);

console.log('整体写入结果：', ok);
console.log('恢复备份结果：', restored);
console.log('备份配置条数：', Object.keys(backup).length);