init: 项目初始提交 - NeoZQYY Monorepo 完整代码
This commit is contained in:
3
apps/miniprogram/.cursorindexingignore
Normal file
3
apps/miniprogram/.cursorindexingignore
Normal file
@@ -0,0 +1,3 @@
|
||||
|
||||
# Don't index SpecStory auto-save files, but allow explicit context inclusion via @ references
|
||||
.specstory/**
|
||||
2
apps/miniprogram/.gitignore
vendored
Normal file
2
apps/miniprogram/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
node_modules
|
||||
miniprogram_npm
|
||||
0
apps/miniprogram/.gitkeep
Normal file
0
apps/miniprogram/.gitkeep
Normal file
57
apps/miniprogram/README.md
Normal file
57
apps/miniprogram/README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# 小程序前端(miniprogram)
|
||||
|
||||
微信小程序前端项目,基于 **Donut 多端框架 + TDesign 组件库** 技术栈,为台球门店会员提供移动端服务入口。
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **框架**:微信小程序原生 + Donut 多端(`projectArchitecture: multiPlatform`)
|
||||
- **UI 组件**:TDesign 小程序版(`tdesign-miniprogram ^1.12.2`)
|
||||
- **语言**:TypeScript
|
||||
- **类型定义**:`miniprogram-api-typings`
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
apps/miniprogram/
|
||||
├── miniprogram/ # 小程序主体代码
|
||||
│ ├── app.ts # 应用入口
|
||||
│ ├── app.json # 全局配置(页面路由、窗口、TabBar 等)
|
||||
│ ├── app.wxss # 全局样式
|
||||
│ ├── pages/ # 页面目录
|
||||
│ │ ├── index/ # 首页
|
||||
│ │ └── logs/ # 日志页
|
||||
│ ├── miniprogram_npm/ # 构建后的 npm 包(TDesign 组件)
|
||||
│ ├── i18n/ # 国际化资源
|
||||
│ ├── miniapp/ # Donut 多端原生资源
|
||||
│ └── utils/ # 工具函数
|
||||
├── miniapp/ # 顶层 Donut 原生资源
|
||||
├── typings/ # TypeScript 类型定义
|
||||
├── doc/ # 项目文档(PRD 等)
|
||||
├── i18n/ # 顶层国际化资源
|
||||
├── reports/ # 报表输出
|
||||
├── project.config.json # 微信开发者工具项目配置
|
||||
├── project.miniapp.json # Donut 多端配置
|
||||
├── tsconfig.json # TypeScript 编译配置
|
||||
├── package.json # npm 依赖声明
|
||||
└── README.md # 本文件
|
||||
```
|
||||
|
||||
## 开发指南
|
||||
|
||||
1. 使用 **微信开发者工具** 打开本目录(`apps/miniprogram/`)
|
||||
2. 首次打开后,在工具中执行"构建 npm"以生成 `miniprogram_npm/`
|
||||
3. AppID:`wx7c07793d82732921`
|
||||
|
||||
## 与 Monorepo 的关系
|
||||
|
||||
- 本项目为独立前端工程,不参与 Python uv workspace
|
||||
- H5 原型设计稿位于 `docs/h5_ui/`(从原 `Prototype/` 目录迁移)
|
||||
- 未来将通过 FastAPI 后端(`apps/backend/`)与 ETL 数据层交互
|
||||
|
||||
## Roadmap
|
||||
|
||||
- [ ] 接入 FastAPI 后端 API,替换当前静态/模拟数据
|
||||
- [ ] TDesign 组件库升级至最新版本
|
||||
- [ ] 完善页面路由与业务功能(会员中心、助教预约、订单查询等)
|
||||
- [ ] 集成 CI/CD(代码检查、自动上传体验版)
|
||||
- [ ] 多门店支持(基于 `site_id` 的数据隔离)
|
||||
997
apps/miniprogram/doc/prd.md
Normal file
997
apps/miniprogram/doc/prd.md
Normal file
@@ -0,0 +1,997 @@
|
||||
|
||||
|
||||
# 一、文档信息
|
||||
|
||||
* 产品名称:球房运营助手(微信小程序)
|
||||
* 版本:V1.0(原型版,全权限视角)
|
||||
* 撰写日期:YYYY-MM-DD
|
||||
* 适用平台:微信小程序(iOS / Android 手机竖屏)
|
||||
* 文档范围:仅描述小程序前端界面与交互行为,不包含后端服务和接口字段定义。
|
||||
|
||||
---
|
||||
|
||||
# 二、背景与目标
|
||||
|
||||
本小程序用于提升台球厅经营管理效率,为店长、助教管理、助教等内部人员提供任务管理、业绩查看、运营看板和智能助手对话能力。
|
||||
|
||||
当前阶段目标:
|
||||
|
||||
* 交付一套基于“全功能、全权限角色视角”的微信小程序前端原型。
|
||||
* 明确各页面布局、组件及交互行为,便于前端和原型工具直接实现。
|
||||
* 角色权限控制、数据口径、字段来源均由后端与后续迭代处理,原型仅展示有权限时的页面样式。
|
||||
|
||||
---
|
||||
|
||||
# 三、范围与约束说明
|
||||
|
||||
1. **设备与环境**
|
||||
|
||||
* 仅面向手机端微信小程序(iOS / Android),竖屏使用。
|
||||
* 暂不考虑 iPad 等大屏适配。
|
||||
|
||||
2. **门店范围**
|
||||
|
||||
* 当前仅支持一个店铺场景,后端如扩展多门店,在后续版本处理。
|
||||
|
||||
3. **权限与角色**
|
||||
|
||||
* 原型以“全功能视角”展示所有模块与入口。
|
||||
* 实际上线时,不同角色(店长/管理层/助教管理/助教)的权限由后端接口控制,对无权限功能采取“入口隐藏”的方式。
|
||||
* 原型中不绘制模块级“无权限访问”占位状态。
|
||||
|
||||
4. **接口与数据**
|
||||
|
||||
* 本文不描述具体接口、字段名、数据结构。
|
||||
* 各类展示字段以接口实际返回为准,本文若举例字段,仅为示意,不代表完整字段列表。
|
||||
|
||||
5. **登录/申请流程的权限提示**
|
||||
|
||||
* 登录后如账号未通过审核或无访问权限,将展示对应状态页(审核中、无权限),这属于整体访问控制,不属于“模块权限占位”,在原型中需要体现。
|
||||
|
||||
---
|
||||
|
||||
# 四、角色说明(仅用于理解,不做权限逻辑)
|
||||
|
||||
* 店长 / 公司管理层:实际场景中拥有全功能权限。
|
||||
* 助教管理:看板中财务板块不可见(上线时通过隐藏入口实现)。
|
||||
* 助教:看板中财务板块和助教板块不可见(上线时通过隐藏入口实现)。
|
||||
|
||||
原型中统一以“全功能视角”展示,不做差异。
|
||||
|
||||
---
|
||||
|
||||
# 五、全局设计规范
|
||||
|
||||
## 5.1 语言与格式
|
||||
|
||||
* 语言:简体中文。
|
||||
* 金额单位:
|
||||
|
||||
* 元:取整,不显示小数。
|
||||
* 万元:保留两位小数。
|
||||
* 时间显示格式:
|
||||
|
||||
* 标准格式:`YYYY-MM-DD HH:mm:ss`
|
||||
* 在不影响理解情况下,可根据页面需要简化为 `YYYY-MM-DD` 或 `MM-DD HH:mm` 等,具体由设计与前端协商。
|
||||
|
||||
## 5.2 导航与返回规则
|
||||
|
||||
* 底部一级导航(TabBar):
|
||||
|
||||
* Tab 顺序:任务 / 看板 / 我的
|
||||
* 文字:`任务`、`看板`、`我的`
|
||||
* 每个 Tab 对应一个一级页面,点击 Tab 时:
|
||||
|
||||
* 若当前已在该 Tab 内的子页面,点击 Tab 返回该 Tab 的根页面,并滚动至顶部。
|
||||
* 顶部导航:
|
||||
|
||||
* 除特别说明外,二级/详情页隐藏微信原生导航栏,使用自定义头部,左上角为返回图标,行为为返回上一页面。
|
||||
* 弹窗与浮层:
|
||||
|
||||
* 使用标准底部弹出或中部弹窗,与微信交互习惯一致。
|
||||
|
||||
## 5.3 悬浮助手按钮
|
||||
|
||||
* 悬浮按钮在所有业务页面(任务、看板、我的及其子页面)显示,不在“登录/申请/审核中/无权限”页面显示。
|
||||
* 默认位置:页面右下角(不遮挡底部 TabBar),随页面滚动悬浮。
|
||||
* 点击行为:进入“助手对话页面”,默认打开最近一次会话(若有)。
|
||||
|
||||
## 5.4 提示、错误与加载状态
|
||||
|
||||
* **网络异常 / 接口错误(列表/卡片区域)**
|
||||
|
||||
* 在对应数据区域显示文字:`加载失败,请点击重试`
|
||||
* 下方提供“重试”按钮,点击重新请求该区域数据。
|
||||
* 作为所有列表/卡片区域的统一错误样式。
|
||||
|
||||
* **空数据状态**
|
||||
|
||||
* 统一使用简单文字:
|
||||
|
||||
* 列表类统一为:`暂无数据` 或根据场景显示 `暂无任务` 等。
|
||||
* 不使用插画或占位图。
|
||||
|
||||
* **加载状态**
|
||||
|
||||
* 使用区域加载:在列表或卡片区域显示文字:`加载中...`
|
||||
* 不做骨架屏和复杂动画。
|
||||
|
||||
---
|
||||
|
||||
# 六、信息架构与页面列表
|
||||
|
||||
## 6.1 顶层结构
|
||||
|
||||
* 登录相关
|
||||
|
||||
* 登录页
|
||||
* 账号申请页
|
||||
* 审核中页
|
||||
* 无权限页
|
||||
* Tab 1:任务
|
||||
|
||||
* 任务列表页(默认首页)
|
||||
* 任务详情页
|
||||
* 业绩详情页
|
||||
* Tab 2:看板
|
||||
|
||||
* 看板首页(含:财务 / 客户 / 助教 三级视图)
|
||||
* 客户详情页
|
||||
* 助教详情页
|
||||
* Tab 3:我的
|
||||
|
||||
* 我的首页
|
||||
* 备注记录页
|
||||
* 助手对话记录页
|
||||
* 首页设置页
|
||||
* 退出账号(确认弹窗)
|
||||
* 全局
|
||||
|
||||
* 助手对话页
|
||||
|
||||
---
|
||||
|
||||
# 七、关键流程说明
|
||||
|
||||
## 7.1 登录与申请流程
|
||||
|
||||
1. 用户打开小程序 → 登录页。
|
||||
2. 点击“使用微信登录”,完成微信授权。
|
||||
3. 登录后:
|
||||
|
||||
* 若查无此用户,也无此用户提交过申请 → 进入账号申请页。
|
||||
* 若查到该用户提交过申请,状态为“审核中” → 进入“审核中”状态页。
|
||||
* 若查到该用户提交过申请,状态为“拒绝/未通过” → 进入“无权限”状态页。
|
||||
* 若查到该用户申请已通过 → 跳转至用户设置的默认首页(初始为“任务”页)。
|
||||
|
||||
## 7.2 默认首页配置流程
|
||||
|
||||
* 初始默认首页为“任务”。
|
||||
* 用户可在“我的 → 首页设置”中将首页设置为:任务 / 看板。
|
||||
* 设置为“切换即保存”,与账号绑定(不因退出登录而重置)。
|
||||
|
||||
---
|
||||
|
||||
# 八、页面级需求
|
||||
|
||||
以下各页面按【页面名称 / 入口 / 布局结构 / 功能与交互 / 状态】描述。
|
||||
|
||||
---
|
||||
|
||||
## 8.1 登录与访问控制相关
|
||||
|
||||
### 8.1.1 登录页
|
||||
|
||||
**入口**
|
||||
|
||||
* 小程序启动未登录状态。
|
||||
|
||||
**布局结构**
|
||||
|
||||
* 顶部:App Logo 占位 + 应用名称(球房运营助手)。
|
||||
* 中部:一句产品描述文案,例如:
|
||||
|
||||
* `为台球厅提升运营效率的内部管理工具`
|
||||
* 底部区域:
|
||||
|
||||
* 主按钮:`使用微信登录`(微信授权登录入口)。
|
||||
* 下方文案 + 勾选框:
|
||||
|
||||
* 复选框 + 文案:`我已阅读并同意《用户协议》和《隐私政策》`
|
||||
* 协议名称为可点击文本(具体跳转页面可后续补充)。
|
||||
|
||||
**功能与交互**
|
||||
|
||||
* 用户必须勾选协议复选框才能点击“使用微信登录”,否则按钮为禁用态。
|
||||
* 点击“使用微信登录”调用微信授权流程,登录成功后进入流程 7.1 所述分支。
|
||||
* 登录失败时,在底部弹出错误提示(Toast),重试留在本页。
|
||||
|
||||
---
|
||||
|
||||
### 8.1.2 账号申请页
|
||||
|
||||
**入口**
|
||||
|
||||
* 登录成功后,系统查无该用户及其申请记录时。
|
||||
|
||||
**布局结构**
|
||||
|
||||
* 顶部:标题 `申请访问权限`。
|
||||
* 主体:
|
||||
|
||||
* 文本说明:简单说明需要申请原因,例如:
|
||||
|
||||
* `请填写申请说明,审核通过后即可使用小程序功能。`
|
||||
* 表单区:
|
||||
|
||||
* 字段 1:
|
||||
|
||||
* 标签:`申请说明`,带红色星号(必填)。
|
||||
* 多行文本输入框,用于填写自我介绍、岗位、所属门店等说明(具体内容由用户自由填写)。
|
||||
* 底部:
|
||||
|
||||
* 主按钮:`提交申请`
|
||||
|
||||
**功能与交互**
|
||||
|
||||
* “申请说明”为必填,如为空则点击“提交申请”时在输入框下方显示错误提示:`申请说明不能为空`。
|
||||
* 提交成功后,进入“审核中”页。
|
||||
* 接口错误时,弹出错误提示,停留在本页。
|
||||
|
||||
---
|
||||
|
||||
### 8.1.3 审核中页
|
||||
|
||||
**入口**
|
||||
|
||||
* 登录后发现该用户有申请记录,状态为“审核中”。
|
||||
|
||||
**布局结构**
|
||||
|
||||
* 居中展示:
|
||||
|
||||
* 图标(等待/审核中占位图标)。
|
||||
* 标题文案:`申请审核中`
|
||||
* 说明文案:例如:`您的访问申请正在审核中,请稍后再试或联系管理员。`
|
||||
* 不提供其他操作按钮,保持不可操作状态。
|
||||
|
||||
**功能与交互**
|
||||
|
||||
* 用户可关闭小程序或退出;再次进入时仍按登录逻辑判断状态。
|
||||
|
||||
---
|
||||
|
||||
### 8.1.4 无权限页
|
||||
|
||||
**入口**
|
||||
|
||||
* 登录后发现该用户申请状态为“拒绝/未通过”,或无访问权限。
|
||||
|
||||
**布局结构**
|
||||
|
||||
* 居中展示:
|
||||
|
||||
* 图标(禁止/无权限占位图标)。
|
||||
* 标题文案:`无访问权限`
|
||||
* 说明文案:例如:`您的访问申请未通过,或当前账号无访问权限。如需使用,请联系管理员。`
|
||||
* 不提供操作按钮,不可操作状态。
|
||||
|
||||
**功能与交互**
|
||||
|
||||
* 用户可关闭小程序或退出;如后续权限变更,再次登录时可进入首页。
|
||||
|
||||
---
|
||||
|
||||
## 8.2 Tab:任务
|
||||
|
||||
### 8.2.1 任务列表页(默认首页)
|
||||
|
||||
**入口**
|
||||
|
||||
* 底部 TabBar 点击“任务”。
|
||||
* 登录通过后,如未设置其他默认首页,则默认进入本页。
|
||||
|
||||
**整体布局**
|
||||
|
||||
* 顶部:自定义导航栏(标题:`任务`),左侧无返回按钮。
|
||||
* Banner 区:当前用户信息与业绩概览。
|
||||
* 任务列表:按紧急程度排序的任务列表。
|
||||
* 悬浮助手按钮:右下角。
|
||||
|
||||
**Banner 区内容**
|
||||
|
||||
* 展示内容示例:
|
||||
|
||||
* 第一行:`用户名` + `身份`(例如:张三 / 助教)
|
||||
* 第二行:一句聚合文案,例如:
|
||||
`本月目标 5 万,已完成 3 万,任务 50 个,完成进度 60%`
|
||||
* 第三行:`X 月预计收入:12345 元`(单位为元,取整)
|
||||
* Banner 整块区域可点击,跳转至“业绩详情页”。
|
||||
|
||||
**任务列表结构**
|
||||
|
||||
* 列表为单列列表,不按任务类型分组,仅通过排序和颜色区分。
|
||||
* 排序规则:按紧急程度从高到低排序,类型依次为:
|
||||
|
||||
* 高优先召回(红)
|
||||
* 优先召回(橙)
|
||||
* 关系构建(粉)
|
||||
* 客户回访(蓝)
|
||||
|
||||
**单条任务卡片布局**
|
||||
|
||||
* 第一行(标题行):
|
||||
|
||||
* 左侧:任务类型标签(带背景色的颜色块或 icon),颜色按类型区分(红/橙/粉/蓝)。
|
||||
* 紧随其后:客户姓名。
|
||||
* 右侧:`>` 箭头图标,提示可点击进入详情。
|
||||
* 第二行(补充行):
|
||||
|
||||
* 核心信息 + 召回说明,具体字段根据当前任务类型与接口返回内容展示,例如:最近到店时间、召回原因、优先级说明等。
|
||||
* 其他:
|
||||
|
||||
* 不提供搜索框和筛选组件,任务集合由接口控制。
|
||||
|
||||
**交互说明**
|
||||
|
||||
* 点击整条任务卡片:进入“任务详情页”。
|
||||
* 长按任务卡片:在长按位置上方弹出黑底浮层菜单,样式类似微信对话长按菜单,菜单项:
|
||||
|
||||
* `任务置底`
|
||||
* `问问助手`
|
||||
* `备注`
|
||||
* “任务置底”:前端仅调用接口,排序规则由后端控制;前端不单独维护生命周期状态。
|
||||
* “问问助手”:跳转至“助手对话页”,以该任务信息为引用,开启新对话主题。
|
||||
* “备注”:弹出底部浮层,输入备注内容并保存,备注按时间排序纳入“备注记录”。
|
||||
|
||||
**空状态**
|
||||
|
||||
* 当列表为空时,在列表区域居中显示文案:`暂无任务`。
|
||||
|
||||
---
|
||||
|
||||
### 8.2.2 任务详情页
|
||||
|
||||
**入口**
|
||||
|
||||
* 任务列表页点击某条任务。
|
||||
|
||||
**布局结构**
|
||||
|
||||
* 顶部:自定义导航栏
|
||||
|
||||
* 左:返回按钮 `<`
|
||||
* 中:标题,例如 `任务详情`
|
||||
* 主体内容区:
|
||||
|
||||
* 模块一:客户基本信息
|
||||
|
||||
* 示例字段:姓名、手机号、会员编号、性别、标签(如 VIP/新客)、所属门店等(以接口为准)。
|
||||
* 模块二:消费习惯
|
||||
|
||||
* 文本描述形式,例如:“偏好晚间 21:00 后到店,喜欢中式台球,平均消费 300 元/月”等。
|
||||
* 模块三:与我的关系
|
||||
|
||||
* 等级:很好 / 好 / 一般 / 较陌生
|
||||
* 每个等级附带一段文字说明(例如“最近 3 个月每周均有1次课程”等)。
|
||||
* 模块四:任务建议
|
||||
|
||||
* 纯文本内容,给出执行建议、沟通话术提示等。
|
||||
* 底部固定操作栏:
|
||||
|
||||
* 左按钮:`问问助手`
|
||||
* 右按钮:`备注`
|
||||
|
||||
**交互说明**
|
||||
|
||||
* `问问助手`:
|
||||
|
||||
* 跳转至助手对话页。
|
||||
* 以当前任务的关键信息(任务类型、客户名、任务说明等)作为引用内容,显示为灰底卡片,用户在其下输入文本发送。
|
||||
* 通过此入口固定新建一个新对话主题。
|
||||
* `备注`:
|
||||
|
||||
* 底部弹出浮层,包含备注输入框和“保存”按钮。
|
||||
* 保存后生成一条备注记录,类型标记为“任务备注”,记入“备注记录”,按照创建时间倒序展示。
|
||||
|
||||
---
|
||||
|
||||
### 8.2.3 业绩详情页
|
||||
|
||||
**入口**
|
||||
|
||||
* 任务列表页 Banner 区点击。
|
||||
|
||||
**布局结构**
|
||||
|
||||
* 顶部 Banner:
|
||||
|
||||
* 展示:用户名 + 身份 + 本月业绩进度 + 本月预计收入。
|
||||
* 示例:
|
||||
|
||||
* 第一行:`张三(助教)`
|
||||
* 第二行:`本月目标:5 万,已完成:3 万,任务:50 个,完成进度:60%`
|
||||
* 第三行:`本月预计收入:1.23 万元`
|
||||
* 下方内容区:多组指标,以两列卡片布局展示。
|
||||
|
||||
**指标分组示意**
|
||||
|
||||
* 分组一:`收入构成`
|
||||
* 分组二:`台球助教业绩`
|
||||
* 分组三:`充值业绩`
|
||||
* 分组四:`酒水业绩`
|
||||
|
||||
每组都有组标题一行,下面为两列卡片网格。
|
||||
|
||||
**单个指标卡片内容**
|
||||
|
||||
* 布局:
|
||||
|
||||
* 卡片内上下两行,可视为“名称行 + 数据行”。
|
||||
* 字段:
|
||||
|
||||
* 指标名称
|
||||
* 当前值
|
||||
* 目标值
|
||||
* 完成度(百分比)
|
||||
* 对齐与单位:
|
||||
|
||||
* 数值区居中对齐。
|
||||
* 单位规则:
|
||||
|
||||
* 元:整数,无小数。
|
||||
* 万元:保留 2 位小数。
|
||||
* 完成度:使用 `%`。
|
||||
|
||||
**交互**
|
||||
|
||||
* 页面整体可滚动。
|
||||
* 卡片本身无需额外交互(本期不跳转、不长按)。
|
||||
|
||||
**时间范围**
|
||||
|
||||
* 本页仅展示当前“本月”的业绩数据,不提供时间周期切换。
|
||||
|
||||
---
|
||||
|
||||
## 8.3 Tab:看板
|
||||
|
||||
### 8.3.1 看板首页(含财务/客户/助教)
|
||||
|
||||
**入口**
|
||||
|
||||
* 底部 TabBar 点击“看板”。
|
||||
|
||||
**顶部区域**
|
||||
|
||||
* 一级标签(顶部 Tab):
|
||||
|
||||
* `财务` / `客户` / `助教`
|
||||
* 默认选中:`财务`(原型中展示全功能视角)
|
||||
|
||||
**筛选区域**
|
||||
|
||||
* 位置:一级标签下方。
|
||||
* 展示方式:多标签筛选按钮,每个按钮点击后展开下拉菜单,交互类似外卖/点评类应用。
|
||||
* 联动规则:
|
||||
|
||||
* 更改任一筛选条件后,立即刷新当前视图数据(无需额外“确定”按钮)。
|
||||
* 不提供“重置筛选”按钮。
|
||||
|
||||
**滚动行为**
|
||||
|
||||
* 当用户向上滚动列表内容时,筛选区域保持吸顶显示。
|
||||
* 当用户向下快速滚动时,可自动收起/隐藏筛选区域,仅保留一级 Tab,增强可视区域。
|
||||
* 向上滚动时再次展示筛选区域。
|
||||
|
||||
---
|
||||
|
||||
### 8.3.2 看板 – 财务视图
|
||||
|
||||
**入口**
|
||||
|
||||
* 看板顶部 Tab 选择“财务”(默认)。
|
||||
|
||||
**筛选条件**
|
||||
|
||||
* 条件 1:时间月份
|
||||
|
||||
* 选项:
|
||||
|
||||
1. 本月(默认)
|
||||
2. 上个月
|
||||
3. 最近 3 个月
|
||||
4. 最近半年
|
||||
5. 本季度
|
||||
6. 上个季度
|
||||
7. 本周
|
||||
8. 上周
|
||||
9. 指定时间周期
|
||||
* 选择“指定时间周期”时:
|
||||
|
||||
* 打开日期区间选择组件,可选择开始日期与结束日期。
|
||||
* 最大跨度:366 天。
|
||||
* 当用户选择的时间跨度超过 366 天时,非模态提示:例如 `时间跨度不可超过 366 天`,并阻止该选择生效。
|
||||
|
||||
* 条件 2:区域
|
||||
|
||||
* 选项:
|
||||
|
||||
1. 全部(默认)
|
||||
2. 大厅(子级:A 区、B 区、C 区)
|
||||
3. 麻将房
|
||||
4. 团建房
|
||||
5. 具体房间台桌
|
||||
* 选择“具体房间台桌”时:
|
||||
|
||||
* 弹出选择弹窗,列表单选。
|
||||
* 列表按“大厅 / 麻将房 / 团建房”分组展示具体房间或台桌。
|
||||
* 如接口获取失败或为空,在弹窗中显示:`网络错误,请重试`,并提供“重试”入口。
|
||||
|
||||
**财务汇总行**
|
||||
|
||||
* 展示位置:筛选区域下方第一行。
|
||||
* 分为三列:
|
||||
|
||||
* 当前筛选条件下实际收入
|
||||
* 当前筛选条件下实际支出
|
||||
* 当前筛选条件下净利润
|
||||
* 显隐与“预计”字样:
|
||||
|
||||
* 某些筛选条件下不显示支出与净利润,由接口控制。
|
||||
* 某些时间维度(例如本月、本周等)可显示“预计”字样:`12345 元(预计)`,由接口在数据中标记。
|
||||
|
||||
**内容分区**
|
||||
|
||||
分为四个部分,依次:
|
||||
|
||||
1. 营业数据
|
||||
2. 收入构成
|
||||
3. 支出构成
|
||||
4. 利润构成
|
||||
|
||||
每一部分包含:
|
||||
|
||||
* 标题行:如 `营业数据`
|
||||
* 指标卡片区:每行 3 个卡片,自动换行。
|
||||
|
||||
**指标卡片结构**
|
||||
|
||||
* 每个卡片:
|
||||
|
||||
* 第一行(标题行):左侧图标(简单占位)、右侧为指标名称(例如“总流水”、“客单价”等)。
|
||||
* 第二行(详情行):文字 + 数值,或文字 / 数值单独展示:
|
||||
|
||||
* 例如:`本期:12345 元`,或 `毛利率:35%`。
|
||||
* 指标列表(示意,实际由接口控制):
|
||||
|
||||
* 营业数据:总流水、客单价、开台数、场次、平均停留时长等。
|
||||
* 收入构成:桌费、助教费、酒水、餐饮、包房费、其他。
|
||||
* 支出构成:房租、水电、人工、耗材、推广等。
|
||||
* 利润构成:毛利、净利、毛利率、净利率等。
|
||||
|
||||
**交互**
|
||||
|
||||
* 长按任意指标卡片:
|
||||
|
||||
* 启动助手对话,跳转至“助手对话页”,以该指标为引用内容(来源:财务看板 + 指标名 + 当前数值等),开启新对话主题。
|
||||
* 列表下拉刷新,重新拉取数据。
|
||||
|
||||
---
|
||||
|
||||
### 8.3.3 看板 – 客户视图
|
||||
|
||||
**入口**
|
||||
|
||||
* 看板顶部 Tab 选择“客户”。
|
||||
|
||||
**筛选条件**
|
||||
|
||||
* 条件 1:客户类型
|
||||
|
||||
* 最近到店:按最近到店时间由近到远。
|
||||
* 最应召回:按当天召回因子由高到低(默认)。
|
||||
* 最近充值:按充值时间由近到远。
|
||||
* 最高消费:最近 60 天到店消费金额由高到低(不含充值)。
|
||||
* 最高余额:按单个客户所有会员卡金额总计由高到低。
|
||||
* 最频繁:最近 60 天到店次数由多到少。
|
||||
* 潜力股:最近 60 天到店间隔有缩短趋势的客户。
|
||||
* 最专一:最近 60 天使用助教服务 ≥10 次,且 ≥8 次为同一助教,最近 2 次均为该助教。
|
||||
|
||||
* 条件 2:偏爱项目
|
||||
|
||||
* 不限(默认)
|
||||
* 中式/追分
|
||||
* 斯诺克
|
||||
* 麻将
|
||||
* 团建
|
||||
|
||||
**助教身份默认筛选(后台行为,前端不显式展示)**
|
||||
|
||||
* 当登录用户身份为“助教”时,后台默认增加过滤条件:仅显示最近 14 天内该助教提供过课程服务的客户。
|
||||
* 前端不提供取消或修改该条件的开关,也不在 UI 中单独标识。
|
||||
|
||||
**客户列表卡片布局**
|
||||
|
||||
* 第一行:
|
||||
|
||||
* 左侧:
|
||||
|
||||
* 客户名称
|
||||
* 等级标(如等级图标或字母 A/B/C)
|
||||
* VIP 标识(如“VIP”标签),有则显示。
|
||||
* 右侧:最喜欢的助教列表,文字形式展示,例如:
|
||||
|
||||
* `💖 助教A、💖 助教B、💛 助教C...`
|
||||
* 最多展示前三,超过则以省略号表示。
|
||||
|
||||
* 第二行:
|
||||
|
||||
* 当前排序条件对应的核心指标(如召回因子、储值金额、累计消费等)。
|
||||
* 最近到店时间(副文案)。
|
||||
* 可在末尾增加一句简短说明,例如:`最近 30 天到店 5 次` 等。
|
||||
|
||||
**其他字段**
|
||||
|
||||
* 在“最高余额”等维度时,应显示该客户当前余额字段(由接口提供),格式按金额规则显示。
|
||||
|
||||
**交互**
|
||||
|
||||
* 点击客户卡片:进入“客户详情页”。
|
||||
* 长按客户卡片(可选):可考虑后续扩展为快速备注或助手入口,本期可不实现。
|
||||
|
||||
---
|
||||
|
||||
### 8.3.4 客户详情页
|
||||
|
||||
**入口**
|
||||
|
||||
* 看板 – 客户视图列表点击某客户。
|
||||
|
||||
**布局**
|
||||
|
||||
* 顶部导航:标题 `客户详情`,左侧返回按钮。
|
||||
* 模块一:客户基本信息
|
||||
|
||||
* 示例字段:姓名、手机号、会员编号、性别、等级、VIP 标识、所属门店等。
|
||||
* 手机号可支持点击拨号(后续实现时决定)。
|
||||
* 模块二:消费习惯
|
||||
|
||||
* 标签 + 文本说明的形式:
|
||||
|
||||
* 标签示例:`常来夜场`、`偏爱中式`、`高客单价` 等。
|
||||
* 文本说明:简要描述消费偏好、时段、频率等。
|
||||
* 模块三:与我的关系
|
||||
|
||||
* 等级:很好 / 好 / 一般 / 较陌生。
|
||||
* 等级下附文字说明,描述互动频率、最近服务情况等。
|
||||
* 底部固定操作栏:
|
||||
|
||||
* `问问助手`
|
||||
* `备注`
|
||||
|
||||
**交互**
|
||||
|
||||
* `问问助手`:
|
||||
|
||||
* 跳转到助手对话页。
|
||||
* 引用当前客户的关键信息(客户名、ID、最近消费等)作为灰底引用卡片。
|
||||
* 开启新对话主题。
|
||||
* `备注`:
|
||||
|
||||
* 底部弹出备注输入浮层,类型标记为“客户备注”,保存后进入“备注记录”。
|
||||
|
||||
---
|
||||
|
||||
### 8.3.5 看板 – 助教学视图
|
||||
|
||||
**入口**
|
||||
|
||||
* 看板顶部 Tab 选择“助教”。
|
||||
|
||||
**筛选条件**
|
||||
|
||||
* 条件 1:排序维度
|
||||
|
||||
* 创收最多(默认):按该助教带来的球房流水由高到低。
|
||||
* 创收最低:按球房流水由低到高。
|
||||
* 业绩最高:按业绩完成百分比由高到低。
|
||||
* 业绩最低:按业绩完成百分比由低到高.
|
||||
* 工资最高:按工资由高到低。
|
||||
* 工资最低:按工资由低到高。
|
||||
* 潜在客源储值:按该助教客户关系 >0.7 的所有客户储值金额总和由高到低。
|
||||
|
||||
* 条件 2:擅长项目
|
||||
|
||||
* 不限(默认)
|
||||
* 中式/追分
|
||||
* 斯诺克
|
||||
* 麻将
|
||||
* 团建
|
||||
|
||||
* 条件 3:时间月份
|
||||
|
||||
* 同财务视图:本月(默认)、上月、最近 3 个月、最近半年、本季度、上个季度、本周、上周、指定时间周期。
|
||||
* “指定时间周期”同样使用日期区间选择组件,并限制最大跨度 366 天,超出时非模态提示。
|
||||
|
||||
**助教列表卡片布局**
|
||||
|
||||
* 第一行:
|
||||
|
||||
* 左侧:
|
||||
|
||||
* 助教姓名
|
||||
* 等级标(如星级/等级)
|
||||
* 擅长项目(标签形式,展示主擅长方向)。
|
||||
* 右侧:
|
||||
|
||||
* 关系最好的客户列表,展示客户名称和关系指数(例如:`客户A 0.98、客户B 0.92、客户C 0.89...`),最多展示前三,超过以省略号表示。
|
||||
|
||||
* 第二行:
|
||||
|
||||
* 当前排序维度对应的数值信息,附单位/说明:
|
||||
|
||||
* 如创收最多:`本期流水:12345 元`
|
||||
* 业绩最高:`完成度:87%`
|
||||
* 工资:`本期工资:8000 元`
|
||||
* 上课时长等(小时)。
|
||||
|
||||
* 不显示头像。
|
||||
|
||||
**交互**
|
||||
|
||||
* 点击助教卡片:进入“助教详情页”。
|
||||
|
||||
---
|
||||
|
||||
### 8.3.6 助教详情页
|
||||
|
||||
**入口**
|
||||
|
||||
* 看板 – 助教视图列表点击某助教。
|
||||
|
||||
**布局**
|
||||
|
||||
* 顶部导航:标题 `助教详情`,左侧返回按钮。
|
||||
|
||||
* 模块一:助教基本信息
|
||||
|
||||
* 字段示例:姓名、工号、所属门店、擅长项目、等级等。
|
||||
|
||||
* 模块二:流水与业绩
|
||||
|
||||
* 本月带来的球房流水(数值,单位元或万元)。
|
||||
* 最近 3 个月带来的球房流水(数值)。
|
||||
* 综合业绩完成度(一个总进度百分比)。
|
||||
|
||||
* 模块三:工资与上课时长
|
||||
|
||||
* 本月工资总额。
|
||||
* 对应时间段的上课总时长(小时)。
|
||||
|
||||
* 模块四:前 10 个客户指数最高的客户列表
|
||||
|
||||
* 列表项字段:客户名 + 指数数值(0~1 或百分比展示)。
|
||||
|
||||
* 底部固定操作栏:
|
||||
|
||||
* `问问助手`
|
||||
* `备注`
|
||||
|
||||
**交互**
|
||||
|
||||
* `问问助手`:以助教信息和主要指标为引用,开启新对话主题。
|
||||
* `备注`:对该助教添加备注记录,类型为“助教备注”。
|
||||
|
||||
---
|
||||
|
||||
## 8.4 Tab:我的
|
||||
|
||||
### 8.4.1 我的首页
|
||||
|
||||
**入口**
|
||||
|
||||
* 底部 TabBar 点击“我的”。
|
||||
|
||||
**布局**
|
||||
|
||||
* 顶部:用户信息区域
|
||||
|
||||
* 用户名、身份(店长/助教等)、所属门店等信息。
|
||||
* 列表菜单项:
|
||||
|
||||
* `备注记录`
|
||||
* `助手对话记录`
|
||||
* `首页设置`
|
||||
* `退出账号`
|
||||
|
||||
**交互**
|
||||
|
||||
* 点击各行进入对应子页面或触发弹窗。
|
||||
|
||||
---
|
||||
|
||||
### 8.4.2 备注记录页
|
||||
|
||||
**入口**
|
||||
|
||||
* “我的”首页点击 `备注记录`。
|
||||
|
||||
**布局**
|
||||
|
||||
* 标题:`备注记录`
|
||||
* 列表按时间倒序(由近到远)平铺,不按日期分组。
|
||||
* 每条记录显示:
|
||||
|
||||
* 备注全文(不做截断或只做必要的单行/多行控制)。
|
||||
* 关联对象:例如 `客户:张三` / `任务:XXX` / `助教:李四`。
|
||||
* 创建时间。
|
||||
|
||||
**交互**
|
||||
|
||||
* 点击备注记录:不进入详情页(即本页即为详情展示),不支持编辑/删除。
|
||||
* 列表为空时:显示 `暂无数据`。
|
||||
|
||||
---
|
||||
|
||||
### 8.4.3 助手对话记录页
|
||||
|
||||
**入口**
|
||||
|
||||
* “我的”首页点击 `助手对话记录`。
|
||||
|
||||
**布局**
|
||||
|
||||
* 标题:`助手对话记录`
|
||||
* 列表项字段:
|
||||
|
||||
* 对话标题:由接口返回(一般为首条消息摘要)。
|
||||
* 最近一次对话时间。
|
||||
* 消息条数概览(例如:`共 25 条消息`)。
|
||||
* 列表按最近更新时间倒序。
|
||||
|
||||
**交互**
|
||||
|
||||
* 点击某条记录:
|
||||
|
||||
* 进入“助手对话页”,直接打开该会话。
|
||||
* 默认滚动到该对话的最后一条消息位置。
|
||||
* 不提供删除对话能力。
|
||||
* 列表为空时:显示 `暂无数据`。
|
||||
|
||||
---
|
||||
|
||||
### 8.4.4 首页设置页
|
||||
|
||||
**入口**
|
||||
|
||||
* “我的”首页点击 `首页设置`。
|
||||
|
||||
**布局**
|
||||
|
||||
* 标题:`首页设置`
|
||||
* 内容:
|
||||
|
||||
* 单选列表:
|
||||
|
||||
* `任务`
|
||||
* `看板`
|
||||
* 每项前有单选圆点,当前选中项高亮。
|
||||
* 底部:返回按钮。
|
||||
|
||||
**交互**
|
||||
|
||||
* 用户点击某一选项后立即生效,作为新的默认首页设置(切换即保存,不需要额外保存按钮)。
|
||||
* 退出账号不会清除该设置,再次登录仍使用该默认首页。
|
||||
|
||||
---
|
||||
|
||||
### 8.4.5 退出账号(确认弹窗)
|
||||
|
||||
**入口**
|
||||
|
||||
* “我的”首页点击 `退出账号`。
|
||||
|
||||
**交互**
|
||||
|
||||
* 弹出确认弹窗:
|
||||
|
||||
* 标题:`确认退出`
|
||||
* 文案:`确认退出当前账号吗?`
|
||||
* 按钮:
|
||||
|
||||
* 取消
|
||||
* 退出
|
||||
* 点击“退出”:
|
||||
|
||||
* 清除登录态。
|
||||
* 不清理由于当前账号相关的本地配置(如首页设置、筛选条件等)。
|
||||
* 跳转回“登录页”。
|
||||
* 点击“取消”:关闭弹窗,留在“我的”页。
|
||||
|
||||
---
|
||||
|
||||
## 8.5 全局:助手对话页
|
||||
|
||||
### 8.5.1 入口
|
||||
|
||||
* 悬浮助手按钮。
|
||||
* 任务详情页底部按钮“问问助手”。
|
||||
* 客户详情页底部按钮“问问助手”。
|
||||
* 助教详情页底部按钮“问问助手”。
|
||||
* 看板各视图中长按指标启动助手。
|
||||
* “助手对话记录”页点击某一条历史记录。
|
||||
|
||||
### 8.5.2 聊天形式
|
||||
|
||||
* 对话双方:用户(“我”)与“助手”。
|
||||
* UI 全面仿微信对话界面:
|
||||
|
||||
* 左侧:助手气泡,显示助手头像(固定)和名称。
|
||||
* 右侧:用户气泡,显示用户头像和名称。
|
||||
* 对话记录:
|
||||
|
||||
* 最近 50 条消息默认加载。
|
||||
* 上拉加载更早记录。
|
||||
|
||||
### 8.5.3 引用内容展示
|
||||
|
||||
* 从任务/客户/助教/看板等入口进入助手时,将引用上下文:
|
||||
|
||||
* 引用内容显示为一块灰底小卡片,位于即将发送的消息气泡上方。
|
||||
* 卡片内容包括:
|
||||
|
||||
* 来源类型:任务 / 客户 / 助教 / 看板(具体子模块如财务/客户看板等)。
|
||||
* 标题或名称(例如客户名、任务标题、指标名)。
|
||||
* 部分摘要文案或关键数据。
|
||||
* 引用内容不可编辑,用户只能在下方输入框中补充自己的提问文本后发送。
|
||||
|
||||
### 8.5.4 会话管理
|
||||
|
||||
* 每个“新对话主题”形成一个独立会话,出现在“助手对话记录”列表中。
|
||||
* 来源:
|
||||
|
||||
* 从“助手对话记录”进入:
|
||||
|
||||
* 直接打开对应会话,加载历史记录,滚动到最后一条消息。
|
||||
* 如距最后一条消息超过 1 小时,在输入框区域上方显示横条提示,提供两个按钮:
|
||||
|
||||
* `新对话主题`
|
||||
* `继续对话`
|
||||
* 选择“新对话主题”:清空当前对话展示区域,开始新的对话会话,该会话作为新条目记录在“助手对话记录”中,历史对话仍保留在原会话条目中。
|
||||
* 选择“继续对话”:在当前会话中继续发送消息,对话标题不变。
|
||||
* 从任务/客户/助教/看板入口的“问问助手”或长按启动:
|
||||
|
||||
* 固定开启“新对话主题”,不受 1 小时规则影响,始终新建会话,并带入引用内容。
|
||||
|
||||
### 8.5.5 输入与发送
|
||||
|
||||
* 输入区包含:
|
||||
|
||||
* 文本输入框。
|
||||
* “按住说话”按钮(语音转文字)。
|
||||
* 发送按钮。
|
||||
|
||||
**语音转文字交互**
|
||||
|
||||
* 点击“按住说话”按钮并按住:
|
||||
|
||||
* 显示录音状态动画,松开后结束录音并开始识别。
|
||||
* 识别结果展示在输入框中,用户可编辑后再点击“发送”。
|
||||
* 识别失败时,弹出提示:`识别失败,请重试`,不发送消息。
|
||||
|
||||
**键盘与滚动行为**
|
||||
|
||||
* 键盘弹出时,列表自动滚动到底部,确保最新消息和输入框可见。
|
||||
* 发送消息后,自动滚动到底部。
|
||||
|
||||
---
|
||||
|
||||
# 九、非功能性要求
|
||||
|
||||
* 关键页面(任务列表、看板页、助手对话页)首次可接受加载时间:≤ 10 秒(在普通网络环境下)。
|
||||
* 看板页面数据:
|
||||
|
||||
* 各数据块采用懒加载策略,优先加载当前视图及首屏必要数据,其他部分可在滚动时或后台加载,避免一次性加载过多影响首屏体验。
|
||||
* 本阶段不做埋点与统计需求设计。
|
||||
|
||||
11
apps/miniprogram/i18n/base.json
Normal file
11
apps/miniprogram/i18n/base.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"ios": {
|
||||
"name": "桌球运营助手"
|
||||
},
|
||||
"android": {
|
||||
"name": "桌球运营助手"
|
||||
},
|
||||
"common": {
|
||||
"name": "桌球运营助手"
|
||||
}
|
||||
}
|
||||
13
apps/miniprogram/miniprogram/app.json
Normal file
13
apps/miniprogram/miniprogram/app.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"pages": [
|
||||
"pages/index/index",
|
||||
"pages/logs/logs"
|
||||
],
|
||||
"window": {
|
||||
"navigationBarTextStyle": "black",
|
||||
"navigationBarTitleText": "Weixin",
|
||||
"navigationBarBackgroundColor": "#ffffff"
|
||||
},
|
||||
"componentFramework": "glass-easel",
|
||||
"lazyCodeLoading": "requiredComponents"
|
||||
}
|
||||
5
apps/miniprogram/miniprogram/app.miniapp.json
Normal file
5
apps/miniprogram/miniprogram/app.miniapp.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"adapteByMiniprogram": {
|
||||
"userName": "gh_521029c3a9c7"
|
||||
}
|
||||
}
|
||||
18
apps/miniprogram/miniprogram/app.ts
Normal file
18
apps/miniprogram/miniprogram/app.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
// app.ts
|
||||
App<IAppOption>({
|
||||
globalData: {},
|
||||
onLaunch() {
|
||||
// 展示本地存储能力
|
||||
const logs = wx.getStorageSync('logs') || []
|
||||
logs.unshift(Date.now())
|
||||
wx.setStorageSync('logs', logs)
|
||||
|
||||
// 登录
|
||||
wx.login({
|
||||
success: res => {
|
||||
console.log(res.code)
|
||||
// 发送 res.code 到后台换取 openId, sessionKey, unionId
|
||||
},
|
||||
})
|
||||
},
|
||||
})
|
||||
10
apps/miniprogram/miniprogram/app.wxss
Normal file
10
apps/miniprogram/miniprogram/app.wxss
Normal file
@@ -0,0 +1,10 @@
|
||||
/**app.wxss**/
|
||||
.container {
|
||||
height: 100%;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
padding: 200rpx 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
11
apps/miniprogram/miniprogram/i18n/base.json
Normal file
11
apps/miniprogram/miniprogram/i18n/base.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"ios": {
|
||||
"name": "桌球运营助手"
|
||||
},
|
||||
"android": {
|
||||
"name": "桌球运营助手"
|
||||
},
|
||||
"common": {
|
||||
"name": "桌球运营助手"
|
||||
}
|
||||
}
|
||||
66
apps/miniprogram/miniprogram/pages/index/index.js
Normal file
66
apps/miniprogram/miniprogram/pages/index/index.js
Normal file
@@ -0,0 +1,66 @@
|
||||
// pages/index/index.js
|
||||
Page({
|
||||
|
||||
/**
|
||||
* 页面的初始数据
|
||||
*/
|
||||
data: {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 生命周期函数--监听页面加载
|
||||
*/
|
||||
onLoad(options) {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 生命周期函数--监听页面初次渲染完成
|
||||
*/
|
||||
onReady() {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 生命周期函数--监听页面显示
|
||||
*/
|
||||
onShow() {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 生命周期函数--监听页面隐藏
|
||||
*/
|
||||
onHide() {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 生命周期函数--监听页面卸载
|
||||
*/
|
||||
onUnload() {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 页面相关事件处理函数--监听用户下拉动作
|
||||
*/
|
||||
onPullDownRefresh() {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 页面上拉触底事件的处理函数
|
||||
*/
|
||||
onReachBottom() {
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* 用户点击右上角分享
|
||||
*/
|
||||
onShareAppMessage() {
|
||||
|
||||
}
|
||||
})
|
||||
5
apps/miniprogram/miniprogram/pages/index/index.json
Normal file
5
apps/miniprogram/miniprogram/pages/index/index.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"usingComponents": {
|
||||
"t-button": "tdesign-miniprogram/button/button"
|
||||
}
|
||||
}
|
||||
54
apps/miniprogram/miniprogram/pages/index/index.ts
Normal file
54
apps/miniprogram/miniprogram/pages/index/index.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
// index.ts
|
||||
// 获取应用实例
|
||||
const app = getApp<IAppOption>()
|
||||
const defaultAvatarUrl = 'https://mmbiz.qpic.cn/mmbiz/icTdbqWNOwNRna42FI242Lcia07jQodd2FJGIYQfG0LAJGFxM4FbnQP6yfMxBgJ0F3YRqJCJ1aPAK2dQagdusBZg/0'
|
||||
|
||||
Component({
|
||||
data: {
|
||||
motto: 'Hello World',
|
||||
userInfo: {
|
||||
avatarUrl: defaultAvatarUrl,
|
||||
nickName: '',
|
||||
},
|
||||
hasUserInfo: false,
|
||||
canIUseGetUserProfile: wx.canIUse('getUserProfile'),
|
||||
canIUseNicknameComp: wx.canIUse('input.type.nickname'),
|
||||
},
|
||||
methods: {
|
||||
// 事件处理函数
|
||||
bindViewTap() {
|
||||
wx.navigateTo({
|
||||
url: '../logs/logs',
|
||||
})
|
||||
},
|
||||
onChooseAvatar(e: any) {
|
||||
const { avatarUrl } = e.detail
|
||||
const { nickName } = this.data.userInfo
|
||||
this.setData({
|
||||
"userInfo.avatarUrl": avatarUrl,
|
||||
hasUserInfo: nickName && avatarUrl && avatarUrl !== defaultAvatarUrl,
|
||||
})
|
||||
},
|
||||
onInputChange(e: any) {
|
||||
const nickName = e.detail.value
|
||||
const { avatarUrl } = this.data.userInfo
|
||||
this.setData({
|
||||
"userInfo.nickName": nickName,
|
||||
hasUserInfo: nickName && avatarUrl && avatarUrl !== defaultAvatarUrl,
|
||||
})
|
||||
},
|
||||
getUserProfile() {
|
||||
// 推荐使用wx.getUserProfile获取用户信息,开发者每次通过该接口获取用户个人信息均需用户确认,开发者妥善保管用户快速填写的头像昵称,避免重复弹窗
|
||||
wx.getUserProfile({
|
||||
desc: '展示用户信息', // 声明获取用户个人信息后的用途,后续会展示在弹窗中,请谨慎填写
|
||||
success: (res) => {
|
||||
console.log(res)
|
||||
this.setData({
|
||||
userInfo: res.userInfo,
|
||||
hasUserInfo: true
|
||||
})
|
||||
}
|
||||
})
|
||||
},
|
||||
},
|
||||
})
|
||||
28
apps/miniprogram/miniprogram/pages/index/index.wxml
Normal file
28
apps/miniprogram/miniprogram/pages/index/index.wxml
Normal file
@@ -0,0 +1,28 @@
|
||||
<!--index.wxml-->
|
||||
<scroll-view class="scrollarea" scroll-y type="list">
|
||||
<view class="container">
|
||||
<view class="userinfo">
|
||||
<block wx:if="{{canIUseNicknameComp && !hasUserInfo}}">
|
||||
<button class="avatar-wrapper" open-type="chooseAvatar" bind:chooseavatar="onChooseAvatar">
|
||||
<image class="avatar" src="{{userInfo.avatarUrl}}"></image>
|
||||
</button>
|
||||
<view class="nickname-wrapper">
|
||||
<text class="nickname-label">昵称</text>
|
||||
<input type="nickname" class="nickname-input" placeholder="请输入昵称" bind:change="onInputChange" />
|
||||
</view>
|
||||
</block>
|
||||
<block wx:elif="{{!hasUserInfo}}">
|
||||
<button wx:if="{{canIUseGetUserProfile}}" bindtap="getUserProfile"> 获取头像昵称 </button>
|
||||
<view wx:else> 请使用2.10.4及以上版本基础库 </view>
|
||||
</block>
|
||||
<block wx:else>
|
||||
<image bindtap="bindViewTap" class="userinfo-avatar" src="{{userInfo.avatarUrl}}" mode="cover"></image>
|
||||
<text class="userinfo-nickname">{{userInfo.nickName}}</text>
|
||||
</block>
|
||||
</view>
|
||||
<view class="usermotto">
|
||||
<text class="user-motto">{{motto}}</text>
|
||||
</view>
|
||||
<t-button theme="primary">按钮</t-button>
|
||||
</view>
|
||||
</scroll-view>
|
||||
62
apps/miniprogram/miniprogram/pages/index/index.wxss
Normal file
62
apps/miniprogram/miniprogram/pages/index/index.wxss
Normal file
@@ -0,0 +1,62 @@
|
||||
/**index.wxss**/
|
||||
page {
|
||||
height: 100vh;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
}
|
||||
.scrollarea {
|
||||
flex: 1;
|
||||
overflow-y: hidden;
|
||||
}
|
||||
|
||||
.userinfo {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
color: #aaa;
|
||||
width: 80%;
|
||||
}
|
||||
|
||||
.userinfo-avatar {
|
||||
overflow: hidden;
|
||||
width: 128rpx;
|
||||
height: 128rpx;
|
||||
margin: 20rpx;
|
||||
border-radius: 50%;
|
||||
}
|
||||
|
||||
.usermotto {
|
||||
margin-top: 200px;
|
||||
}
|
||||
|
||||
.avatar-wrapper {
|
||||
padding: 0;
|
||||
width: 56px !important;
|
||||
border-radius: 8px;
|
||||
margin-top: 40px;
|
||||
margin-bottom: 40px;
|
||||
}
|
||||
|
||||
.avatar {
|
||||
display: block;
|
||||
width: 56px;
|
||||
height: 56px;
|
||||
}
|
||||
|
||||
.nickname-wrapper {
|
||||
display: flex;
|
||||
width: 100%;
|
||||
padding: 16px;
|
||||
box-sizing: border-box;
|
||||
border-top: .5px solid rgba(0, 0, 0, 0.1);
|
||||
border-bottom: .5px solid rgba(0, 0, 0, 0.1);
|
||||
color: black;
|
||||
}
|
||||
|
||||
.nickname-label {
|
||||
width: 105px;
|
||||
}
|
||||
|
||||
.nickname-input {
|
||||
flex: 1;
|
||||
}
|
||||
19
apps/miniprogram/miniprogram/utils/util.ts
Normal file
19
apps/miniprogram/miniprogram/utils/util.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
export const formatTime = (date: Date) => {
|
||||
const year = date.getFullYear()
|
||||
const month = date.getMonth() + 1
|
||||
const day = date.getDate()
|
||||
const hour = date.getHours()
|
||||
const minute = date.getMinutes()
|
||||
const second = date.getSeconds()
|
||||
|
||||
return (
|
||||
[year, month, day].map(formatNumber).join('/') +
|
||||
' ' +
|
||||
[hour, minute, second].map(formatNumber).join(':')
|
||||
)
|
||||
}
|
||||
|
||||
const formatNumber = (n: number) => {
|
||||
const s = n.toString()
|
||||
return s[1] ? s : '0' + s
|
||||
}
|
||||
31
apps/miniprogram/package-lock.json
generated
Normal file
31
apps/miniprogram/package-lock.json
generated
Normal file
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"name": "miniprogram-ts-quickstart",
|
||||
"version": "1.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "miniprogram-ts-quickstart",
|
||||
"version": "1.0.0",
|
||||
"dependencies": {
|
||||
"tdesign-miniprogram": "^1.12.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"miniprogram-api-typings": "^2.8.3-1"
|
||||
}
|
||||
},
|
||||
"node_modules/miniprogram-api-typings": {
|
||||
"version": "2.12.0",
|
||||
"resolved": "https://registry.npmjs.org/miniprogram-api-typings/-/miniprogram-api-typings-2.12.0.tgz",
|
||||
"integrity": "sha512-ibvbqeslVFur0IAvTxLMvsbtvVcMo6gwvOnj0YZHV7aeDLu091VQRrETT2QuiG9P6aZWRcxeNGJChRKVPCp9VQ==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/tdesign-miniprogram": {
|
||||
"version": "1.12.2",
|
||||
"resolved": "https://registry.npmjs.org/tdesign-miniprogram/-/tdesign-miniprogram-1.12.2.tgz",
|
||||
"integrity": "sha512-ZpOdwonT26RRCK/FWbg9tR2lAJ54Hb4PAdyTWu8URWkbKOmSQhn0JCwCtWWRofKbyWCPsCn5NqljobaGh5VCMg==",
|
||||
"license": "MIT"
|
||||
}
|
||||
}
|
||||
}
|
||||
15
apps/miniprogram/package.json
Normal file
15
apps/miniprogram/package.json
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "miniprogram-ts-quickstart",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"scripts": {},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "",
|
||||
"dependencies": {
|
||||
"tdesign-miniprogram": "^1.12.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"miniprogram-api-typings": "^2.8.3-1"
|
||||
}
|
||||
}
|
||||
58
apps/miniprogram/project.config.json
Normal file
58
apps/miniprogram/project.config.json
Normal file
@@ -0,0 +1,58 @@
|
||||
{
|
||||
"description": "项目配置文件",
|
||||
"miniprogramRoot": "miniprogram/",
|
||||
"compileType": "miniprogram",
|
||||
"setting": {
|
||||
"useCompilerPlugins": [
|
||||
"typescript"
|
||||
],
|
||||
"babelSetting": {
|
||||
"ignore": [],
|
||||
"disablePlugins": [],
|
||||
"outputPath": ""
|
||||
},
|
||||
"coverView": false,
|
||||
"postcss": false,
|
||||
"minified": false,
|
||||
"enhance": true,
|
||||
"showShadowRootInWxmlPanel": false,
|
||||
"packNpmManually": true,
|
||||
"packNpmRelationList": [
|
||||
{
|
||||
"packageJsonPath": "./package.json",
|
||||
"miniprogramNpmDistDir": "./miniprogram/"
|
||||
}
|
||||
],
|
||||
"ignoreUploadUnusedFiles": true,
|
||||
"compileHotReLoad": false,
|
||||
"skylineRenderEnable": true,
|
||||
"condition": true,
|
||||
"es6": true,
|
||||
"compileWorklet": false,
|
||||
"uglifyFileName": false,
|
||||
"uploadWithSourceMap": true,
|
||||
"minifyWXSS": true,
|
||||
"minifyWXML": true,
|
||||
"localPlugins": false,
|
||||
"swc": false,
|
||||
"disableSWC": true,
|
||||
"disableUseStrict": false
|
||||
},
|
||||
"simulatorType": "wechat",
|
||||
"simulatorPluginLibVersion": {
|
||||
"wxext14566970e7e9f62": "3.6.5-41"
|
||||
},
|
||||
"condition": {},
|
||||
"srcMiniprogramRoot": "miniprogram/",
|
||||
"editorSetting": {
|
||||
"tabIndent": "insertSpaces",
|
||||
"tabSize": 2
|
||||
},
|
||||
"libVersion": "trial",
|
||||
"packOptions": {
|
||||
"ignore": [],
|
||||
"include": []
|
||||
},
|
||||
"appid": "wx7c07793d82732921",
|
||||
"projectArchitecture": "multiPlatform"
|
||||
}
|
||||
68
apps/miniprogram/project.miniapp.json
Normal file
68
apps/miniprogram/project.miniapp.json
Normal file
@@ -0,0 +1,68 @@
|
||||
{
|
||||
"miniVersion": "v2",
|
||||
"name": "%name%",
|
||||
"version": "0.0.1",
|
||||
"versionCode": 100,
|
||||
"i18nFilePath": "i18n",
|
||||
"mini-ohos": {
|
||||
"sdkVersion": "0.5.1"
|
||||
},
|
||||
"mini-android": {
|
||||
"resourcePath": "miniapp/android/nativeResources",
|
||||
"sdkVersion": "1.6.24",
|
||||
"toolkitVersion": "0.11.0",
|
||||
"useExtendedSdk": {
|
||||
"media": false,
|
||||
"bluetooth": false,
|
||||
"network": false,
|
||||
"scanner": false,
|
||||
"xweb": false
|
||||
},
|
||||
"icons": {
|
||||
"hdpi": "",
|
||||
"xhdpi": "",
|
||||
"xxhdpi": "",
|
||||
"xxxhdpi": ""
|
||||
},
|
||||
"splashscreen": {
|
||||
"hdpi": "",
|
||||
"xhdpi": "",
|
||||
"xxhdpi": ""
|
||||
},
|
||||
"enableVConsole": "open",
|
||||
"privacy": {
|
||||
"enable": true
|
||||
}
|
||||
},
|
||||
"mini-ios": {
|
||||
"sdkVersion": "1.6.28",
|
||||
"toolkitVersion": "0.0.9",
|
||||
"useExtendedSdk": {
|
||||
"WeAppOpenFuns": true,
|
||||
"WeAppNetwork": false,
|
||||
"WeAppBluetooth": false,
|
||||
"WeAppMedia": false,
|
||||
"WeAppLBS": false,
|
||||
"WeAppOthers": false
|
||||
},
|
||||
"enableVConsole": "open",
|
||||
"icons": {
|
||||
"mainIcon120": "",
|
||||
"mainIcon180": "",
|
||||
"spotlightIcon80": "",
|
||||
"spotlightIcon120": "",
|
||||
"settingsIcon58": "",
|
||||
"settingsIcon87": "",
|
||||
"notificationIcon40": "",
|
||||
"notificationIcon60": "",
|
||||
"appStore1024": ""
|
||||
},
|
||||
"splashScreen": {
|
||||
"customImage": ""
|
||||
},
|
||||
"privacy": {
|
||||
"enable": false
|
||||
},
|
||||
"enableOpenUrlNavigate": true
|
||||
}
|
||||
}
|
||||
24
apps/miniprogram/project.private.config.json
Normal file
24
apps/miniprogram/project.private.config.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"description": "项目私有配置文件。此文件中的内容将覆盖 project.config.json 中的相同字段。项目的改动优先同步到此文件中。详见文档:https://developers.weixin.qq.com/miniprogram/dev/devtools/projectconfig.html",
|
||||
"projectname": "XCX",
|
||||
"setting": {
|
||||
"compileHotReLoad": true,
|
||||
"urlCheck": true,
|
||||
"coverView": false,
|
||||
"lazyloadPlaceholderEnable": false,
|
||||
"skylineRenderEnable": true,
|
||||
"preloadBackgroundData": false,
|
||||
"autoAudits": false,
|
||||
"useApiHook": true,
|
||||
"useApiHostProcess": true,
|
||||
"showShadowRootInWxmlPanel": false,
|
||||
"useStaticServer": false,
|
||||
"useLanDebug": false,
|
||||
"showES6CompileOption": false,
|
||||
"bigPackageSizeSupport": false,
|
||||
"checkInvalidKey": true,
|
||||
"ignoreDevUnusedFiles": true
|
||||
},
|
||||
"libVersion": "3.11.2",
|
||||
"condition": {}
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
????,?????,??(??)??,????,????,??????,????
|
||||
|
34
apps/miniprogram/tsconfig.json
Normal file
34
apps/miniprogram/tsconfig.json
Normal file
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"strictNullChecks": true,
|
||||
"noImplicitAny": true,
|
||||
"module": "CommonJS",
|
||||
"target": "ES2020",
|
||||
"allowJs": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"esModuleInterop": true,
|
||||
"experimentalDecorators": true,
|
||||
"noImplicitThis": true,
|
||||
"noImplicitReturns": true,
|
||||
"alwaysStrict": true,
|
||||
"noFallthroughCasesInSwitch": true,
|
||||
"noUnusedLocals": true,
|
||||
"noUnusedParameters": true,
|
||||
"strict": true,
|
||||
"strictPropertyInitialization": true,
|
||||
"lib": ["ES2020"],
|
||||
"typeRoots": [
|
||||
"./typings"
|
||||
]
|
||||
},
|
||||
"include": [
|
||||
"./**/*.ts"
|
||||
],
|
||||
"exclude": [
|
||||
"node_modules"
|
||||
],
|
||||
|
||||
"paths": {
|
||||
"tdesign-miniprogram/*":["./miniprogram/miniprogram_npm/tdesign-miniprogram/*"]
|
||||
}
|
||||
}
|
||||
8
apps/miniprogram/typings/index.d.ts
vendored
Normal file
8
apps/miniprogram/typings/index.d.ts
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
/// <reference path="./types/index.d.ts" />
|
||||
|
||||
interface IAppOption {
|
||||
globalData: {
|
||||
userInfo?: WechatMiniprogram.UserInfo,
|
||||
}
|
||||
userInfoReadyCallback?: WechatMiniprogram.GetUserInfoSuccessCallback,
|
||||
}
|
||||
1
apps/miniprogram/typings/types/index.d.ts
vendored
Normal file
1
apps/miniprogram/typings/types/index.d.ts
vendored
Normal file
@@ -0,0 +1 @@
|
||||
/// <reference path="./wx/index.d.ts" />
|
||||
74
apps/miniprogram/typings/types/wx/index.d.ts
vendored
Normal file
74
apps/miniprogram/typings/types/wx/index.d.ts
vendored
Normal file
@@ -0,0 +1,74 @@
|
||||
/*! *****************************************************************************
|
||||
Copyright (c) 2021 Tencent, Inc. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
***************************************************************************** */
|
||||
|
||||
/// <reference path="./lib.wx.app.d.ts" />
|
||||
/// <reference path="./lib.wx.page.d.ts" />
|
||||
/// <reference path="./lib.wx.api.d.ts" />
|
||||
/// <reference path="./lib.wx.cloud.d.ts" />
|
||||
/// <reference path="./lib.wx.component.d.ts" />
|
||||
/// <reference path="./lib.wx.behavior.d.ts" />
|
||||
/// <reference path="./lib.wx.event.d.ts" />
|
||||
|
||||
declare namespace WechatMiniprogram {
|
||||
type IAnyObject = Record<string, any>
|
||||
type Optional<F> = F extends (arg: infer P) => infer R ? (arg?: P) => R : F
|
||||
type OptionalInterface<T> = { [K in keyof T]: Optional<T[K]> }
|
||||
interface AsyncMethodOptionLike {
|
||||
success?: (...args: any[]) => void
|
||||
}
|
||||
type PromisifySuccessResult<
|
||||
P,
|
||||
T extends AsyncMethodOptionLike
|
||||
> = P extends { success: any }
|
||||
? void
|
||||
: P extends { fail: any }
|
||||
? void
|
||||
: P extends { complete: any }
|
||||
? void
|
||||
: Promise<Parameters<Exclude<T['success'], undefined>>[0]>
|
||||
}
|
||||
|
||||
declare const console: WechatMiniprogram.Console
|
||||
declare const wx: WechatMiniprogram.Wx
|
||||
/** 引入模块。返回模块通过 `module.exports` 或 `exports` 暴露的接口。 */
|
||||
declare function require(
|
||||
/** 需要引入模块文件相对于当前文件的相对路径,或 npm 模块名,或 npm 模块路径。不支持绝对路径 */
|
||||
module: string
|
||||
): any
|
||||
/** 引入插件。返回插件通过 `main` 暴露的接口。 */
|
||||
declare function requirePlugin(
|
||||
/** 需要引入的插件的 alias */
|
||||
module: string
|
||||
): any
|
||||
/** 插件引入当前使用者小程序。返回使用者小程序通过 [插件配置中 `export` 暴露的接口](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/using.html#%E5%AF%BC%E5%87%BA%E5%88%B0%E6%8F%92%E4%BB%B6)。
|
||||
*
|
||||
* 该接口只在插件中存在
|
||||
*
|
||||
* 最低基础库: `2.11.1` */
|
||||
declare function requireMiniProgram(): any
|
||||
/** 当前模块对象 */
|
||||
declare let module: {
|
||||
/** 模块向外暴露的对象,使用 `require` 引用该模块时可以获取 */
|
||||
exports: any
|
||||
}
|
||||
/** `module.exports` 的引用 */
|
||||
declare let exports: any
|
||||
19671
apps/miniprogram/typings/types/wx/lib.wx.api.d.ts
vendored
Normal file
19671
apps/miniprogram/typings/types/wx/lib.wx.api.d.ts
vendored
Normal file
File diff suppressed because it is too large
Load Diff
270
apps/miniprogram/typings/types/wx/lib.wx.app.d.ts
vendored
Normal file
270
apps/miniprogram/typings/types/wx/lib.wx.app.d.ts
vendored
Normal file
@@ -0,0 +1,270 @@
|
||||
/*! *****************************************************************************
|
||||
Copyright (c) 2021 Tencent, Inc. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
***************************************************************************** */
|
||||
|
||||
declare namespace WechatMiniprogram.App {
|
||||
interface ReferrerInfo {
|
||||
/** 来源小程序或公众号或App的 appId
|
||||
*
|
||||
* 以下场景支持返回 referrerInfo.appId:
|
||||
* - 1020(公众号 profile 页相关小程序列表): appId
|
||||
* - 1035(公众号自定义菜单):来源公众号 appId
|
||||
* - 1036(App 分享消息卡片):来源应用 appId
|
||||
* - 1037(小程序打开小程序):来源小程序 appId
|
||||
* - 1038(从另一个小程序返回):来源小程序 appId
|
||||
* - 1043(公众号模板消息):来源公众号 appId
|
||||
*/
|
||||
appId: string
|
||||
/** 来源小程序传过来的数据,scene=1037或1038时支持 */
|
||||
extraData?: any
|
||||
}
|
||||
|
||||
type SceneValues =
|
||||
| 1001
|
||||
| 1005
|
||||
| 1006
|
||||
| 1007
|
||||
| 1008
|
||||
| 1011
|
||||
| 1012
|
||||
| 1013
|
||||
| 1014
|
||||
| 1017
|
||||
| 1019
|
||||
| 1020
|
||||
| 1023
|
||||
| 1024
|
||||
| 1025
|
||||
| 1026
|
||||
| 1027
|
||||
| 1028
|
||||
| 1029
|
||||
| 1030
|
||||
| 1031
|
||||
| 1032
|
||||
| 1034
|
||||
| 1035
|
||||
| 1036
|
||||
| 1037
|
||||
| 1038
|
||||
| 1039
|
||||
| 1042
|
||||
| 1043
|
||||
| 1044
|
||||
| 1045
|
||||
| 1046
|
||||
| 1047
|
||||
| 1048
|
||||
| 1049
|
||||
| 1052
|
||||
| 1053
|
||||
| 1056
|
||||
| 1057
|
||||
| 1058
|
||||
| 1059
|
||||
| 1064
|
||||
| 1067
|
||||
| 1069
|
||||
| 1071
|
||||
| 1072
|
||||
| 1073
|
||||
| 1074
|
||||
| 1077
|
||||
| 1078
|
||||
| 1079
|
||||
| 1081
|
||||
| 1082
|
||||
| 1084
|
||||
| 1089
|
||||
| 1090
|
||||
| 1091
|
||||
| 1092
|
||||
| 1095
|
||||
| 1096
|
||||
| 1097
|
||||
| 1099
|
||||
| 1102
|
||||
| 1124
|
||||
| 1125
|
||||
| 1126
|
||||
| 1129
|
||||
|
||||
interface LaunchShowOption {
|
||||
/** 打开小程序的路径 */
|
||||
path: string
|
||||
/** 打开小程序的query */
|
||||
query: IAnyObject
|
||||
/** 打开小程序的场景值
|
||||
* - 1001:发现栏小程序主入口,「最近使用」列表(基础库2.2.4版本起包含「我的小程序」列表)
|
||||
* - 1005:微信首页顶部搜索框的搜索结果页
|
||||
* - 1006:发现栏小程序主入口搜索框的搜索结果页
|
||||
* - 1007:单人聊天会话中的小程序消息卡片
|
||||
* - 1008:群聊会话中的小程序消息卡片
|
||||
* - 1011:扫描二维码
|
||||
* - 1012:长按图片识别二维码
|
||||
* - 1013:扫描手机相册中选取的二维码
|
||||
* - 1014:小程序模板消息
|
||||
* - 1017:前往小程序体验版的入口页
|
||||
* - 1019:微信钱包(微信客户端7.0.0版本改为支付入口)
|
||||
* - 1020:公众号 profile 页相关小程序列表
|
||||
* - 1023:安卓系统桌面图标
|
||||
* - 1024:小程序 profile 页
|
||||
* - 1025:扫描一维码
|
||||
* - 1026:发现栏小程序主入口,「附近的小程序」列表
|
||||
* - 1027:微信首页顶部搜索框搜索结果页「使用过的小程序」列表
|
||||
* - 1028:我的卡包
|
||||
* - 1029:小程序中的卡券详情页
|
||||
* - 1030:自动化测试下打开小程序
|
||||
* - 1031:长按图片识别一维码
|
||||
* - 1032:扫描手机相册中选取的一维码
|
||||
* - 1034:微信支付完成页
|
||||
* - 1035:公众号自定义菜单
|
||||
* - 1036:App 分享消息卡片
|
||||
* - 1037:小程序打开小程序
|
||||
* - 1038:从另一个小程序返回
|
||||
* - 1039:摇电视
|
||||
* - 1042:添加好友搜索框的搜索结果页
|
||||
* - 1043:公众号模板消息
|
||||
* - 1044:带 shareTicket 的小程序消息卡片 [详情](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html)
|
||||
* - 1045:朋友圈广告
|
||||
* - 1046:朋友圈广告详情页
|
||||
* - 1047:扫描小程序码
|
||||
* - 1048:长按图片识别小程序码
|
||||
* - 1049:扫描手机相册中选取的小程序码
|
||||
* - 1052:卡券的适用门店列表
|
||||
* - 1053:搜一搜的结果页
|
||||
* - 1056:聊天顶部音乐播放器右上角菜单
|
||||
* - 1057:钱包中的银行卡详情页
|
||||
* - 1058:公众号文章
|
||||
* - 1059:体验版小程序绑定邀请页
|
||||
* - 1064:微信首页连Wi-Fi状态栏
|
||||
* - 1067:公众号文章广告
|
||||
* - 1069:移动应用
|
||||
* - 1071:钱包中的银行卡列表页
|
||||
* - 1072:二维码收款页面
|
||||
* - 1073:客服消息列表下发的小程序消息卡片
|
||||
* - 1074:公众号会话下发的小程序消息卡片
|
||||
* - 1077:摇周边
|
||||
* - 1078:微信连Wi-Fi成功提示页
|
||||
* - 1079:微信游戏中心
|
||||
* - 1081:客服消息下发的文字链
|
||||
* - 1082:公众号会话下发的文字链
|
||||
* - 1084:朋友圈广告原生页
|
||||
* - 1089:微信聊天主界面下拉,「最近使用」栏(基础库2.2.4版本起包含「我的小程序」栏)
|
||||
* - 1090:长按小程序右上角菜单唤出最近使用历史
|
||||
* - 1091:公众号文章商品卡片
|
||||
* - 1092:城市服务入口
|
||||
* - 1095:小程序广告组件
|
||||
* - 1096:聊天记录
|
||||
* - 1097:微信支付签约页
|
||||
* - 1099:页面内嵌插件
|
||||
* - 1102:公众号 profile 页服务预览
|
||||
* - 1124:扫“一物一码”打开小程序
|
||||
* - 1125:长按图片识别“一物一码”
|
||||
* - 1126:扫描手机相册中选取的“一物一码”
|
||||
* - 1129:微信爬虫访问 [详情](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/sitemap.html)
|
||||
*/
|
||||
scene: SceneValues
|
||||
/** shareTicket,详见 [获取更多转发信息]((转发#获取更多转发信息)) */
|
||||
shareTicket: string
|
||||
/** 当场景为由从另一个小程序或公众号或App打开时,返回此字段 */
|
||||
referrerInfo?: ReferrerInfo
|
||||
}
|
||||
|
||||
interface PageNotFoundOption {
|
||||
/** 不存在页面的路径 */
|
||||
path: string
|
||||
/** 打开不存在页面的 query */
|
||||
query: IAnyObject
|
||||
/** 是否本次启动的首个页面(例如从分享等入口进来,首个页面是开发者配置的分享页面) */
|
||||
isEntryPage: boolean
|
||||
}
|
||||
|
||||
interface Option {
|
||||
/** 生命周期回调—监听小程序初始化
|
||||
*
|
||||
* 小程序初始化完成时触发,全局只触发一次。
|
||||
*/
|
||||
onLaunch(options: LaunchShowOption): void
|
||||
/** 生命周期回调—监听小程序显示
|
||||
*
|
||||
* 小程序启动,或从后台进入前台显示时
|
||||
*/
|
||||
onShow(options: LaunchShowOption): void
|
||||
/** 生命周期回调—监听小程序隐藏
|
||||
*
|
||||
* 小程序从前台进入后台时
|
||||
*/
|
||||
onHide(): void
|
||||
/** 错误监听函数
|
||||
*
|
||||
* 小程序发生脚本错误,或者 api
|
||||
*/
|
||||
onError(/** 错误信息,包含堆栈 */ error: string): void
|
||||
/** 页面不存在监听函数
|
||||
*
|
||||
* 小程序要打开的页面不存在时触发,会带上页面信息回调该函数
|
||||
*
|
||||
* **注意:**
|
||||
* 1. 如果开发者没有添加 `onPageNotFound` 监听,当跳转页面不存在时,将推入微信客户端原生的页面不存在提示页面。
|
||||
* 2. 如果 `onPageNotFound` 回调中又重定向到另一个不存在的页面,将推入微信客户端原生的页面不存在提示页面,并且不再回调 `onPageNotFound`。
|
||||
*
|
||||
* 最低基础库: 1.9.90
|
||||
*/
|
||||
onPageNotFound(options: PageNotFoundOption): void
|
||||
/**
|
||||
* 小程序有未处理的 Promise 拒绝时触发。也可以使用 [wx.onUnhandledRejection](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onUnhandledRejection.html) 绑定监听。注意事项请参考 [wx.onUnhandledRejection](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onUnhandledRejection.html)。
|
||||
* **参数**:与 [wx.onUnhandledRejection](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onUnhandledRejection.html) 一致
|
||||
*/
|
||||
onUnhandledRejection: OnUnhandledRejectionCallback
|
||||
/**
|
||||
* 系统切换主题时触发。也可以使用 wx.onThemeChange 绑定监听。
|
||||
*
|
||||
* 最低基础库: 2.11.0
|
||||
*/
|
||||
onThemeChange: OnThemeChangeCallback
|
||||
}
|
||||
|
||||
type Instance<T extends IAnyObject> = Option & T
|
||||
type Options<T extends IAnyObject> = Partial<Option> &
|
||||
T &
|
||||
ThisType<Instance<T>>
|
||||
type TrivialInstance = Instance<IAnyObject>
|
||||
|
||||
interface Constructor {
|
||||
<T extends IAnyObject>(options: Options<T>): void
|
||||
}
|
||||
|
||||
interface GetAppOption {
|
||||
/** 在 `App` 未定义时返回默认实现。当App被调用时,默认实现中定义的属性会被覆盖合并到App中。一般用于独立分包
|
||||
*
|
||||
* 最低基础库: 2.2.4
|
||||
*/
|
||||
allowDefault?: boolean
|
||||
}
|
||||
|
||||
interface GetApp {
|
||||
<T = IAnyObject>(opts?: GetAppOption): Instance<T>
|
||||
}
|
||||
}
|
||||
|
||||
declare let App: WechatMiniprogram.App.Constructor
|
||||
declare let getApp: WechatMiniprogram.App.GetApp
|
||||
68
apps/miniprogram/typings/types/wx/lib.wx.behavior.d.ts
vendored
Normal file
68
apps/miniprogram/typings/types/wx/lib.wx.behavior.d.ts
vendored
Normal file
@@ -0,0 +1,68 @@
|
||||
/*! *****************************************************************************
|
||||
Copyright (c) 2021 Tencent, Inc. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
***************************************************************************** */
|
||||
|
||||
declare namespace WechatMiniprogram.Behavior {
|
||||
type BehaviorIdentifier = string
|
||||
type Instance<
|
||||
TData extends DataOption,
|
||||
TProperty extends PropertyOption,
|
||||
TMethod extends MethodOption,
|
||||
TCustomInstanceProperty extends IAnyObject = Record<string, never>
|
||||
> = Component.Instance<TData, TProperty, TMethod, TCustomInstanceProperty>
|
||||
type TrivialInstance = Instance<IAnyObject, IAnyObject, IAnyObject>
|
||||
type TrivialOption = Options<IAnyObject, IAnyObject, IAnyObject>
|
||||
type Options<
|
||||
TData extends DataOption,
|
||||
TProperty extends PropertyOption,
|
||||
TMethod extends MethodOption,
|
||||
TCustomInstanceProperty extends IAnyObject = Record<string, never>
|
||||
> = Partial<Data<TData>> &
|
||||
Partial<Property<TProperty>> &
|
||||
Partial<Method<TMethod>> &
|
||||
Partial<OtherOption> &
|
||||
Partial<Lifetimes> &
|
||||
ThisType<Instance<TData, TProperty, TMethod, TCustomInstanceProperty>>
|
||||
interface Constructor {
|
||||
<
|
||||
TData extends DataOption,
|
||||
TProperty extends PropertyOption,
|
||||
TMethod extends MethodOption,
|
||||
TCustomInstanceProperty extends IAnyObject = Record<string, never>
|
||||
>(
|
||||
options: Options<TData, TProperty, TMethod, TCustomInstanceProperty>
|
||||
): BehaviorIdentifier
|
||||
}
|
||||
|
||||
type DataOption = Component.DataOption
|
||||
type PropertyOption = Component.PropertyOption
|
||||
type MethodOption = Component.MethodOption
|
||||
type Data<D extends DataOption> = Component.Data<D>
|
||||
type Property<P extends PropertyOption> = Component.Property<P>
|
||||
type Method<M extends MethodOption> = Component.Method<M>
|
||||
|
||||
type DefinitionFilter = Component.DefinitionFilter
|
||||
type Lifetimes = Component.Lifetimes
|
||||
|
||||
type OtherOption = Omit<Component.OtherOption, 'options'>
|
||||
}
|
||||
/** 注册一个 `behavior`,接受一个 `Object` 类型的参数。*/
|
||||
declare let Behavior: WechatMiniprogram.Behavior.Constructor
|
||||
924
apps/miniprogram/typings/types/wx/lib.wx.cloud.d.ts
vendored
Normal file
924
apps/miniprogram/typings/types/wx/lib.wx.cloud.d.ts
vendored
Normal file
@@ -0,0 +1,924 @@
|
||||
/*! *****************************************************************************
|
||||
Copyright (c) 2021 Tencent, Inc. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
***************************************************************************** */
|
||||
|
||||
interface IAPIError {
|
||||
errMsg: string
|
||||
}
|
||||
|
||||
interface IAPIParam<T = any> {
|
||||
config?: ICloudConfig
|
||||
success?: (res: T) => void
|
||||
fail?: (err: IAPIError) => void
|
||||
complete?: (val: T | IAPIError) => void
|
||||
}
|
||||
|
||||
interface IAPISuccessParam {
|
||||
errMsg: string
|
||||
}
|
||||
|
||||
type IAPICompleteParam = IAPISuccessParam | IAPIError
|
||||
|
||||
type IAPIFunction<T, P extends IAPIParam<T>> = (param?: P) => Promise<T>
|
||||
|
||||
interface IInitCloudConfig {
|
||||
env?:
|
||||
| string
|
||||
| {
|
||||
database?: string
|
||||
functions?: string
|
||||
storage?: string
|
||||
}
|
||||
traceUser?: boolean
|
||||
}
|
||||
|
||||
interface ICloudConfig {
|
||||
env?: string
|
||||
traceUser?: boolean
|
||||
}
|
||||
|
||||
interface IICloudAPI {
|
||||
init: (config?: IInitCloudConfig) => void
|
||||
[api: string]: AnyFunction | IAPIFunction<any, any>
|
||||
}
|
||||
|
||||
interface ICloudService {
|
||||
name: string
|
||||
|
||||
getAPIs: () => { [name: string]: IAPIFunction<any, any> }
|
||||
}
|
||||
|
||||
interface ICloudServices {
|
||||
[serviceName: string]: ICloudService
|
||||
}
|
||||
|
||||
interface ICloudMetaData {
|
||||
session_id: string
|
||||
}
|
||||
|
||||
declare class InternalSymbol {}
|
||||
|
||||
interface AnyObject {
|
||||
[x: string]: any
|
||||
}
|
||||
|
||||
type AnyArray = any[]
|
||||
|
||||
type AnyFunction = (...args: any[]) => any
|
||||
|
||||
/**
|
||||
* extend wx with cloud
|
||||
*/
|
||||
interface WxCloud {
|
||||
init: (config?: ICloudConfig) => void
|
||||
|
||||
callFunction(param: OQ<ICloud.CallFunctionParam>): void
|
||||
callFunction(
|
||||
param: RQ<ICloud.CallFunctionParam>
|
||||
): Promise<ICloud.CallFunctionResult>
|
||||
|
||||
uploadFile(param: OQ<ICloud.UploadFileParam>): WechatMiniprogram.UploadTask
|
||||
uploadFile(
|
||||
param: RQ<ICloud.UploadFileParam>
|
||||
): Promise<ICloud.UploadFileResult>
|
||||
|
||||
downloadFile(
|
||||
param: OQ<ICloud.DownloadFileParam>
|
||||
): WechatMiniprogram.DownloadTask
|
||||
downloadFile(
|
||||
param: RQ<ICloud.DownloadFileParam>
|
||||
): Promise<ICloud.DownloadFileResult>
|
||||
|
||||
getTempFileURL(param: OQ<ICloud.GetTempFileURLParam>): void
|
||||
getTempFileURL(
|
||||
param: RQ<ICloud.GetTempFileURLParam>
|
||||
): Promise<ICloud.GetTempFileURLResult>
|
||||
|
||||
deleteFile(param: OQ<ICloud.DeleteFileParam>): void
|
||||
deleteFile(
|
||||
param: RQ<ICloud.DeleteFileParam>
|
||||
): Promise<ICloud.DeleteFileResult>
|
||||
|
||||
database: (config?: ICloudConfig) => DB.Database
|
||||
|
||||
CloudID: ICloud.ICloudIDConstructor
|
||||
CDN: ICloud.ICDNConstructor
|
||||
}
|
||||
|
||||
declare namespace ICloud {
|
||||
interface ICloudAPIParam<T = any> extends IAPIParam<T> {
|
||||
config?: ICloudConfig
|
||||
}
|
||||
|
||||
// === API: callFunction ===
|
||||
type CallFunctionData = AnyObject
|
||||
|
||||
interface CallFunctionResult extends IAPISuccessParam {
|
||||
result: AnyObject | string | undefined
|
||||
}
|
||||
|
||||
interface CallFunctionParam extends ICloudAPIParam<CallFunctionResult> {
|
||||
name: string
|
||||
data?: CallFunctionData
|
||||
slow?: boolean
|
||||
}
|
||||
// === end ===
|
||||
|
||||
// === API: uploadFile ===
|
||||
interface UploadFileResult extends IAPISuccessParam {
|
||||
fileID: string
|
||||
statusCode: number
|
||||
}
|
||||
|
||||
interface UploadFileParam extends ICloudAPIParam<UploadFileResult> {
|
||||
cloudPath: string
|
||||
filePath: string
|
||||
header?: AnyObject
|
||||
}
|
||||
// === end ===
|
||||
|
||||
// === API: downloadFile ===
|
||||
interface DownloadFileResult extends IAPISuccessParam {
|
||||
tempFilePath: string
|
||||
statusCode: number
|
||||
}
|
||||
|
||||
interface DownloadFileParam extends ICloudAPIParam<DownloadFileResult> {
|
||||
fileID: string
|
||||
cloudPath?: string
|
||||
}
|
||||
// === end ===
|
||||
|
||||
// === API: getTempFileURL ===
|
||||
interface GetTempFileURLResult extends IAPISuccessParam {
|
||||
fileList: GetTempFileURLResultItem[]
|
||||
}
|
||||
|
||||
interface GetTempFileURLResultItem {
|
||||
fileID: string
|
||||
tempFileURL: string
|
||||
maxAge: number
|
||||
status: number
|
||||
errMsg: string
|
||||
}
|
||||
|
||||
interface GetTempFileURLParam extends ICloudAPIParam<GetTempFileURLResult> {
|
||||
fileList: string[]
|
||||
}
|
||||
// === end ===
|
||||
|
||||
// === API: deleteFile ===
|
||||
interface DeleteFileResult extends IAPISuccessParam {
|
||||
fileList: DeleteFileResultItem[]
|
||||
}
|
||||
|
||||
interface DeleteFileResultItem {
|
||||
fileID: string
|
||||
status: number
|
||||
errMsg: string
|
||||
}
|
||||
|
||||
interface DeleteFileParam extends ICloudAPIParam<DeleteFileResult> {
|
||||
fileList: string[]
|
||||
}
|
||||
// === end ===
|
||||
|
||||
// === API: CloudID ===
|
||||
abstract class CloudID {
|
||||
constructor(cloudID: string)
|
||||
}
|
||||
|
||||
interface ICloudIDConstructor {
|
||||
new (cloudId: string): CloudID
|
||||
(cloudId: string): CloudID
|
||||
}
|
||||
// === end ===
|
||||
|
||||
// === API: CDN ===
|
||||
abstract class CDN {
|
||||
target: string | ArrayBuffer | ICDNFilePathSpec
|
||||
constructor(target: string | ArrayBuffer | ICDNFilePathSpec)
|
||||
}
|
||||
|
||||
interface ICDNFilePathSpec {
|
||||
type: 'filePath'
|
||||
filePath: string
|
||||
}
|
||||
|
||||
interface ICDNConstructor {
|
||||
new (options: string | ArrayBuffer | ICDNFilePathSpec): CDN
|
||||
(options: string | ArrayBuffer | ICDNFilePathSpec): CDN
|
||||
}
|
||||
// === end ===
|
||||
}
|
||||
|
||||
// === Database ===
|
||||
declare namespace DB {
|
||||
/**
|
||||
* The class of all exposed cloud database instances
|
||||
*/
|
||||
class Database {
|
||||
readonly config: ICloudConfig
|
||||
readonly command: DatabaseCommand
|
||||
readonly Geo: IGeo
|
||||
readonly serverDate: () => ServerDate
|
||||
readonly RegExp: IRegExpConstructor
|
||||
|
||||
private constructor()
|
||||
|
||||
collection(collectionName: string): CollectionReference
|
||||
}
|
||||
|
||||
class CollectionReference extends Query {
|
||||
readonly collectionName: string
|
||||
|
||||
private constructor(name: string, database: Database)
|
||||
|
||||
doc(docId: string | number): DocumentReference
|
||||
|
||||
add(options: OQ<IAddDocumentOptions>): void
|
||||
add(options: RQ<IAddDocumentOptions>): Promise<IAddResult>
|
||||
}
|
||||
|
||||
class DocumentReference {
|
||||
private constructor(docId: string | number, database: Database)
|
||||
|
||||
field(object: Record<string, any>): this
|
||||
|
||||
get(options: OQ<IGetDocumentOptions>): void
|
||||
get(options?: RQ<IGetDocumentOptions>): Promise<IQuerySingleResult>
|
||||
|
||||
set(options: OQ<ISetSingleDocumentOptions>): void
|
||||
set(options?: RQ<ISetSingleDocumentOptions>): Promise<ISetResult>
|
||||
|
||||
update(options: OQ<IUpdateSingleDocumentOptions>): void
|
||||
update(
|
||||
options?: RQ<IUpdateSingleDocumentOptions>
|
||||
): Promise<IUpdateResult>
|
||||
|
||||
remove(options: OQ<IRemoveSingleDocumentOptions>): void
|
||||
remove(
|
||||
options?: RQ<IRemoveSingleDocumentOptions>
|
||||
): Promise<IRemoveResult>
|
||||
|
||||
watch(options: IWatchOptions): RealtimeListener
|
||||
}
|
||||
|
||||
class RealtimeListener {
|
||||
// "And Now His Watch Is Ended"
|
||||
close: () => Promise<void>
|
||||
}
|
||||
|
||||
class Query {
|
||||
where(condition: IQueryCondition): Query
|
||||
|
||||
orderBy(fieldPath: string, order: string): Query
|
||||
|
||||
limit(max: number): Query
|
||||
|
||||
skip(offset: number): Query
|
||||
|
||||
field(object: Record<string, any>): Query
|
||||
|
||||
get(options: OQ<IGetDocumentOptions>): void
|
||||
get(options?: RQ<IGetDocumentOptions>): Promise<IQueryResult>
|
||||
|
||||
count(options: OQ<ICountDocumentOptions>): void
|
||||
count(options?: RQ<ICountDocumentOptions>): Promise<ICountResult>
|
||||
|
||||
watch(options: IWatchOptions): RealtimeListener
|
||||
}
|
||||
|
||||
interface DatabaseCommand {
|
||||
eq(val: any): DatabaseQueryCommand
|
||||
neq(val: any): DatabaseQueryCommand
|
||||
gt(val: any): DatabaseQueryCommand
|
||||
gte(val: any): DatabaseQueryCommand
|
||||
lt(val: any): DatabaseQueryCommand
|
||||
lte(val: any): DatabaseQueryCommand
|
||||
in(val: any[]): DatabaseQueryCommand
|
||||
nin(val: any[]): DatabaseQueryCommand
|
||||
|
||||
geoNear(options: IGeoNearCommandOptions): DatabaseQueryCommand
|
||||
geoWithin(options: IGeoWithinCommandOptions): DatabaseQueryCommand
|
||||
geoIntersects(
|
||||
options: IGeoIntersectsCommandOptions
|
||||
): DatabaseQueryCommand
|
||||
|
||||
and(
|
||||
...expressions: Array<DatabaseLogicCommand | IQueryCondition>
|
||||
): DatabaseLogicCommand
|
||||
or(
|
||||
...expressions: Array<DatabaseLogicCommand | IQueryCondition>
|
||||
): DatabaseLogicCommand
|
||||
nor(
|
||||
...expressions: Array<DatabaseLogicCommand | IQueryCondition>
|
||||
): DatabaseLogicCommand
|
||||
not(expression: DatabaseLogicCommand): DatabaseLogicCommand
|
||||
|
||||
exists(val: boolean): DatabaseQueryCommand
|
||||
|
||||
mod(divisor: number, remainder: number): DatabaseQueryCommand
|
||||
|
||||
all(val: any[]): DatabaseQueryCommand
|
||||
elemMatch(val: any): DatabaseQueryCommand
|
||||
size(val: number): DatabaseQueryCommand
|
||||
|
||||
set(val: any): DatabaseUpdateCommand
|
||||
remove(): DatabaseUpdateCommand
|
||||
inc(val: number): DatabaseUpdateCommand
|
||||
mul(val: number): DatabaseUpdateCommand
|
||||
min(val: number): DatabaseUpdateCommand
|
||||
max(val: number): DatabaseUpdateCommand
|
||||
rename(val: string): DatabaseUpdateCommand
|
||||
bit(val: number): DatabaseUpdateCommand
|
||||
|
||||
push(...values: any[]): DatabaseUpdateCommand
|
||||
pop(): DatabaseUpdateCommand
|
||||
shift(): DatabaseUpdateCommand
|
||||
unshift(...values: any[]): DatabaseUpdateCommand
|
||||
addToSet(val: any): DatabaseUpdateCommand
|
||||
pull(val: any): DatabaseUpdateCommand
|
||||
pullAll(val: any): DatabaseUpdateCommand
|
||||
|
||||
project: {
|
||||
slice(val: number | [number, number]): DatabaseProjectionCommand
|
||||
}
|
||||
|
||||
aggregate: {
|
||||
__safe_props__?: Set<string>
|
||||
|
||||
abs(val: any): DatabaseAggregateCommand
|
||||
add(val: any): DatabaseAggregateCommand
|
||||
addToSet(val: any): DatabaseAggregateCommand
|
||||
allElementsTrue(val: any): DatabaseAggregateCommand
|
||||
and(val: any): DatabaseAggregateCommand
|
||||
anyElementTrue(val: any): DatabaseAggregateCommand
|
||||
arrayElemAt(val: any): DatabaseAggregateCommand
|
||||
arrayToObject(val: any): DatabaseAggregateCommand
|
||||
avg(val: any): DatabaseAggregateCommand
|
||||
ceil(val: any): DatabaseAggregateCommand
|
||||
cmp(val: any): DatabaseAggregateCommand
|
||||
concat(val: any): DatabaseAggregateCommand
|
||||
concatArrays(val: any): DatabaseAggregateCommand
|
||||
cond(val: any): DatabaseAggregateCommand
|
||||
convert(val: any): DatabaseAggregateCommand
|
||||
dateFromParts(val: any): DatabaseAggregateCommand
|
||||
dateToParts(val: any): DatabaseAggregateCommand
|
||||
dateFromString(val: any): DatabaseAggregateCommand
|
||||
dateToString(val: any): DatabaseAggregateCommand
|
||||
dayOfMonth(val: any): DatabaseAggregateCommand
|
||||
dayOfWeek(val: any): DatabaseAggregateCommand
|
||||
dayOfYear(val: any): DatabaseAggregateCommand
|
||||
divide(val: any): DatabaseAggregateCommand
|
||||
eq(val: any): DatabaseAggregateCommand
|
||||
exp(val: any): DatabaseAggregateCommand
|
||||
filter(val: any): DatabaseAggregateCommand
|
||||
first(val: any): DatabaseAggregateCommand
|
||||
floor(val: any): DatabaseAggregateCommand
|
||||
gt(val: any): DatabaseAggregateCommand
|
||||
gte(val: any): DatabaseAggregateCommand
|
||||
hour(val: any): DatabaseAggregateCommand
|
||||
ifNull(val: any): DatabaseAggregateCommand
|
||||
in(val: any): DatabaseAggregateCommand
|
||||
indexOfArray(val: any): DatabaseAggregateCommand
|
||||
indexOfBytes(val: any): DatabaseAggregateCommand
|
||||
indexOfCP(val: any): DatabaseAggregateCommand
|
||||
isArray(val: any): DatabaseAggregateCommand
|
||||
isoDayOfWeek(val: any): DatabaseAggregateCommand
|
||||
isoWeek(val: any): DatabaseAggregateCommand
|
||||
isoWeekYear(val: any): DatabaseAggregateCommand
|
||||
last(val: any): DatabaseAggregateCommand
|
||||
let(val: any): DatabaseAggregateCommand
|
||||
literal(val: any): DatabaseAggregateCommand
|
||||
ln(val: any): DatabaseAggregateCommand
|
||||
log(val: any): DatabaseAggregateCommand
|
||||
log10(val: any): DatabaseAggregateCommand
|
||||
lt(val: any): DatabaseAggregateCommand
|
||||
lte(val: any): DatabaseAggregateCommand
|
||||
ltrim(val: any): DatabaseAggregateCommand
|
||||
map(val: any): DatabaseAggregateCommand
|
||||
max(val: any): DatabaseAggregateCommand
|
||||
mergeObjects(val: any): DatabaseAggregateCommand
|
||||
meta(val: any): DatabaseAggregateCommand
|
||||
min(val: any): DatabaseAggregateCommand
|
||||
millisecond(val: any): DatabaseAggregateCommand
|
||||
minute(val: any): DatabaseAggregateCommand
|
||||
mod(val: any): DatabaseAggregateCommand
|
||||
month(val: any): DatabaseAggregateCommand
|
||||
multiply(val: any): DatabaseAggregateCommand
|
||||
neq(val: any): DatabaseAggregateCommand
|
||||
not(val: any): DatabaseAggregateCommand
|
||||
objectToArray(val: any): DatabaseAggregateCommand
|
||||
or(val: any): DatabaseAggregateCommand
|
||||
pow(val: any): DatabaseAggregateCommand
|
||||
push(val: any): DatabaseAggregateCommand
|
||||
range(val: any): DatabaseAggregateCommand
|
||||
reduce(val: any): DatabaseAggregateCommand
|
||||
reverseArray(val: any): DatabaseAggregateCommand
|
||||
rtrim(val: any): DatabaseAggregateCommand
|
||||
second(val: any): DatabaseAggregateCommand
|
||||
setDifference(val: any): DatabaseAggregateCommand
|
||||
setEquals(val: any): DatabaseAggregateCommand
|
||||
setIntersection(val: any): DatabaseAggregateCommand
|
||||
setIsSubset(val: any): DatabaseAggregateCommand
|
||||
setUnion(val: any): DatabaseAggregateCommand
|
||||
size(val: any): DatabaseAggregateCommand
|
||||
slice(val: any): DatabaseAggregateCommand
|
||||
split(val: any): DatabaseAggregateCommand
|
||||
sqrt(val: any): DatabaseAggregateCommand
|
||||
stdDevPop(val: any): DatabaseAggregateCommand
|
||||
stdDevSamp(val: any): DatabaseAggregateCommand
|
||||
strcasecmp(val: any): DatabaseAggregateCommand
|
||||
strLenBytes(val: any): DatabaseAggregateCommand
|
||||
strLenCP(val: any): DatabaseAggregateCommand
|
||||
substr(val: any): DatabaseAggregateCommand
|
||||
substrBytes(val: any): DatabaseAggregateCommand
|
||||
substrCP(val: any): DatabaseAggregateCommand
|
||||
subtract(val: any): DatabaseAggregateCommand
|
||||
sum(val: any): DatabaseAggregateCommand
|
||||
switch(val: any): DatabaseAggregateCommand
|
||||
toBool(val: any): DatabaseAggregateCommand
|
||||
toDate(val: any): DatabaseAggregateCommand
|
||||
toDecimal(val: any): DatabaseAggregateCommand
|
||||
toDouble(val: any): DatabaseAggregateCommand
|
||||
toInt(val: any): DatabaseAggregateCommand
|
||||
toLong(val: any): DatabaseAggregateCommand
|
||||
toObjectId(val: any): DatabaseAggregateCommand
|
||||
toString(val: any): DatabaseAggregateCommand
|
||||
toLower(val: any): DatabaseAggregateCommand
|
||||
toUpper(val: any): DatabaseAggregateCommand
|
||||
trim(val: any): DatabaseAggregateCommand
|
||||
trunc(val: any): DatabaseAggregateCommand
|
||||
type(val: any): DatabaseAggregateCommand
|
||||
week(val: any): DatabaseAggregateCommand
|
||||
year(val: any): DatabaseAggregateCommand
|
||||
zip(val: any): DatabaseAggregateCommand
|
||||
}
|
||||
}
|
||||
|
||||
class DatabaseAggregateCommand {}
|
||||
|
||||
enum LOGIC_COMMANDS_LITERAL {
|
||||
AND = 'and',
|
||||
OR = 'or',
|
||||
NOT = 'not',
|
||||
NOR = 'nor'
|
||||
}
|
||||
|
||||
class DatabaseLogicCommand {
|
||||
and(...expressions: DatabaseLogicCommand[]): DatabaseLogicCommand
|
||||
or(...expressions: DatabaseLogicCommand[]): DatabaseLogicCommand
|
||||
nor(...expressions: DatabaseLogicCommand[]): DatabaseLogicCommand
|
||||
not(expression: DatabaseLogicCommand): DatabaseLogicCommand
|
||||
}
|
||||
|
||||
enum QUERY_COMMANDS_LITERAL {
|
||||
// comparison
|
||||
EQ = 'eq',
|
||||
NEQ = 'neq',
|
||||
GT = 'gt',
|
||||
GTE = 'gte',
|
||||
LT = 'lt',
|
||||
LTE = 'lte',
|
||||
IN = 'in',
|
||||
NIN = 'nin',
|
||||
// geo
|
||||
GEO_NEAR = 'geoNear',
|
||||
GEO_WITHIN = 'geoWithin',
|
||||
GEO_INTERSECTS = 'geoIntersects',
|
||||
// element
|
||||
EXISTS = 'exists',
|
||||
// evaluation
|
||||
MOD = 'mod',
|
||||
// array
|
||||
ALL = 'all',
|
||||
ELEM_MATCH = 'elemMatch',
|
||||
SIZE = 'size'
|
||||
}
|
||||
|
||||
class DatabaseQueryCommand extends DatabaseLogicCommand {
|
||||
eq(val: any): DatabaseLogicCommand
|
||||
neq(val: any): DatabaseLogicCommand
|
||||
gt(val: any): DatabaseLogicCommand
|
||||
gte(val: any): DatabaseLogicCommand
|
||||
lt(val: any): DatabaseLogicCommand
|
||||
lte(val: any): DatabaseLogicCommand
|
||||
in(val: any[]): DatabaseLogicCommand
|
||||
nin(val: any[]): DatabaseLogicCommand
|
||||
|
||||
exists(val: boolean): DatabaseLogicCommand
|
||||
|
||||
mod(divisor: number, remainder: number): DatabaseLogicCommand
|
||||
|
||||
all(val: any[]): DatabaseLogicCommand
|
||||
elemMatch(val: any): DatabaseLogicCommand
|
||||
size(val: number): DatabaseLogicCommand
|
||||
|
||||
geoNear(options: IGeoNearCommandOptions): DatabaseLogicCommand
|
||||
geoWithin(options: IGeoWithinCommandOptions): DatabaseLogicCommand
|
||||
geoIntersects(
|
||||
options: IGeoIntersectsCommandOptions
|
||||
): DatabaseLogicCommand
|
||||
}
|
||||
|
||||
enum PROJECTION_COMMANDS_LITERAL {
|
||||
SLICE = 'slice'
|
||||
}
|
||||
|
||||
class DatabaseProjectionCommand {}
|
||||
|
||||
enum UPDATE_COMMANDS_LITERAL {
|
||||
// field
|
||||
SET = 'set',
|
||||
REMOVE = 'remove',
|
||||
INC = 'inc',
|
||||
MUL = 'mul',
|
||||
MIN = 'min',
|
||||
MAX = 'max',
|
||||
RENAME = 'rename',
|
||||
// bitwise
|
||||
BIT = 'bit',
|
||||
// array
|
||||
PUSH = 'push',
|
||||
POP = 'pop',
|
||||
SHIFT = 'shift',
|
||||
UNSHIFT = 'unshift',
|
||||
ADD_TO_SET = 'addToSet',
|
||||
PULL = 'pull',
|
||||
PULL_ALL = 'pullAll'
|
||||
}
|
||||
|
||||
class DatabaseUpdateCommand {}
|
||||
|
||||
class Batch {}
|
||||
|
||||
/**
|
||||
* A contract that all API provider must adhere to
|
||||
*/
|
||||
class APIBaseContract<
|
||||
PromiseReturn,
|
||||
CallbackReturn,
|
||||
Param extends IAPIParam,
|
||||
Context = any
|
||||
> {
|
||||
getContext(param: Param): Context
|
||||
|
||||
/**
|
||||
* In case of callback-style invocation, this function will be called
|
||||
*/
|
||||
getCallbackReturn(param: Param, context: Context): CallbackReturn
|
||||
|
||||
getFinalParam<T extends Param>(param: Param, context: Context): T
|
||||
|
||||
run<T extends Param>(param: T): Promise<PromiseReturn>
|
||||
}
|
||||
|
||||
interface IGeoPointConstructor {
|
||||
new (longitude: number, latitide: number): GeoPoint
|
||||
new (geojson: IGeoJSONPoint): GeoPoint
|
||||
(longitude: number, latitide: number): GeoPoint
|
||||
(geojson: IGeoJSONPoint): GeoPoint
|
||||
}
|
||||
|
||||
interface IGeoMultiPointConstructor {
|
||||
new (points: GeoPoint[] | IGeoJSONMultiPoint): GeoMultiPoint
|
||||
(points: GeoPoint[] | IGeoJSONMultiPoint): GeoMultiPoint
|
||||
}
|
||||
|
||||
interface IGeoLineStringConstructor {
|
||||
new (points: GeoPoint[] | IGeoJSONLineString): GeoLineString
|
||||
(points: GeoPoint[] | IGeoJSONLineString): GeoLineString
|
||||
}
|
||||
|
||||
interface IGeoMultiLineStringConstructor {
|
||||
new (
|
||||
lineStrings: GeoLineString[] | IGeoJSONMultiLineString
|
||||
): GeoMultiLineString
|
||||
(
|
||||
lineStrings: GeoLineString[] | IGeoJSONMultiLineString
|
||||
): GeoMultiLineString
|
||||
}
|
||||
|
||||
interface IGeoPolygonConstructor {
|
||||
new (lineStrings: GeoLineString[] | IGeoJSONPolygon): GeoPolygon
|
||||
(lineStrings: GeoLineString[] | IGeoJSONPolygon): GeoPolygon
|
||||
}
|
||||
|
||||
interface IGeoMultiPolygonConstructor {
|
||||
new (polygons: GeoPolygon[] | IGeoJSONMultiPolygon): GeoMultiPolygon
|
||||
(polygons: GeoPolygon[] | IGeoJSONMultiPolygon): GeoMultiPolygon
|
||||
}
|
||||
|
||||
interface IGeo {
|
||||
Point: IGeoPointConstructor
|
||||
MultiPoint: IGeoMultiPointConstructor
|
||||
LineString: IGeoLineStringConstructor
|
||||
MultiLineString: IGeoMultiLineStringConstructor
|
||||
Polygon: IGeoPolygonConstructor
|
||||
MultiPolygon: IGeoMultiPolygonConstructor
|
||||
}
|
||||
|
||||
interface IGeoJSONPoint {
|
||||
type: 'Point'
|
||||
coordinates: [number, number]
|
||||
}
|
||||
|
||||
interface IGeoJSONMultiPoint {
|
||||
type: 'MultiPoint'
|
||||
coordinates: Array<[number, number]>
|
||||
}
|
||||
|
||||
interface IGeoJSONLineString {
|
||||
type: 'LineString'
|
||||
coordinates: Array<[number, number]>
|
||||
}
|
||||
|
||||
interface IGeoJSONMultiLineString {
|
||||
type: 'MultiLineString'
|
||||
coordinates: Array<Array<[number, number]>>
|
||||
}
|
||||
|
||||
interface IGeoJSONPolygon {
|
||||
type: 'Polygon'
|
||||
coordinates: Array<Array<[number, number]>>
|
||||
}
|
||||
|
||||
interface IGeoJSONMultiPolygon {
|
||||
type: 'MultiPolygon'
|
||||
coordinates: Array<Array<Array<[number, number]>>>
|
||||
}
|
||||
|
||||
type IGeoJSONObject =
|
||||
| IGeoJSONPoint
|
||||
| IGeoJSONMultiPoint
|
||||
| IGeoJSONLineString
|
||||
| IGeoJSONMultiLineString
|
||||
| IGeoJSONPolygon
|
||||
| IGeoJSONMultiPolygon
|
||||
|
||||
abstract class GeoPoint {
|
||||
longitude: number
|
||||
latitude: number
|
||||
|
||||
constructor(longitude: number, latitude: number)
|
||||
|
||||
toJSON(): Record<string, any>
|
||||
toString(): string
|
||||
}
|
||||
|
||||
abstract class GeoMultiPoint {
|
||||
points: GeoPoint[]
|
||||
|
||||
constructor(points: GeoPoint[])
|
||||
|
||||
toJSON(): IGeoJSONMultiPoint
|
||||
toString(): string
|
||||
}
|
||||
|
||||
abstract class GeoLineString {
|
||||
points: GeoPoint[]
|
||||
|
||||
constructor(points: GeoPoint[])
|
||||
|
||||
toJSON(): IGeoJSONLineString
|
||||
toString(): string
|
||||
}
|
||||
|
||||
abstract class GeoMultiLineString {
|
||||
lines: GeoLineString[]
|
||||
|
||||
constructor(lines: GeoLineString[])
|
||||
|
||||
toJSON(): IGeoJSONMultiLineString
|
||||
toString(): string
|
||||
}
|
||||
|
||||
abstract class GeoPolygon {
|
||||
lines: GeoLineString[]
|
||||
|
||||
constructor(lines: GeoLineString[])
|
||||
|
||||
toJSON(): IGeoJSONPolygon
|
||||
toString(): string
|
||||
}
|
||||
|
||||
abstract class GeoMultiPolygon {
|
||||
polygons: GeoPolygon[]
|
||||
|
||||
constructor(polygons: GeoPolygon[])
|
||||
|
||||
toJSON(): IGeoJSONMultiPolygon
|
||||
toString(): string
|
||||
}
|
||||
|
||||
type GeoInstance =
|
||||
| GeoPoint
|
||||
| GeoMultiPoint
|
||||
| GeoLineString
|
||||
| GeoMultiLineString
|
||||
| GeoPolygon
|
||||
| GeoMultiPolygon
|
||||
|
||||
interface IGeoNearCommandOptions {
|
||||
geometry: GeoPoint
|
||||
maxDistance?: number
|
||||
minDistance?: number
|
||||
}
|
||||
|
||||
interface IGeoWithinCommandOptions {
|
||||
geometry: GeoPolygon | GeoMultiPolygon
|
||||
}
|
||||
|
||||
interface IGeoIntersectsCommandOptions {
|
||||
geometry:
|
||||
| GeoPoint
|
||||
| GeoMultiPoint
|
||||
| GeoLineString
|
||||
| GeoMultiLineString
|
||||
| GeoPolygon
|
||||
| GeoMultiPolygon
|
||||
}
|
||||
|
||||
interface IServerDateOptions {
|
||||
offset: number
|
||||
}
|
||||
|
||||
abstract class ServerDate {
|
||||
readonly options: IServerDateOptions
|
||||
constructor(options?: IServerDateOptions)
|
||||
}
|
||||
|
||||
interface IRegExpOptions {
|
||||
regexp: string
|
||||
options?: string
|
||||
}
|
||||
|
||||
interface IRegExpConstructor {
|
||||
new (options: IRegExpOptions): RegExp
|
||||
(options: IRegExpOptions): RegExp
|
||||
}
|
||||
|
||||
abstract class RegExp {
|
||||
readonly regexp: string
|
||||
readonly options: string
|
||||
constructor(options: IRegExpOptions)
|
||||
}
|
||||
|
||||
type DocumentId = string | number
|
||||
|
||||
interface IDocumentData {
|
||||
_id?: DocumentId
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
type IDBAPIParam = IAPIParam
|
||||
|
||||
interface IAddDocumentOptions extends IDBAPIParam {
|
||||
data: IDocumentData
|
||||
}
|
||||
|
||||
type IGetDocumentOptions = IDBAPIParam
|
||||
|
||||
type ICountDocumentOptions = IDBAPIParam
|
||||
|
||||
interface IUpdateDocumentOptions extends IDBAPIParam {
|
||||
data: IUpdateCondition
|
||||
}
|
||||
|
||||
interface IUpdateSingleDocumentOptions extends IDBAPIParam {
|
||||
data: IUpdateCondition
|
||||
}
|
||||
|
||||
interface ISetDocumentOptions extends IDBAPIParam {
|
||||
data: IUpdateCondition
|
||||
}
|
||||
|
||||
interface ISetSingleDocumentOptions extends IDBAPIParam {
|
||||
data: IUpdateCondition
|
||||
}
|
||||
|
||||
interface IRemoveDocumentOptions extends IDBAPIParam {
|
||||
query: IQueryCondition
|
||||
}
|
||||
|
||||
type IRemoveSingleDocumentOptions = IDBAPIParam
|
||||
|
||||
interface IWatchOptions {
|
||||
// server realtime data init & change event
|
||||
onChange: (snapshot: ISnapshot) => void
|
||||
// error while connecting / listening
|
||||
onError: (error: any) => void
|
||||
}
|
||||
|
||||
interface ISnapshot {
|
||||
id: number
|
||||
docChanges: ISingleDBEvent[]
|
||||
docs: Record<string, any>
|
||||
type?: SnapshotType
|
||||
}
|
||||
|
||||
type SnapshotType = 'init'
|
||||
|
||||
interface ISingleDBEvent {
|
||||
id: number
|
||||
dataType: DataType
|
||||
queueType: QueueType
|
||||
docId: string
|
||||
doc: Record<string, any>
|
||||
updatedFields?: Record<string, any>
|
||||
removedFields?: string[]
|
||||
}
|
||||
|
||||
type DataType = 'init' | 'update' | 'replace' | 'add' | 'remove' | 'limit'
|
||||
|
||||
type QueueType = 'init' | 'enqueue' | 'dequeue' | 'update'
|
||||
|
||||
interface IQueryCondition {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
type IStringQueryCondition = string
|
||||
|
||||
interface IQueryResult extends IAPISuccessParam {
|
||||
data: IDocumentData[]
|
||||
}
|
||||
|
||||
interface IQuerySingleResult extends IAPISuccessParam {
|
||||
data: IDocumentData
|
||||
}
|
||||
|
||||
interface IUpdateCondition {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
type IStringUpdateCondition = string
|
||||
|
||||
interface IAddResult extends IAPISuccessParam {
|
||||
_id: DocumentId
|
||||
}
|
||||
|
||||
interface IUpdateResult extends IAPISuccessParam {
|
||||
stats: {
|
||||
updated: number
|
||||
// created: number,
|
||||
}
|
||||
}
|
||||
|
||||
interface ISetResult extends IAPISuccessParam {
|
||||
_id: DocumentId
|
||||
stats: {
|
||||
updated: number
|
||||
created: number
|
||||
}
|
||||
}
|
||||
|
||||
interface IRemoveResult extends IAPISuccessParam {
|
||||
stats: {
|
||||
removed: number
|
||||
}
|
||||
}
|
||||
|
||||
interface ICountResult extends IAPISuccessParam {
|
||||
total: number
|
||||
}
|
||||
}
|
||||
|
||||
type Optional<T> = { [K in keyof T]+?: T[K] }
|
||||
|
||||
type OQ<
|
||||
T extends Optional<
|
||||
Record<'complete' | 'success' | 'fail', (...args: any[]) => any>
|
||||
>
|
||||
> =
|
||||
| (RQ<T> & Required<Pick<T, 'success'>>)
|
||||
| (RQ<T> & Required<Pick<T, 'fail'>>)
|
||||
| (RQ<T> & Required<Pick<T, 'complete'>>)
|
||||
| (RQ<T> & Required<Pick<T, 'success' | 'fail'>>)
|
||||
| (RQ<T> & Required<Pick<T, 'success' | 'complete'>>)
|
||||
| (RQ<T> & Required<Pick<T, 'fail' | 'complete'>>)
|
||||
| (RQ<T> & Required<Pick<T, 'fail' | 'complete' | 'success'>>)
|
||||
|
||||
type RQ<
|
||||
T extends Optional<
|
||||
Record<'complete' | 'success' | 'fail', (...args: any[]) => any>
|
||||
>
|
||||
> = Pick<T, Exclude<keyof T, 'complete' | 'success' | 'fail'>>
|
||||
636
apps/miniprogram/typings/types/wx/lib.wx.component.d.ts
vendored
Normal file
636
apps/miniprogram/typings/types/wx/lib.wx.component.d.ts
vendored
Normal file
@@ -0,0 +1,636 @@
|
||||
/*! *****************************************************************************
|
||||
Copyright (c) 2021 Tencent, Inc. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
***************************************************************************** */
|
||||
|
||||
declare namespace WechatMiniprogram.Component {
|
||||
type Instance<
|
||||
TData extends DataOption,
|
||||
TProperty extends PropertyOption,
|
||||
TMethod extends Partial<MethodOption>,
|
||||
TCustomInstanceProperty extends IAnyObject = {},
|
||||
TIsPage extends boolean = false
|
||||
> = InstanceProperties &
|
||||
InstanceMethods<TData> &
|
||||
TMethod &
|
||||
(TIsPage extends true ? Page.ILifetime : {}) &
|
||||
TCustomInstanceProperty & {
|
||||
/** 组件数据,**包括内部数据和属性值** */
|
||||
data: TData & PropertyOptionToData<TProperty>
|
||||
/** 组件数据,**包括内部数据和属性值**(与 `data` 一致) */
|
||||
properties: TData & PropertyOptionToData<TProperty>
|
||||
}
|
||||
type TrivialInstance = Instance<
|
||||
IAnyObject,
|
||||
IAnyObject,
|
||||
IAnyObject,
|
||||
IAnyObject
|
||||
>
|
||||
type TrivialOption = Options<IAnyObject, IAnyObject, IAnyObject, IAnyObject>
|
||||
type Options<
|
||||
TData extends DataOption,
|
||||
TProperty extends PropertyOption,
|
||||
TMethod extends MethodOption,
|
||||
TCustomInstanceProperty extends IAnyObject = {},
|
||||
TIsPage extends boolean = false
|
||||
> = Partial<Data<TData>> &
|
||||
Partial<Property<TProperty>> &
|
||||
Partial<Method<TMethod, TIsPage>> &
|
||||
Partial<OtherOption> &
|
||||
Partial<Lifetimes> &
|
||||
ThisType<
|
||||
Instance<
|
||||
TData,
|
||||
TProperty,
|
||||
TMethod,
|
||||
TCustomInstanceProperty,
|
||||
TIsPage
|
||||
>
|
||||
>
|
||||
interface Constructor {
|
||||
<
|
||||
TData extends DataOption,
|
||||
TProperty extends PropertyOption,
|
||||
TMethod extends MethodOption,
|
||||
TCustomInstanceProperty extends IAnyObject = {},
|
||||
TIsPage extends boolean = false
|
||||
>(
|
||||
options: Options<
|
||||
TData,
|
||||
TProperty,
|
||||
TMethod,
|
||||
TCustomInstanceProperty,
|
||||
TIsPage
|
||||
>
|
||||
): string
|
||||
}
|
||||
type DataOption = Record<string, any>
|
||||
type PropertyOption = Record<string, AllProperty>
|
||||
type MethodOption = Record<string, Function>
|
||||
|
||||
interface Data<D extends DataOption> {
|
||||
/** 组件的内部数据,和 `properties` 一同用于组件的模板渲染 */
|
||||
data?: D
|
||||
}
|
||||
interface Property<P extends PropertyOption> {
|
||||
/** 组件的对外属性,是属性名到属性设置的映射表 */
|
||||
properties: P
|
||||
}
|
||||
interface Method<M extends MethodOption, TIsPage extends boolean = false> {
|
||||
/** 组件的方法,包括事件响应函数和任意的自定义方法,关于事件响应函数的使用,参见 [组件间通信与事件](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/events.html) */
|
||||
methods: M & (TIsPage extends true ? Partial<Page.ILifetime> : {})
|
||||
}
|
||||
type PropertyType =
|
||||
| StringConstructor
|
||||
| NumberConstructor
|
||||
| BooleanConstructor
|
||||
| ArrayConstructor
|
||||
| ObjectConstructor
|
||||
| null
|
||||
type ValueType<T extends PropertyType> = T extends null
|
||||
? any
|
||||
: T extends StringConstructor
|
||||
? string
|
||||
: T extends NumberConstructor
|
||||
? number
|
||||
: T extends BooleanConstructor
|
||||
? boolean
|
||||
: T extends ArrayConstructor
|
||||
? any[]
|
||||
: T extends ObjectConstructor
|
||||
? IAnyObject
|
||||
: never
|
||||
type FullProperty<T extends PropertyType> = {
|
||||
/** 属性类型 */
|
||||
type: T
|
||||
/** 属性初始值 */
|
||||
value?: ValueType<T>
|
||||
/** 属性值被更改时的响应函数 */
|
||||
observer?:
|
||||
| string
|
||||
| ((
|
||||
newVal: ValueType<T>,
|
||||
oldVal: ValueType<T>,
|
||||
changedPath: Array<string | number>
|
||||
) => void)
|
||||
/** 属性的类型(可以指定多个) */
|
||||
optionalTypes?: ShortProperty[]
|
||||
}
|
||||
type AllFullProperty =
|
||||
| FullProperty<StringConstructor>
|
||||
| FullProperty<NumberConstructor>
|
||||
| FullProperty<BooleanConstructor>
|
||||
| FullProperty<ArrayConstructor>
|
||||
| FullProperty<ObjectConstructor>
|
||||
| FullProperty<null>
|
||||
type ShortProperty =
|
||||
| StringConstructor
|
||||
| NumberConstructor
|
||||
| BooleanConstructor
|
||||
| ArrayConstructor
|
||||
| ObjectConstructor
|
||||
| null
|
||||
type AllProperty = AllFullProperty | ShortProperty
|
||||
type PropertyToData<T extends AllProperty> = T extends ShortProperty
|
||||
? ValueType<T>
|
||||
: FullPropertyToData<Exclude<T, ShortProperty>>
|
||||
type FullPropertyToData<T extends AllFullProperty> = ValueType<T['type']>
|
||||
type PropertyOptionToData<P extends PropertyOption> = {
|
||||
[name in keyof P]: PropertyToData<P[name]>
|
||||
}
|
||||
|
||||
interface InstanceProperties {
|
||||
/** 组件的文件路径 */
|
||||
is: string
|
||||
/** 节点id */
|
||||
id: string
|
||||
/** 节点dataset */
|
||||
dataset: Record<string, string>
|
||||
}
|
||||
|
||||
interface InstanceMethods<D extends DataOption> {
|
||||
/** `setData` 函数用于将数据从逻辑层发送到视图层
|
||||
*(异步),同时改变对应的 `this.data` 的值(同步)。
|
||||
*
|
||||
* **注意:**
|
||||
*
|
||||
* 1. **直接修改 this.data 而不调用 this.setData 是无法改变页面的状态的,还会造成数据不一致**。
|
||||
* 1. 仅支持设置可 JSON 化的数据。
|
||||
* 1. 单次设置的数据不能超过1024kB,请尽量避免一次设置过多的数据。
|
||||
* 1. 请不要把 data 中任何一项的 value 设为 `undefined` ,否则这一项将不被设置并可能遗留一些潜在问题。
|
||||
*/
|
||||
setData(
|
||||
/** 这次要改变的数据
|
||||
*
|
||||
* 以 `key: value` 的形式表示,将 `this.data` 中的 `key` 对应的值改变成 `value`。
|
||||
*
|
||||
* 其中 `key` 可以以数据路径的形式给出,支持改变数组中的某一项或对象的某个属性,如 `array[2].message`,`a.b.c.d`,并且不需要在 this.data 中预先定义。
|
||||
*/
|
||||
data: Partial<D> & IAnyObject,
|
||||
/** setData引起的界面更新渲染完毕后的回调函数,最低基础库: `1.5.0` */
|
||||
callback?: () => void
|
||||
): void
|
||||
|
||||
/** 检查组件是否具有 `behavior` (检查时会递归检查被直接或间接引入的所有behavior) */
|
||||
hasBehavior(behavior: Behavior.BehaviorIdentifier): void
|
||||
/** 触发事件,参见组件事件 */
|
||||
triggerEvent<DetailType = any>(
|
||||
name: string,
|
||||
detail?: DetailType,
|
||||
options?: TriggerEventOption
|
||||
): void
|
||||
/** 创建一个 SelectorQuery 对象,选择器选取范围为这个组件实例内 */
|
||||
createSelectorQuery(): SelectorQuery
|
||||
/** 创建一个 IntersectionObserver 对象,选择器选取范围为这个组件实例内 */
|
||||
createIntersectionObserver(
|
||||
options: CreateIntersectionObserverOption
|
||||
): IntersectionObserver
|
||||
/** 使用选择器选择组件实例节点,返回匹配到的第一个组件实例对象(会被 `wx://component-export` 影响) */
|
||||
selectComponent(selector: string): TrivialInstance
|
||||
/** 使用选择器选择组件实例节点,返回匹配到的全部组件实例对象组成的数组 */
|
||||
selectAllComponents(selector: string): TrivialInstance[]
|
||||
/**
|
||||
* 选取当前组件节点所在的组件实例(即组件的引用者),返回它的组件实例对象(会被 `wx://component-export` 影响)
|
||||
*
|
||||
* 最低基础库版本:[`2.8.2`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
selectOwnerComponent(): TrivialInstance
|
||||
/** 获取这个关系所对应的所有关联节点,参见 组件间关系 */
|
||||
getRelationNodes(relationKey: string): TrivialInstance[]
|
||||
/**
|
||||
* 立刻执行 callback ,其中的多个 setData 之间不会触发界面绘制(只有某些特殊场景中需要,如用于在不同组件同时 setData 时进行界面绘制同步)
|
||||
*
|
||||
* 最低基础库版本:[`2.4.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
groupSetData(callback?: () => void): void
|
||||
/**
|
||||
* 返回当前页面的 custom-tab-bar 的组件实例
|
||||
*
|
||||
* 最低基础库版本:[`2.6.2`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
getTabBar(): TrivialInstance
|
||||
/**
|
||||
* 返回页面标识符(一个字符串),可以用来判断几个自定义组件实例是不是在同一个页面内
|
||||
*
|
||||
* 最低基础库版本:[`2.7.1`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
getPageId(): string
|
||||
/**
|
||||
* 执行关键帧动画,详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
|
||||
*
|
||||
* 最低基础库版本:[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
animate(
|
||||
selector: string,
|
||||
keyFrames: KeyFrame[],
|
||||
duration: number,
|
||||
callback?: () => void
|
||||
): void
|
||||
/**
|
||||
* 执行关键帧动画,详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
|
||||
*
|
||||
* 最低基础库版本:[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
animate(
|
||||
selector: string,
|
||||
keyFrames: ScrollTimelineKeyframe[],
|
||||
duration: number,
|
||||
scrollTimeline: ScrollTimelineOption
|
||||
): void
|
||||
/**
|
||||
* 清除关键帧动画,详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
|
||||
*
|
||||
* 最低基础库版本:[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
clearAnimation(selector: string, callback: () => void): void
|
||||
/**
|
||||
* 清除关键帧动画,详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
|
||||
*
|
||||
* 最低基础库版本:[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
**/
|
||||
clearAnimation(
|
||||
selector: string,
|
||||
options?: ClearAnimationOptions,
|
||||
callback?: () => void
|
||||
): void
|
||||
getOpenerEventChannel(): EventChannel
|
||||
}
|
||||
|
||||
interface ComponentOptions {
|
||||
/**
|
||||
* [启用多slot支持](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/wxml-wxss.html#组件wxml的slot)
|
||||
*/
|
||||
multipleSlots?: boolean
|
||||
/**
|
||||
* [组件样式隔离](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/wxml-wxss.html#组件样式隔离)
|
||||
*/
|
||||
addGlobalClass?: boolean
|
||||
/**
|
||||
* [组件样式隔离](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/wxml-wxss.html#组件样式隔离)
|
||||
*/
|
||||
styleIsolation?:
|
||||
| 'isolated'
|
||||
| 'apply-shared'
|
||||
| 'shared'
|
||||
| 'page-isolated'
|
||||
| 'page-apply-shared'
|
||||
| 'page-shared'
|
||||
/**
|
||||
* [纯数据字段](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/pure-data.html) 是一些不用于界面渲染的 data 字段,可以用于提升页面更新性能。从小程序基础库版本 2.8.2 开始支持。
|
||||
*/
|
||||
pureDataPattern?: RegExp
|
||||
/**
|
||||
* [虚拟化组件节点](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/wxml-wxss.html#%E8%99%9A%E6%8B%9F%E5%8C%96%E7%BB%84%E4%BB%B6%E8%8A%82%E7%82%B9) 使自定义组件内部的第一层节点由自定义组件本身完全决定。从小程序基础库版本 [`2.11.2`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 开始支持 */
|
||||
virtualHost?: boolean
|
||||
}
|
||||
|
||||
interface TriggerEventOption {
|
||||
/** 事件是否冒泡
|
||||
*
|
||||
* 默认值: `false`
|
||||
*/
|
||||
bubbles?: boolean
|
||||
/** 事件是否可以穿越组件边界,为false时,事件将只能在引用组件的节点树上触发,不进入其他任何组件内部
|
||||
*
|
||||
* 默认值: `false`
|
||||
*/
|
||||
composed?: boolean
|
||||
/** 事件是否拥有捕获阶段
|
||||
*
|
||||
* 默认值: `false`
|
||||
*/
|
||||
capturePhase?: boolean
|
||||
}
|
||||
|
||||
interface RelationOption {
|
||||
/** 目标组件的相对关系 */
|
||||
type: 'parent' | 'child' | 'ancestor' | 'descendant'
|
||||
/** 关系生命周期函数,当关系被建立在页面节点树中时触发,触发时机在组件attached生命周期之后 */
|
||||
linked?(target: TrivialInstance): void
|
||||
/** 关系生命周期函数,当关系在页面节点树中发生改变时触发,触发时机在组件moved生命周期之后 */
|
||||
linkChanged?(target: TrivialInstance): void
|
||||
/** 关系生命周期函数,当关系脱离页面节点树时触发,触发时机在组件detached生命周期之后 */
|
||||
unlinked?(target: TrivialInstance): void
|
||||
/** 如果这一项被设置,则它表示关联的目标节点所应具有的behavior,所有拥有这一behavior的组件节点都会被关联 */
|
||||
target?: string
|
||||
}
|
||||
|
||||
interface PageLifetimes {
|
||||
/** 页面生命周期回调—监听页面显示
|
||||
*
|
||||
* 页面显示/切入前台时触发。
|
||||
*/
|
||||
show(): void
|
||||
/** 页面生命周期回调—监听页面隐藏
|
||||
*
|
||||
* 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面,小程序切入后台等。
|
||||
*/
|
||||
hide(): void
|
||||
/** 页面生命周期回调—监听页面尺寸变化
|
||||
*
|
||||
* 所在页面尺寸变化时执行
|
||||
*/
|
||||
resize(size: Page.IResizeOption): void
|
||||
}
|
||||
|
||||
type DefinitionFilter = <T extends TrivialOption>(
|
||||
/** 使用该 behavior 的 component/behavior 的定义对象 */
|
||||
defFields: T,
|
||||
/** 该 behavior 所使用的 behavior 的 definitionFilter 函数列表 */
|
||||
definitionFilterArr?: DefinitionFilter[]
|
||||
) => void
|
||||
|
||||
interface Lifetimes {
|
||||
/** 组件生命周期声明对象,组件的生命周期:`created`、`attached`、`ready`、`moved`、`detached` 将收归到 `lifetimes` 字段内进行声明,原有声明方式仍旧有效,如同时存在两种声明方式,则 `lifetimes` 字段内声明方式优先级最高
|
||||
*
|
||||
* 最低基础库: `2.2.3` */
|
||||
lifetimes: Partial<{
|
||||
/**
|
||||
* 在组件实例刚刚被创建时执行,注意此时不能调用 `setData`
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
created(): void
|
||||
/**
|
||||
* 在组件实例进入页面节点树时执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
attached(): void
|
||||
/**
|
||||
* 在组件在视图层布局完成后执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
ready(): void
|
||||
/**
|
||||
* 在组件实例被移动到节点树另一个位置时执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
moved(): void
|
||||
/**
|
||||
* 在组件实例被从页面节点树移除时执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
detached(): void
|
||||
/**
|
||||
* 每当组件方法抛出错误时执行
|
||||
*
|
||||
* 最低基础库版本:[`2.4.1`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
error(err: Error): void
|
||||
}>
|
||||
/**
|
||||
* @deprecated 旧式的定义方式,基础库 `2.2.3` 起请在 lifetimes 中定义
|
||||
*
|
||||
* 在组件实例刚刚被创建时执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
created(): void
|
||||
/**
|
||||
* @deprecated 旧式的定义方式,基础库 `2.2.3` 起请在 lifetimes 中定义
|
||||
*
|
||||
* 在组件实例进入页面节点树时执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
attached(): void
|
||||
/**
|
||||
* @deprecated 旧式的定义方式,基础库 `2.2.3` 起请在 lifetimes 中定义
|
||||
*
|
||||
* 在组件在视图层布局完成后执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
ready(): void
|
||||
/**
|
||||
* @deprecated 旧式的定义方式,基础库 `2.2.3` 起请在 lifetimes 中定义
|
||||
*
|
||||
* 在组件实例被移动到节点树另一个位置时执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
moved(): void
|
||||
/**
|
||||
* @deprecated 旧式的定义方式,基础库 `2.2.3` 起请在 lifetimes 中定义
|
||||
*
|
||||
* 在组件实例被从页面节点树移除时执行
|
||||
*
|
||||
* 最低基础库版本:[`1.6.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
detached(): void
|
||||
/**
|
||||
* @deprecated 旧式的定义方式,基础库 `2.2.3` 起请在 lifetimes 中定义
|
||||
*
|
||||
* 每当组件方法抛出错误时执行
|
||||
*
|
||||
* 最低基础库版本:[`2.4.1`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
error(err: Error): void
|
||||
}
|
||||
|
||||
interface OtherOption {
|
||||
/** 类似于mixins和traits的组件间代码复用机制,参见 [behaviors](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/behaviors.html) */
|
||||
behaviors: Behavior.BehaviorIdentifier[]
|
||||
/**
|
||||
* 组件数据字段监听器,用于监听 properties 和 data 的变化,参见 [数据监听器](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/observer.html)
|
||||
*
|
||||
* 最低基础库版本:[`2.6.1`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
|
||||
*/
|
||||
observers: Record<string, (...args: any[]) => any>
|
||||
/** 组件间关系定义,参见 [组件间关系](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/lifetimes.html) */
|
||||
relations: {
|
||||
[componentName: string]: RelationOption
|
||||
}
|
||||
/** 组件接受的外部样式类,参见 [外部样式类](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/wxml-wxss.html) */
|
||||
externalClasses?: string[]
|
||||
/** 组件所在页面的生命周期声明对象,参见 [组件生命周期](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/lifetimes.html)
|
||||
*
|
||||
* 最低基础库版本: [`2.2.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) */
|
||||
pageLifetimes?: Partial<PageLifetimes>
|
||||
/** 一些选项(文档中介绍相关特性时会涉及具体的选项设置,这里暂不列举) */
|
||||
options: ComponentOptions
|
||||
|
||||
/** 定义段过滤器,用于自定义组件扩展,参见 [自定义组件扩展](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/extend.html)
|
||||
*
|
||||
* 最低基础库版本: [`2.2.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) */
|
||||
definitionFilter?: DefinitionFilter
|
||||
/**
|
||||
* 组件自定义导出,当使用 `behavior: wx://component-export` 时,这个定义段可以用于指定组件被 selectComponent 调用时的返回值,参见 [组件间通信与事件](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/events.html)
|
||||
* 最低基础库版本: [`2.2.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) */
|
||||
export: () => IAnyObject
|
||||
}
|
||||
|
||||
interface KeyFrame {
|
||||
/** 关键帧的偏移,范围[0-1] */
|
||||
offset?: number
|
||||
/** 动画缓动函数 */
|
||||
ease?: string
|
||||
/** 基点位置,即 CSS transform-origin */
|
||||
transformOrigin?: string
|
||||
/** 背景颜色,即 CSS background-color */
|
||||
backgroundColor?: string
|
||||
/** 底边位置,即 CSS bottom */
|
||||
bottom?: number | string
|
||||
/** 高度,即 CSS height */
|
||||
height?: number | string
|
||||
/** 左边位置,即 CSS left */
|
||||
left?: number | string
|
||||
/** 宽度,即 CSS width */
|
||||
width?: number | string
|
||||
/** 不透明度,即 CSS opacity */
|
||||
opacity?: number | string
|
||||
/** 右边位置,即 CSS right */
|
||||
right?: number | string
|
||||
/** 顶边位置,即 CSS top */
|
||||
top?: number | string
|
||||
/** 变换矩阵,即 CSS transform matrix */
|
||||
matrix?: number[]
|
||||
/** 三维变换矩阵,即 CSS transform matrix3d */
|
||||
matrix3d?: number[]
|
||||
/** 旋转,即 CSS transform rotate */
|
||||
rotate?: number
|
||||
/** 三维旋转,即 CSS transform rotate3d */
|
||||
rotate3d?: number[]
|
||||
/** X 方向旋转,即 CSS transform rotateX */
|
||||
rotateX?: number
|
||||
/** Y 方向旋转,即 CSS transform rotateY */
|
||||
rotateY?: number
|
||||
/** Z 方向旋转,即 CSS transform rotateZ */
|
||||
rotateZ?: number
|
||||
/** 缩放,即 CSS transform scale */
|
||||
scale?: number[]
|
||||
/** 三维缩放,即 CSS transform scale3d */
|
||||
scale3d?: number[]
|
||||
/** X 方向缩放,即 CSS transform scaleX */
|
||||
scaleX?: number
|
||||
/** Y 方向缩放,即 CSS transform scaleY */
|
||||
scaleY?: number
|
||||
/** Z 方向缩放,即 CSS transform scaleZ */
|
||||
scaleZ?: number
|
||||
/** 倾斜,即 CSS transform skew */
|
||||
skew?: number[]
|
||||
/** X 方向倾斜,即 CSS transform skewX */
|
||||
skewX?: number
|
||||
/** Y 方向倾斜,即 CSS transform skewY */
|
||||
skewY?: number
|
||||
/** 位移,即 CSS transform translate */
|
||||
translate?: Array<number | string>
|
||||
/** 三维位移,即 CSS transform translate3d */
|
||||
translate3d?: Array<number | string>
|
||||
/** X 方向位移,即 CSS transform translateX */
|
||||
translateX?: number | string
|
||||
/** Y 方向位移,即 CSS transform translateY */
|
||||
translateY?: number | string
|
||||
/** Z 方向位移,即 CSS transform translateZ */
|
||||
translateZ?: number | string
|
||||
}
|
||||
interface ClearAnimationOptions {
|
||||
/** 基点位置,即 CSS transform-origin */
|
||||
transformOrigin?: boolean
|
||||
/** 背景颜色,即 CSS background-color */
|
||||
backgroundColor?: boolean
|
||||
/** 底边位置,即 CSS bottom */
|
||||
bottom?: boolean
|
||||
/** 高度,即 CSS height */
|
||||
height?: boolean
|
||||
/** 左边位置,即 CSS left */
|
||||
left?: boolean
|
||||
/** 宽度,即 CSS width */
|
||||
width?: boolean
|
||||
/** 不透明度,即 CSS opacity */
|
||||
opacity?: boolean
|
||||
/** 右边位置,即 CSS right */
|
||||
right?: boolean
|
||||
/** 顶边位置,即 CSS top */
|
||||
top?: boolean
|
||||
/** 变换矩阵,即 CSS transform matrix */
|
||||
matrix?: boolean
|
||||
/** 三维变换矩阵,即 CSS transform matrix3d */
|
||||
matrix3d?: boolean
|
||||
/** 旋转,即 CSS transform rotate */
|
||||
rotate?: boolean
|
||||
/** 三维旋转,即 CSS transform rotate3d */
|
||||
rotate3d?: boolean
|
||||
/** X 方向旋转,即 CSS transform rotateX */
|
||||
rotateX?: boolean
|
||||
/** Y 方向旋转,即 CSS transform rotateY */
|
||||
rotateY?: boolean
|
||||
/** Z 方向旋转,即 CSS transform rotateZ */
|
||||
rotateZ?: boolean
|
||||
/** 缩放,即 CSS transform scale */
|
||||
scale?: boolean
|
||||
/** 三维缩放,即 CSS transform scale3d */
|
||||
scale3d?: boolean
|
||||
/** X 方向缩放,即 CSS transform scaleX */
|
||||
scaleX?: boolean
|
||||
/** Y 方向缩放,即 CSS transform scaleY */
|
||||
scaleY?: boolean
|
||||
/** Z 方向缩放,即 CSS transform scaleZ */
|
||||
scaleZ?: boolean
|
||||
/** 倾斜,即 CSS transform skew */
|
||||
skew?: boolean
|
||||
/** X 方向倾斜,即 CSS transform skewX */
|
||||
skewX?: boolean
|
||||
/** Y 方向倾斜,即 CSS transform skewY */
|
||||
skewY?: boolean
|
||||
/** 位移,即 CSS transform translate */
|
||||
translate?: boolean
|
||||
/** 三维位移,即 CSS transform translate3d */
|
||||
translate3d?: boolean
|
||||
/** X 方向位移,即 CSS transform translateX */
|
||||
translateX?: boolean
|
||||
/** Y 方向位移,即 CSS transform translateY */
|
||||
translateY?: boolean
|
||||
/** Z 方向位移,即 CSS transform translateZ */
|
||||
translateZ?: boolean
|
||||
}
|
||||
interface ScrollTimelineKeyframe {
|
||||
composite?: 'replace' | 'add' | 'accumulate' | 'auto'
|
||||
easing?: string
|
||||
offset?: number | null
|
||||
[property: string]: string | number | null | undefined
|
||||
}
|
||||
interface ScrollTimelineOption {
|
||||
/** 指定滚动元素的选择器(只支持 scroll-view),该元素滚动时会驱动动画的进度 */
|
||||
scrollSource: string
|
||||
/** 指定滚动的方向。有效值为 horizontal 或 vertical */
|
||||
orientation?: string
|
||||
/** 指定开始驱动动画进度的滚动偏移量,单位 px */
|
||||
startScrollOffset: number
|
||||
/** 指定停止驱动动画进度的滚动偏移量,单位 px */
|
||||
endScrollOffset: number
|
||||
/** 起始和结束的滚动范围映射的时间长度,该时间可用于与关键帧动画里的时间 (duration) 相匹配,单位 ms */
|
||||
timeRange: number
|
||||
}
|
||||
}
|
||||
/** Component构造器可用于定义组件,调用Component构造器时可以指定组件的属性、数据、方法等。
|
||||
*
|
||||
* * 使用 `this.data` 可以获取内部数据和属性值,但不要直接修改它们,应使用 `setData` 修改。
|
||||
* * 生命周期函数无法在组件方法中通过 `this` 访问到。
|
||||
* * 属性名应避免以 data 开头,即不要命名成 `dataXyz` 这样的形式,因为在 WXML 中, `data-xyz=""` 会被作为节点 dataset 来处理,而不是组件属性。
|
||||
* * 在一个组件的定义和使用时,组件的属性名和 data 字段相互间都不能冲突(尽管它们位于不同的定义段中)。
|
||||
* * 从基础库 `2.0.9` 开始,对象类型的属性和 data 字段中可以包含函数类型的子字段,即可以通过对象类型的属性字段来传递函数。低于这一版本的基础库不支持这一特性。
|
||||
* * `bug` : 对于 type 为 Object 或 Array 的属性,如果通过该组件自身的 `this.setData` 来改变属性值的一个子字段,则依旧会触发属性 observer ,且 observer 接收到的 `newVal` 是变化的那个子字段的值, `oldVal` 为空, `changedPath` 包含子字段的字段名相关信息。
|
||||
*/
|
||||
declare let Component: WechatMiniprogram.Component.Constructor
|
||||
1435
apps/miniprogram/typings/types/wx/lib.wx.event.d.ts
vendored
Normal file
1435
apps/miniprogram/typings/types/wx/lib.wx.event.d.ts
vendored
Normal file
File diff suppressed because it is too large
Load Diff
259
apps/miniprogram/typings/types/wx/lib.wx.page.d.ts
vendored
Normal file
259
apps/miniprogram/typings/types/wx/lib.wx.page.d.ts
vendored
Normal file
@@ -0,0 +1,259 @@
|
||||
/*! *****************************************************************************
|
||||
Copyright (c) 2021 Tencent, Inc. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
***************************************************************************** */
|
||||
|
||||
declare namespace WechatMiniprogram.Page {
|
||||
type Instance<
|
||||
TData extends DataOption,
|
||||
TCustom extends CustomOption
|
||||
> = OptionalInterface<ILifetime> &
|
||||
InstanceProperties &
|
||||
InstanceMethods<TData> &
|
||||
Data<TData> &
|
||||
TCustom
|
||||
type Options<
|
||||
TData extends DataOption,
|
||||
TCustom extends CustomOption
|
||||
> = (TCustom & Partial<Data<TData>> & Partial<ILifetime>) &
|
||||
ThisType<Instance<TData, TCustom>>
|
||||
type TrivialInstance = Instance<IAnyObject, IAnyObject>
|
||||
interface Constructor {
|
||||
<TData extends DataOption, TCustom extends CustomOption>(
|
||||
options: Options<TData, TCustom>
|
||||
): void
|
||||
}
|
||||
interface ILifetime {
|
||||
/** 生命周期回调—监听页面加载
|
||||
*
|
||||
* 页面加载时触发。一个页面只会调用一次,可以在 onLoad 的参数中获取打开当前页面路径中的参数。
|
||||
*/
|
||||
onLoad(
|
||||
/** 打开当前页面路径中的参数 */
|
||||
query: Record<string, string | undefined>
|
||||
): void | Promise<void>
|
||||
/** 生命周期回调—监听页面显示
|
||||
*
|
||||
* 页面显示/切入前台时触发。
|
||||
*/
|
||||
onShow(): void | Promise<void>
|
||||
/** 生命周期回调—监听页面初次渲染完成
|
||||
*
|
||||
* 页面初次渲染完成时触发。一个页面只会调用一次,代表页面已经准备妥当,可以和视图层进行交互。
|
||||
*
|
||||
|
||||
* 注意:对界面内容进行设置的 API 如`wx.setNavigationBarTitle`,请在`onReady`之后进行。
|
||||
*/
|
||||
onReady(): void | Promise<void>
|
||||
/** 生命周期回调—监听页面隐藏
|
||||
*
|
||||
* 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面,小程序切入后台等。
|
||||
*/
|
||||
onHide(): void | Promise<void>
|
||||
/** 生命周期回调—监听页面卸载
|
||||
*
|
||||
* 页面卸载时触发。如`redirectTo`或`navigateBack`到其他页面时。
|
||||
*/
|
||||
onUnload(): void | Promise<void>
|
||||
/** 监听用户下拉动作
|
||||
*
|
||||
* 监听用户下拉刷新事件。
|
||||
* - 需要在`app.json`的`window`选项中或页面配置中开启`enablePullDownRefresh`。
|
||||
* - 可以通过`wx.startPullDownRefresh`触发下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致。
|
||||
* - 当处理完数据刷新后,`wx.stopPullDownRefresh`可以停止当前页面的下拉刷新。
|
||||
*/
|
||||
onPullDownRefresh(): void | Promise<void>
|
||||
/** 页面上拉触底事件的处理函数
|
||||
*
|
||||
* 监听用户上拉触底事件。
|
||||
* - 可以在`app.json`的`window`选项中或页面配置中设置触发距离`onReachBottomDistance`。
|
||||
* - 在触发距离内滑动期间,本事件只会被触发一次。
|
||||
*/
|
||||
onReachBottom(): void | Promise<void>
|
||||
/** 用户点击右上角转发
|
||||
*
|
||||
* 监听用户点击页面内转发按钮(`<button>` 组件 `open-type="share"`)或右上角菜单“转发”按钮的行为,并自定义转发内容。
|
||||
*
|
||||
* **注意:只有定义了此事件处理函数,右上角菜单才会显示“转发”按钮**
|
||||
*
|
||||
* 此事件需要 return 一个 Object,用于自定义转发内容
|
||||
*/
|
||||
onShareAppMessage(
|
||||
/** 分享发起来源参数 */
|
||||
options: IShareAppMessageOption
|
||||
): ICustomShareContent | void
|
||||
/**
|
||||
* 监听右上角菜单“分享到朋友圈”按钮的行为,并自定义分享内容
|
||||
*
|
||||
* 本接口为 Beta 版本,暂只在 Android 平台支持,详见 [分享到朋友圈 (Beta)](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share-timeline.html)
|
||||
*
|
||||
* 基础库 2.11.3 开始支持,低版本需做兼容处理。
|
||||
*/
|
||||
onShareTimeline(): ICustomTimelineContent | void
|
||||
|
||||
/** 页面滚动触发事件的处理函数
|
||||
*
|
||||
* 监听用户滑动页面事件。
|
||||
*/
|
||||
onPageScroll(
|
||||
/** 页面滚动参数 */
|
||||
options: IPageScrollOption
|
||||
): void | Promise<void>
|
||||
|
||||
/** 当前是 tab 页时,点击 tab 时触发,最低基础库: `1.9.0` */
|
||||
onTabItemTap(
|
||||
/** tab 点击参数 */
|
||||
options: ITabItemTapOption
|
||||
): void | Promise<void>
|
||||
|
||||
/** 窗口尺寸改变时触发,最低基础库:`2.4.0` */
|
||||
onResize(
|
||||
/** 窗口尺寸参数 */
|
||||
options: IResizeOption
|
||||
): void | Promise<void>
|
||||
|
||||
/**
|
||||
* 监听用户点击右上角菜单“收藏”按钮的行为,并自定义收藏内容。
|
||||
* 基础库 2.10.3,安卓 7.0.15 版本起支持,iOS 暂不支持
|
||||
*/
|
||||
onAddToFavorites(options: IAddToFavoritesOption): IAddToFavoritesContent
|
||||
}
|
||||
interface InstanceProperties {
|
||||
/** 页面的文件路径 */
|
||||
is: string
|
||||
|
||||
/** 到当前页面的路径 */
|
||||
route: string
|
||||
|
||||
/** 打开当前页面路径中的参数 */
|
||||
options: Record<string, string | undefined>
|
||||
}
|
||||
|
||||
type DataOption = Record<string, any>
|
||||
type CustomOption = Record<string, any>
|
||||
|
||||
type InstanceMethods<D extends DataOption> = Component.InstanceMethods<D>
|
||||
|
||||
interface Data<D extends DataOption> {
|
||||
/** 页面的初始数据
|
||||
*
|
||||
* `data` 是页面第一次渲染使用的**初始数据**。
|
||||
*
|
||||
* 页面加载时,`data` 将会以`JSON`字符串的形式由逻辑层传至渲染层,因此`data`中的数据必须是可以转成`JSON`的类型:字符串,数字,布尔值,对象,数组。
|
||||
*
|
||||
* 渲染层可以通过 `WXML` 对数据进行绑定。
|
||||
*/
|
||||
data: D
|
||||
}
|
||||
|
||||
interface ICustomShareContent {
|
||||
/** 转发标题。默认值:当前小程序名称 */
|
||||
title?: string
|
||||
/** 转发路径,必须是以 / 开头的完整路径。默认值:当前页面 path */
|
||||
path?: string
|
||||
/** 自定义图片路径,可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4,最低基础库: `1.5.0`。默认值:使用默认截图 */
|
||||
imageUrl?: string
|
||||
}
|
||||
|
||||
interface ICustomTimelineContent {
|
||||
/** 自定义标题,即朋友圈列表页上显示的标题。默认值:当前小程序名称 */
|
||||
title?: string
|
||||
/** 自定义页面路径中携带的参数,如 `path?a=1&b=2` 的 “?” 后面部分 默认值:当前页面路径携带的参数 */
|
||||
query?: string
|
||||
/** 自定义图片路径,可以是本地文件路径、代码包文件路径或者网络图片路径。支持 PNG 及 JPG。显示图片长宽比是 1:1。默认值:默认使用小程序 Logo*/
|
||||
imageUrl?: string
|
||||
}
|
||||
|
||||
interface IPageScrollOption {
|
||||
/** 页面在垂直方向已滚动的距离(单位px) */
|
||||
scrollTop: number
|
||||
}
|
||||
|
||||
interface IShareAppMessageOption {
|
||||
/** 转发事件来源。
|
||||
*
|
||||
* 可选值:
|
||||
* - `button`:页面内转发按钮;
|
||||
* - `menu`:右上角转发菜单。
|
||||
*
|
||||
* 最低基础库: `1.2.4`
|
||||
*/
|
||||
from: 'button' | 'menu' | string
|
||||
/** 如果 `from` 值是 `button`,则 `target` 是触发这次转发事件的 `button`,否则为 `undefined`
|
||||
*
|
||||
* 最低基础库: `1.2.4` */
|
||||
target: any
|
||||
/** 页面中包含`<web-view>`组件时,返回当前`<web-view>`的url
|
||||
*
|
||||
* 最低基础库: `1.6.4`
|
||||
*/
|
||||
webViewUrl?: string
|
||||
}
|
||||
|
||||
interface ITabItemTapOption {
|
||||
/** 被点击tabItem的序号,从0开始,最低基础库: `1.9.0` */
|
||||
index: string
|
||||
/** 被点击tabItem的页面路径,最低基础库: `1.9.0` */
|
||||
pagePath: string
|
||||
/** 被点击tabItem的按钮文字,最低基础库: `1.9.0` */
|
||||
text: string
|
||||
}
|
||||
|
||||
interface IResizeOption {
|
||||
size: {
|
||||
/** 变化后的窗口宽度,单位 px */
|
||||
windowWidth: number
|
||||
/** 变化后的窗口高度,单位 px */
|
||||
windowHeight: number
|
||||
}
|
||||
}
|
||||
|
||||
interface IAddToFavoritesOption {
|
||||
/** 页面中包含web-view组件时,返回当前web-view的url */
|
||||
webviewUrl?: string
|
||||
}
|
||||
|
||||
interface IAddToFavoritesContent {
|
||||
/** 自定义标题,默认值:页面标题或账号名称 */
|
||||
title?: string
|
||||
/** 自定义图片,显示图片长宽比为 1:1,默认值:页面截图 */
|
||||
imageUrl?: string
|
||||
/** 自定义query字段,默认值:当前页面的query */
|
||||
query?: string
|
||||
}
|
||||
|
||||
interface GetCurrentPages {
|
||||
(): Array<Instance<IAnyObject, IAnyObject>>
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 注册小程序中的一个页面。接受一个 `Object` 类型参数,其指定页面的初始数据、生命周期回调、事件处理函数等。
|
||||
*/
|
||||
declare let Page: WechatMiniprogram.Page.Constructor
|
||||
/**
|
||||
* 获取当前页面栈。数组中第一个元素为首页,最后一个元素为当前页面。
|
||||
|
||||
* __注意:__
|
||||
|
||||
* - __不要尝试修改页面栈,会导致路由以及页面状态错误。__
|
||||
* - 不要在 `App.onLaunch` 的时候调用 `getCurrentPages()`,此时 `page` 还没有生成。
|
||||
*/
|
||||
declare let getCurrentPages: WechatMiniprogram.Page.GetCurrentPages
|
||||
Reference in New Issue
Block a user