TS 现在已经火的不行了
TypeScript 已经火的不行了，我们从小程序看 TypeScript, 学习 TypeScript。我们使用
📚📚从小程序的类型的类型分析开始
miniprogram-api-typings 是一个腾讯官方提供的一个微信小程序包，里面后小程序API 类型的约束，我们可以通过使用官方的类型约束，来开发TS版本的小程序。
分析的方式是用树形分析，来分析, 顶层到底层分析，全面的了解 .d.ts 和 微信小程序的相关的数据。
顶层声明的小程序 namespace: WechatMiniprogram, DB, ICloud
WechatMiniprogram 下面的命名空间 Page， Component, Behavior, App,
搞明白 ts 中的一些概念
- 泛型、泛型参数，类型约束
- 交叉类型
- TS映射 Partial， ThisType， Record
- 获取键 keyof
- 遍历 in
type Partial = { [P in keyof T]?: T[P] };
type Record<K extends keyof any, T> = { [P in K]: T; };
interface ThisType { }
/// <reference path="./wx/index.d.ts" />
/* index.d.ts 顶层生命别名和接口*/
type Instance
type Options
type TrivialInstance
interface Constructor
interface ILifetime
interface InstanceProperties
type DataOption
type CustomOption
type InstanceMethods
interface Data
interface ICustomShareContent
interface IPageScrollOption
interface IShareAppMessageOption
interface ITabItemTapOption
interface IResizeOption
interface getCurrentPages
TData? type DataOption = Record<string, any> DataOption? type DataOption = Record<string, any> TCustom? type CustomOption = Record<string, any> CustomOption? type CustomOption = Record<string, any> OptionalInterface? ILifetime? InstanceProperties? InstanceMethods? TData? Data? TCustom?
/* wx/index.d.ts*/
/// <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" />
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]> }
}
lib.wx.page.d.ts
/*顶层 declare 语句*/
declare namespace WechatMiniprogram {}
declare const Page: WechatMiniprogram.Page.Constructor
declare const getCurrentPages: WechatMiniprogram.Page.getCurrentPages
declare namespace WechatMiniprogram {
namespace 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
/** 生命周期回调—监听页面显示
*
* 页面显示/切入前台时触发。
*/
onShow(): void
/** 生命周期回调—监听页面初次渲染完成
*
* 页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。
*
* 注意：对界面内容进行设置的 API 如`wx.setNavigationBarTitle`，请在`onReady`之后进行。
*/
onReady(): void
/** 生命周期回调—监听页面隐藏
*
* 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，小程序切入后台等。
*/
onHide(): void
/** 生命周期回调—监听页面卸载
*
* 页面卸载时触发。如`redirectTo`或`navigateBack`到其他页面时。
*/
onUnload(): void
/** 监听用户下拉动作
*
* 监听用户下拉刷新事件。
* - 需要在`app.json`的`window`选项中或页面配置中开启`enablePullDownRefresh`。
* - 可以通过`wx.startPullDownRefresh`触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。
* - 当处理完数据刷新后，`wx.stopPullDownRefresh`可以停止当前页面的下拉刷新。
*/
onPullDownRefresh(): void
/** 页面上拉触底事件的处理函数
*
* 监听用户上拉触底事件。
* - 可以在`app.json`的`window`选项中或页面配置中设置触发距离`onReachBottomDistance`。
* - 在触发距离内滑动期间，本事件只会被触发一次。
*/
onReachBottom(): void
/** 用户点击右上角转发
*
* 监听用户点击页面内转发按钮（`<button>` 组件 `open-type="share"`）或右上角菜单“转发”按钮的行为，并自定义转发内容。
*
* **注意：只有定义了此事件处理函数，右上角菜单才会显示“转发”按钮**
*
* 此事件需要 return 一个 Object，用于自定义转发内容
*/
onShareAppMessage(
/** 分享发起来源参数 */
options: IShareAppMessageOption,
): ICustomShareContent
/** 页面滚动触发事件的处理函数
*
* 监听用户滑动页面事件。
*/
onPageScroll(
/** 页面滚动参数 */
options: IPageScrollOption,
): void
/** 当前是 tab 页时，点击 tab 时触发，最低基础库： `1.9.0` */
onTabItemTap(
/** tab 点击参数 */
options: ITabItemTapOption,
): void
/** 窗口尺寸改变时触发，最低基础库：`2.4.0` */
onResize(
/** 窗口尺寸参数 */
options: IResizeOption,
): void
}
interface InstanceProperties {
/** 页面的文件路径 */
is: string
/** 到当前页面的路径 */
route: string
}
type DataOption = Record<string, any>
type CustomOption = Record<string, any>
type InstanceMethods<D extends DataOption> = Component.InstanceMethods<
D
> & {
getOpenerEventChannel(): EventChannel,
}
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 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 getCurrentPages {
(): Array<Instance<IAnyObject, IAnyObject>>
}
}
}
