# 同步模型定义

为了提高开发者的代码编写体验，可以将用户的云端数据模型同步为本地的类型定义文件，享受代码编辑器的智能类型提示和检查功能。同步后效果如下：

数据模型智能提示

字段智能提示

# 同步流程

选择以下任一方式同步数据模型定义：

注意：

1. 对于微信小程序，需要在 app.json 文件同目录下运行命令
2. 对于微信云开发的云函数，需要在 cloudfunctions/<functions folder> 目录下运行命令
3. 首次运行需要指定环境 ID 参数 --envId=<envId>，以后就不需再指定
4. 运行 tcb 需要登录，使用微信云开发的，请在登录时选择【小程序公众号】的登录方式
   

# 方式一：以 npx 直接运行 tcb 命令

首先先进入项目目录中，目录位置参考注意事项

npx --package=@cloudbase/cli@2.5.1-alpha.5 tcb model sync-dts --envId=<envId>

# 方式二：安装 tcb 命令行工具

npm i @cloudbase/cli@2.5.1-alpha.5 -g

然后进入到项目目录中，目录位置参考注意事项，例如 cd path/to/your/project

tcb model sync-dts --envId=<envId>

# 常见问题与解决

# 问题：代码编辑器无模型提示

1. 确保 @cloudbase/wx-cloud-client-sdk 模块已正确安装。
2. 确保 tsconfig.json 文件配置正确：

{
  "compilerOptions": {
    "allowJs": true
  }
}