Skip to content

获取配置数据 - useSettings

获取 settings 的 hooks 方法,保证在小程序生命周期内只发送一次请求

基本用法

使用 useSettings 传入一个或多个 key 即可,可通过 isLoading 观察数据是否已返回。

js
// 获取单条记录
const {
  data: [settingsValue],
  isLoading,
} = useSettings('settingsKey')

// 获取多条记录
const {
  data: [settingsValue1, settingsValue2, settingsValue3],
  isLoading,
} = useSettings(['settingsKey1', 'settingsKey2', 'settingsKey3'])

watchEffect(() => {
  // 使用数据
  console.log(settingsValue.value, settingsValue2.value)
})

WARNING

useSettings 返回的 data 仅会解析数据表内的 .json.value 内容。如果你没有成功获取数据,请确保 settings 表中的记录数据符合相应的规范。

默认情况下,useSettings只会获取前 200 条数据,这对于大多数项目通常足够。如果你的项目需要处理更多的数据,那时再考虑如何兼容这种情况。

自定义表名

默认 settings 的表名为 settings,如果需要自定义表名,可通过传入 tableName 修改:

js
const {
  data: [settingsValue1],
  isLoading,
} = useSettings(settingsKey1, {
  tableName: 'act123_settings',
})

相关文档