{"id":22432530,"url":"https://github.com/zhusiqing/interface_bridge","last_synced_at":"2025-03-27T07:42:27.736Z","repository":{"id":37406636,"uuid":"504087861","full_name":"zhusiqing/interface_bridge","owner":"zhusiqing","description":"接口字段适配器","archived":false,"fork":false,"pushed_at":"2023-12-14T07:19:31.000Z","size":248,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-03-15T09:22:24.166Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/zhusiqing.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-16T09:12:05.000Z","updated_at":"2024-02-04T07:24:31.000Z","dependencies_parsed_at":"2024-12-05T22:12:09.640Z","dependency_job_id":"0864dcd5-3080-4912-90a8-b51bbcd4c802","html_url":"https://github.com/zhusiqing/interface_bridge","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Finterface_bridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Finterface_bridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Finterface_bridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Finterface_bridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhusiqing","download_url":"https://codeload.github.com/zhusiqing/interface_bridge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245806023,"owners_count":20675291,"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","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":"2024-12-05T22:12:04.054Z","updated_at":"2025-03-27T07:42:27.719Z","avatar_url":"https://github.com/zhusiqing.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# interface-bridge\n\n字段适配器，解决前后端接口之间字段映射问题。\n\n## 安装\n\n```bash\n# npm\nnpm i interface-bridge\n# yarn\nyarn add interface-bridge\n# pnpm\npnpm add interface-bridge\n```\n\n## 用法\n\n```javascript\nimport InterfaceBridge from 'interface-bridge';\nconst map = {\n  frontendField: 'backendField',\n  left: 'right'\n}\n\nconst bridge = new InterfaceBridge(map, {\n  // 默认为false, 设置未true后将过滤掉非映射关系中的字段\n  isExact: false\n})\ninterface HandleDataType {\n  backendField: string;\n  right: number;\n}\nbridge.pickData\u003cHandleDataType\u003e({\n  frontendField: '123',\n  left: 321\n})\n/*\n{\n  backendField: \"123\"\n  right: 321\n}\n*/\n```\n\n## 配置参数\n\n#### options.isExact: boolean\n\n默认为false, 设置为true后将过滤掉非映射关系中的字段\n\n```javascript\nimport InterfaceBridge from 'interface-bridge';\nconst map = {\n  frontendField: 'backendField',\n  left: 'right'\n}\n\nconst bridge = new InterfaceBridge(map, {\n  // 默认为false, 设置未true后将过滤掉非映射关系中的字段\n  isExact: true\n})\ninterface HandleDataType {\n  backendField: string;\n  right: number;\n  test?: number\n}\nbridge.pickData\u003cHandleDataType\u003e({\n  frontendField: '123',\n  left: 321,\n  test: 123\n})\n/*\n{\n  backendField: \"123\",\n  right: 321\n}\n*/\nconst bridge = new InterfaceBridge(map, {\n  isExact: false\n})\nbridge.pickData\u003cHandleDataType\u003e({\n  frontendField: '123',\n  left: 321,\n  test: 123\n})\n/*\n{\n  backendField: \"123\",\n  right: 321,\n  test: 123\n}\n*/\n```\n\n## 方法\n\n#### omitData\\\u003cT\\\u003e(data, keys): T\n\n将前端的数据转换成后端要的数据\n\n|参数名|类型|必选|说明|\n|:---- |:--   |:---|:----- |\n|data |object| 是 | 第几页，默认 1 |\n|keys |string[]| 否 | 过滤掉的数据，注意是转换后的数据的key值 |\n\n\u003e 返回值: `object` 转换后的数据\n\n**示例**\n\n```javascript\nimport InterfaceBridge from 'interface-bridge';\nconst map = {\n  frontendField: 'backendField',\n  left: 'right',\n  abc: 'ABC'\n}\n\nconst bridge = new InterfaceBridge(map)\n\nbridge.omitData({\n  frontendField: '123',\n  left: 321\n})\n/*\n{\n  backendField: \"123\",\n  right: 321,\n  ABC: undefined\n}\n*/\nbridge.omitData({\n  frontendField: '123',\n  left: 321\n}, ['ABC'])\n/*\n{\n  backendField: \"123\",\n  right: 321\n}\n*/\n```\n\n#### omitReverseData\\\u003cT\\\u003e(data, keys): T\n\n将后端的数据转换成前端要的数据\n\n|参数名|类型|必选|说明|\n|:---- |:--   |:---|:----- |\n|data |object| 是 | 第几页，默认 1 |\n|keys |string[]| 否 | 过滤掉的数据，注意是转换后的数据的key值 |\n\n\u003e 返回值: `object` 转换后的数据\n\n**示例**\n\n```javascript\nimport InterfaceBridge from 'interface-bridge';\nconst map = {\n  frontendField: 'backendField',\n  left: 'right',\n  abc: 'ABC'\n}\n\nconst bridge = new InterfaceBridge(map)\n\nbridge.omitReverseData({\n  backendField: '123',\n  right: 321\n})\n/*\n{\n  frontendField: \"123\",\n  left: 321,\n  abc: undefined\n}\n*/\nbridge.omitReverseData({\n  backendField: '123',\n  right: 321\n}, ['abc'])\n/*\n{\n  frontendField: \"123\"\n  left: 321\n}\n*/\n```\n\n#### pickData\\\u003cT\\\u003e(data, keys): T\n\n将前端的数据转换成后端要的数据\n\n|参数名|类型|必选|说明|\n|:---- |:--   |:---|:----- |\n|data |object| 是 | 第几页，默认 1 |\n|keys |string[]| 否 | 需要的数据，注意是转换后的数据的key值 |\n\n\u003e 返回值: `object` 转换后的数据\n\n**示例**\n\n```javascript\nimport InterfaceBridge from 'interface-bridge';\nconst map = {\n  frontendField: 'backendField',\n  left: 'right',\n  abc: 'ABC'\n}\n\nconst bridge = new InterfaceBridge(map)\n\nbridge.pickData({\n  frontendField: '123',\n  left: 321\n})\n/*\n{\n  ABC: undefined,\n  backendField: \"123\",\n  right: 321\n}\n*/\nbridge.pickData({\n  frontendField: '123',\n  left: 321\n}, ['backendField'])\n/*\n{\n  backendField: \"123\"\n}\n*/\n```\n\n#### pickReverseData\\\u003cT\\\u003e(data, keys): T\n\n将后端的数据转换成前端要的数据\n\n|参数名|类型|必选|说明|\n|:---- |:--   |:---|:----- |\n|data |object| 是 | 第几页，默认 1 |\n|keys |string[]| 否 | 需要的数据，注意是转换后的数据的key值 |\n\n\u003e 返回值: `object` 转换后的数据\n\n**示例**\n\n```javascript\nimport InterfaceBridge from 'interface-bridge';\nconst map = {\n  frontendField: 'backendField',\n  left: 'right',\n  abc: 'ABC'\n}\n\nconst bridge = new InterfaceBridge(map)\n\nbridge.pickReverseData({\n  backendField: '123',\n  right: 321\n})\n/*\n{\n  abc: undefined,\n  frontendField: \"123\",\n  left: 321\n}\n*/\nbridge.omitReverseData({\n  backendField: '123',\n  right: 321\n}, ['frontendField'])\n/*\n{\n  frontendField: \"123\"\n}\n*/\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhusiqing%2Finterface_bridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhusiqing%2Finterface_bridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhusiqing%2Finterface_bridge/lists"}