{"id":33001920,"url":"https://github.com/SHERlocked93/wx-updata","last_synced_at":"2025-11-16T07:00:49.165Z","repository":{"id":50447242,"uuid":"281412226","full_name":"SHERlocked93/wx-updata","owner":"SHERlocked93","description":"官方 setData 最佳替代品 ✈️","archived":false,"fork":false,"pushed_at":"2020-11-24T08:54:52.000Z","size":166,"stargazers_count":66,"open_issues_count":1,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-10-03T05:44:39.173Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SHERlocked93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-21T13:56:29.000Z","updated_at":"2025-08-28T07:08:14.000Z","dependencies_parsed_at":"2022-09-05T15:30:25.569Z","dependency_job_id":null,"html_url":"https://github.com/SHERlocked93/wx-updata","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/SHERlocked93/wx-updata","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHERlocked93%2Fwx-updata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHERlocked93%2Fwx-updata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHERlocked93%2Fwx-updata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHERlocked93%2Fwx-updata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SHERlocked93","download_url":"https://codeload.github.com/SHERlocked93/wx-updata/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHERlocked93%2Fwx-updata/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":284672648,"owners_count":27044736,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-16T02:00:05.974Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-11-13T14:00:24.545Z","updated_at":"2025-11-16T07:00:49.156Z","avatar_url":"https://github.com/SHERlocked93.png","language":"JavaScript","funding_links":[],"categories":["组件"],"sub_categories":[],"readme":"# wx-updata\n\n微信小程序官方 setData 替代品 ✈️\n\n教程地址：[\u003c开发微信小程序，我为什么放弃 setData，使用 upData\u003e](https://juejin.im/post/5f17efb55188252e7811dcdd#comment)\n\n小程序代码片段预览地址： https://developers.weixin.qq.com/s/CcXdO1mc73jD\n\n小程序代码片段代码地址： https://github.com/SHERlocked93/wx-updata-demo\n\n[![npm](https://img.shields.io/npm/v/wx-updata.svg)](https://www.npmjs.com/package/wx-updata) [![npm](https://img.shields.io/npm/dt/wx-updata.svg)](https://www.npmjs.com/package/wx-updata)\n\n[![NPM](https://nodei.co/npm/wx-updata.png?compact=true)](https://nodei.co/npm/wx-updata/)\n\n## 优势\n\n- 支持 setData 对象自动合并，不用写蹩脚的对象路径了 🥳\n- 支持对象中嵌套数组，数组中嵌套对象；\n- 如果数组的某个值你不希望覆盖，请使用数组空位来跳过这个数组项，比如 `[1,,3]` 这个数组中间就是数组空位；\n- 如果数组空位你的 Eslint 报错，可以使用 wx-updata 提供的 Empty 来代替 `[1, Empty, 3]`\n- 如果数组空位你不习惯，或者不乐意数逗号个数，可以试试数组的对象路径方式 `[1,,3]` -\u003e `{'[0]': 1, '[2]': 3}`\n\n## 安装\n\n\u003e 你也可以直接把 `dist` 目录下的 `wx-updata.js` 拷贝到项目里使用\n\n\n```bash\n$ npm i -S wx-updata\n# or\n$ yarn add wx-updata\n```\n\n然后：\n\n1. 把微信开发者工具面板右侧的 `详情 - 本地设置 - 使用npm模块` 按钮打开；\n2. 点击微信开发者工具面板工具栏的 `工具 - 构建npm`；\n\n构建后成功生成 miniprogram_npm 文件夹就可以正常使用了\n\n## 引入\n\n### 方式一\n\n可以使用直接挂载到 Page 上的方式，这样就可以在 Page 实例中像使用 setData 一样使用 upData 了\n\n```javascript\n// app.js\nimport { updataInit } from './miniprogram_npm/wx-updata/index'  // 你的库文件路径\n\nApp({\n    onLaunch() {\n        Page = updataInit(Page, { debug: true })\n    }\n})\n```\n\n```javascript\n// 页面代码中\n\nthis.upData({\n    info: { height: 155 },\n    desc: [{ age: 13 }, '帅哥'],\n    family: [, , [, , , { color: '灰色' }]]\n})\n```\n\n### 方式二\n\n有的框架可能在 Page 对象上进行了进一步修改，所以直接替换 Page 的方式可能就不太好了，wx-updata 同样暴露了工具方法，用户可以在页面代码中直接使用工具方法进行处理：\n\n```javascript\n// 页面代码中\n\nimport { objToPath } from './miniprogram_npm/wx-updata/index'  // 你的库文件路径\n\nPage({\n    data: { a: { b: 2}, c: [3,4,5]},\n\n    // 自己封装一下\n    upData(data) {\n        return this.setData(objToPath(data))\n    },\n\n    // 你的方法中或生命周期函数\n    yourMethod() {\n        this.upData({ a: { b: 7}, c: [8,,9]})\n    }\n})\n```\n\n## API\n\n###  `Page.prototype.upData(Object data, Function callback)`\n\n1. `data`： 你希望设置的 data\n2. `callback`： 跟 [setData](https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#Page.prototype.setData(Object%20data,%20Function%20callback)) 第二个参数一样，引起界面更新渲染完毕后的回调函数\n\n### `updataInit(Page, config)`\n\n1. `Page`： 页面对象，需要在 `app.js` 中调用；\n2. `config` 配置\n   - 配置参数 `{ debug: true }`，会将路径化后的 data 打印出来，帮助用户进行调试，默认 false 不开启；\n   - 配置参数 `{ arrObjPath: true }`，会开启数组的对象路径方式功能，默认 false 不开启；\n   - 配置参数 `{ arrCover: true }`，数组会直接覆盖，而不会只修改数组的某几项，默认 false 不开启（设置 true，arrObjPath 会失效）；\n\n### `objToPath(Object data, Object config)`\n\n1. `data`： 你希望设置的 data 对象\n2. `config` 配置\n   - 配置参数 `{ arrObjPath: true }`，会开启数组的对象路径方式功能，默认 false 不开启；\n   - 配置参数 `{ arrCover: true }`，数组会直接覆盖，而不会只修改数组的某几项，默认 false 不开启（设置 true，arrObjPath 会失效）；\n\n## 使用\n\n### 使用 Empty 代替数组空位\n\n```javascript\n// 页面代码中\nimport { Empty } from './miniprogram_npm/wx-updata/index'\n\nthis.upData({\n    info: { height: 155 },\n    desc: [{ age: 13 }, '帅哥'],\n    family: [Empty, Empty, [Empty, Empty, Empty, { color: '灰色' }]]\n})\n```\n### 使用数组路径方式\n\n如果数组空位你不习惯，或者不乐意数逗号个数，可以试试数组的对象路径方式，需要传递 config 的配置 `{arrObjPath: true}`\n\n```javascript\n// 页面代码中\nimport { Empty } from './miniprogram_npm/wx-updata/index'\n\n// 原来的方式\nthis.upData({\n    info: { height: 155 },\n    desc: [, '靓仔'],\n    family: [, , [, , , { color: '灰色' }]]\n})\n\n// 使用数组路径方式\nthis.upData({\n    info: { height: 155 },\n    desc: {'[1]': '靓仔'},\n    family: { '[2]': { '[3]': { color: '灰色' }\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSHERlocked93%2Fwx-updata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSHERlocked93%2Fwx-updata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSHERlocked93%2Fwx-updata/lists"}