Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@dcloudio/types
Advanced tools
@dcloudio/types - npm Package Compare versions
Comparing version 0.1.8 to 0.2.0
| { | ||
| "name": "@dcloudio/types", | ||
| "version": "0.1.8", | ||
| "version": "0.2.0", | ||
| "description": "uni-app types", | ||
@@ -5,0 +5,0 @@ "typings": "index.d.ts", |
| declare namespace App { | ||
| interface ILaunchOptions { | ||
| query: number; | ||
| } | ||
| interface IReferrerInfo { | ||
| interface ReferrerInfo { | ||
| /** | ||
@@ -19,83 +15,18 @@ * 来源小程序或公众号或App的 appId | ||
| appId: string; | ||
| /** 来源小程序传过来的数据，scene=1037或1038时支持 */ | ||
| /** | ||
| * 来源小程序传过来的数据，scene=1037或1038时支持 | ||
| */ | ||
| extraData?: any; | ||
| } | ||
| type SceneValues = 1001 | ||
| | 1005 | ||
| | 1006 | ||
| | 1007 | ||
| | 1008 | ||
| | 1011 | ||
| | 1012 | ||
| | 1013 | ||
| | 1014 | ||
| | 1017 | ||
| | 1019 | ||
| | 1020 | ||
| | 1022 | ||
| | 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 | ||
| | 1054 | ||
| | 1056 | ||
| | 1057 | ||
| | 1058 | ||
| | 1059 | ||
| | 1064 | ||
| | 1067 | ||
| | 1068 | ||
| | 1069 | ||
| | 1071 | ||
| | 1072 | ||
| | 1073 | ||
| | 1074 | ||
| | 1077 | ||
| | 1078 | ||
| | 1079 | ||
| | 1081 | ||
| | 1082 | ||
| | 1084 | ||
| | 1089 | ||
| | 1090 | ||
| | 1091 | ||
| | 1092 | ||
| | 1095 | ||
| | 1096 | ||
| | 1097 | ||
| | 1099 | ||
| | 1102 | ||
| | 1103 | ||
| | 1104 | ||
| | number; | ||
| interface ILaunchShowOption { | ||
| /** 打开小程序的路径 */ | ||
| interface LaunchShowOption { | ||
| /** | ||
| * 打开小程序的路径 | ||
| */ | ||
| path: string; | ||
| /** 打开小程序的query */ | ||
| query: IAnyObject; | ||
| /** | ||
| * 打开小程序的query | ||
| */ | ||
| query: AnyObject; | ||
| /** | ||
| * 打开小程序的场景值 | ||
@@ -133,3 +64,3 @@ * - 1001: 发现栏小程序主入口，「最近使用」列表（基础库2.2.4版本起包含「我的小程序」列表） | ||
| * - 1043: 公众号模板消息 | ||
| * - 1044: 带 shareTicket 的小程序消息卡片 [详情]((转发#获取更多转发信息)) | ||
| * - 1044: 带 shareTicket 的小程序消息卡片 | ||
| * - 1045: 朋友圈广告 | ||
@@ -173,32 +104,45 @@ * - 1046: 朋友圈广告详情页 | ||
| */ | ||
| scene: SceneValues; | ||
| /** shareTicket，详见 [获取更多转发信息]((转发#获取更多转发信息)) */ | ||
| scene: number; | ||
| /** | ||
| * 打开小程序的场景值 | ||
| */ | ||
| shareTicket: string; | ||
| /** 当场景为由从另一个小程序或公众号或App打开时，返回此字段 */ | ||
| referrerInfo?: IReferrerInfo; | ||
| /** | ||
| * 当场景为由从另一个小程序或公众号或App打开时，返回此字段 | ||
| */ | ||
| referrerInfo?: ReferrerInfo; | ||
| } | ||
| interface IPageNotFoundOption { | ||
| /** 不存在页面的路径 */ | ||
| interface PageNotFoundOption { | ||
| /** | ||
| * 不存在页面的路径 | ||
| */ | ||
| path: string; | ||
| /** 打开不存在页面的 query */ | ||
| query: IAnyObject; | ||
| /** 是否本次启动的首个页面（例如从分享等入口进来，首个页面是开发者配置的分享页面） */ | ||
| /** | ||
| * 打开不存在页面的 query | ||
| */ | ||
| query: AnyObject; | ||
| /** | ||
| * 是否本次启动的首个页面（例如从分享等入口进来，首个页面是开发者配置的分享页面） | ||
| */ | ||
| isEntryPage: boolean; | ||
| } | ||
| interface AppInstance<T extends IAnyObject = {}> { | ||
| interface AppInstance<T extends AnyObject = {}> { | ||
| /** | ||
| * 生命周期回调—监听应用初始化 | ||
| * 生命周期回调 监听应用初始化 | ||
| * | ||
| * 应用初始化完成时触发，全局只触发一次。 | ||
| */ | ||
| onLaunch?(options?: ILaunchShowOption): void; | ||
| onLaunch?(options?: LaunchShowOption): void; | ||
| /** | ||
| * 生命周期回调—监听应用显示 | ||
| * 应用启动，或从后台进入前台显示时 | ||
| * 生命周期回调 监听应用显示 | ||
| * | ||
| * 应用启动，或从后台进入前台显示时触发 | ||
| */ | ||
| onShow?(options?: ILaunchShowOption): void; | ||
| onShow?(options?: LaunchShowOption): void; | ||
| /** | ||
| * 生命周期回调—监听应用隐藏 | ||
| * 应用从前台进入后台时 | ||
| * 生命周期回调 监听应用隐藏 | ||
| * | ||
| * 应用从前台进入后台时触发 | ||
| */ | ||
@@ -208,7 +152,9 @@ onHide?(): void; | ||
| * 错误监听函数 | ||
| * 应用发生脚本错误，或者 api | ||
| * 小程序发生脚本错误或 API 调用报错时触发 | ||
| * @param error 错误信息，包含堆栈 | ||
| */ | ||
| onError?(/** 错误信息，包含堆栈 */error?: string): void; | ||
| onError?(error?: string): void; | ||
| /** | ||
| * 页面不存在监听函数 | ||
| * | ||
| * 应用要打开的页面不存在时触发，会带上页面信息回调该函数 | ||
@@ -219,12 +165,17 @@ * | ||
| * 2. 如果 `onPageNotFound` 回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再回调 `onPageNotFound`。 | ||
| */ | ||
| onPageNotFound?(options?: PageNotFoundOption): void; | ||
| /** | ||
| * 监听 nvue 页面消息 | ||
| * | ||
| * nvue 页面使用 `uni.postMessage` 发送消息时触发 | ||
| */ | ||
| onPageNotFound?(options?: IPageNotFoundOption): void; | ||
| onUniNViewMessage?(options: AnyObject): void; | ||
| } | ||
| type AppConstructor = <T extends IAnyObject & AppInstance>( | ||
| type AppConstructor = <T extends AnyObject & AppInstance>( | ||
| options: AppInstance<T> & T, | ||
| ) => void; | ||
| interface IGetAppOption { | ||
| interface GetAppOption { | ||
| /** | ||
@@ -236,3 +187,3 @@ * 在 `App` 未定义时返回默认实现。当App被调用时，默认实现中定义的属性会被覆盖合并到App中。一般用于独立分包 | ||
| type GetApp = <T extends IAnyObject>(opts?: IGetAppOption) => AppInstance<T> & T; | ||
| type GetApp = <T extends AnyObject>(opts?: GetAppOption) => AppInstance<T> & T; | ||
| } | ||
@@ -242,4 +193,4 @@ | ||
| declare const createApp: any | ||
| declare const createPage: any | ||
| declare const createComponent: any | ||
| declare const createApp: any; | ||
| declare const createPage: any; | ||
| declare const createComponent: any; |
@@ -1,5 +0,5 @@ | ||
| declare type IAnyObject = Record<string, any>; | ||
| type AnyObject = Record<string, any>; | ||
| declare type KVInfer<T> = { [K in keyof T]: T[K] }; | ||
| type KVInfer<T> = { [K in keyof T]: T[K] }; | ||
| declare type Void<T> = T | undefined | null; | ||
| type Void<T> = T | undefined | null; |
| declare namespace Page { | ||
| interface ICustomShareContent { | ||
| interface CustomShareContent { | ||
| /** | ||
@@ -18,5 +17,5 @@ * 转发标题。默认值：当前应用名称 | ||
| interface IPageScrollOption { | ||
| interface PageScrollOption { | ||
| /** | ||
| * 页面在垂直方向已滚动的距离（单位px） | ||
| * 页面在垂直方向已滚动的距离（单位 px） | ||
| */ | ||
@@ -26,11 +25,10 @@ scrollTop: number; | ||
| interface IShareAppMessageOption { | ||
| /** 转发事件来源。 | ||
| * | ||
| interface ShareAppMessageOption { | ||
| /** | ||
| * 转发事件来源。 | ||
| * 可选值： | ||
| * - `button`：页面内转发按钮； | ||
| * - `menu`：右上角转发菜单。 | ||
| * | ||
| */ | ||
| from: "button" | "menu" | string; | ||
| from: "button" | "menu"; | ||
| /** | ||
@@ -41,3 +39,3 @@ * 如果 `from` 值是 `button`，则 `target` 是触发这次转发事件的 `button`，否则为 `undefined` | ||
| /** | ||
| * 页面中包含`<web-view>`组件时，返回当前`<web-view>`的url | ||
| * 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的url | ||
| */ | ||
@@ -47,13 +45,13 @@ webViewUrl?: string; | ||
| interface ITabItemTapOption { | ||
| interface TabItemTapOption { | ||
| /** | ||
| * 被点击tabItem的序号，从0开始 | ||
| * 被点击 tabItem 的序号，从0开始 | ||
| */ | ||
| index: string; | ||
| /** | ||
| * 被点击tabItem的页面路径 | ||
| * 被点击 tabItem 的页面路径 | ||
| */ | ||
| pagePath: string; | ||
| /** | ||
| * 被点击tabItem的按钮文字 | ||
| * 被点击 tabItem 的按钮文字 | ||
| */ | ||
@@ -63,22 +61,42 @@ text: string; | ||
| interface PageInstanceBaseProps<D extends IAnyObject = any> { | ||
| interface NavigationBarButtonTapOption { | ||
| /** | ||
| * 到当前页面的路径，类型为`String` | ||
| * 原生标题栏按钮数组的下标 | ||
| */ | ||
| index: string; | ||
| } | ||
| interface BackPressOption { | ||
| /** | ||
| * - backbutton 顶部导航栏左边的返回按钮或 Android 实体返回键 | ||
| * - navigateBack 返回 API，即 uni.navigateBack() | ||
| */ | ||
| from: 'backbutton' | 'navigateBack'; | ||
| } | ||
| interface NavigationBarSearchInputChangedOption { | ||
| /** | ||
| * 搜索输入框输入内容 | ||
| */ | ||
| text: string; | ||
| } | ||
| interface PageInstanceBaseProps<D extends AnyObject = any> { | ||
| /** | ||
| * 到当前页面的路径，类型为 `String` | ||
| */ | ||
| route?: string; | ||
| } | ||
| interface PageInstance<D extends IAnyObject = any, T extends IAnyObject = any> extends PageInstanceBaseProps<D> { | ||
| interface PageInstance<D extends AnyObject = any, T extends AnyObject = any> extends PageInstanceBaseProps<D> { | ||
| /** | ||
| * 生命周期回调—监听页面加载 | ||
| * 生命周期回调 监听页面加载 | ||
| * | ||
| * 页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。 | ||
| * @param query 打开当前页面路径中的参数 | ||
| */ | ||
| onLoad?( | ||
| /** | ||
| * 打开当前页面路径中的参数 | ||
| */ | ||
| query?: { [queryKey: string]: string }, | ||
| ): void; | ||
| onLoad?(query?: AnyObject): void; | ||
| /** | ||
| * 生命周期回调—监听页面显示 | ||
| * 生命周期回调 监听页面显示 | ||
| * | ||
| * 页面显示/切入前台时触发。 | ||
@@ -88,3 +106,4 @@ */ | ||
| /** | ||
| * 生命周期回调—监听页面初次渲染完成 | ||
| * 生命周期回调 监听页面初次渲染完成 | ||
| * | ||
| * 页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。 | ||
@@ -94,3 +113,4 @@ */ | ||
| /** | ||
| * 生命周期回调—监听页面隐藏 | ||
| * 生命周期回调 监听页面隐藏 | ||
| * | ||
| * 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，应用切入后台等。 | ||
@@ -100,4 +120,5 @@ */ | ||
| /** | ||
| * 生命周期回调—监听页面卸载 | ||
| * 页面卸载时触发。如`redirectTo`或`navigateBack`到其他页面时。 | ||
| * 生命周期回调 监听页面卸载 | ||
| * | ||
| * 页面卸载时触发。如 `redirectTo` 或 `navigateBack` 到其他页面时。 | ||
| */ | ||
@@ -107,6 +128,5 @@ onUnload?(): void; | ||
| * 监听用户下拉动作 | ||
| * 监听用户下拉刷新事件。 | ||
| * - 需要在`pages.json`的页面配置中开启`enablePullDownRefresh`。 | ||
| * - 可以通过`uni.startPullDownRefresh`触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 | ||
| * - 当处理完数据刷新后，`uni.stopPullDownRefresh`可以停止当前页面的下拉刷新。 | ||
| * - 需要在 `pages.json` 的页面配置中开启 `enablePullDownRefresh` 。 | ||
| * - 可以通过 `uni.startPullDownRefresh` 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 | ||
| * - 当处理完数据刷新后，`uni.stopPullDownRefresh` 可以停止当前页面的下拉刷新。 | ||
| */ | ||
@@ -116,4 +136,3 @@ onPullDownRefresh?(): void; | ||
| * 页面上拉触底事件的处理函数 | ||
| * 监听用户上拉触底事件。 | ||
| * - 可以在`pages.json`的页面配置中设置触发距离`onReachBottomDistance`。 | ||
| * - 可以在 `pages.json` 的页面配置中设置触发距离 `onReachBottomDistance` 。 | ||
| * - 在触发距离内滑动期间，本事件只会被触发一次。 | ||
@@ -124,41 +143,59 @@ */ | ||
| * 用户点击右上角转发 | ||
| * | ||
| * 监听用户点击页面内转发按钮（`<button>` 组件 `open-type="share"`）或右上角菜单“转发”按钮的行为，并自定义转发内容。 | ||
| * **注意：只有定义了此事件处理函数，右上角菜单才会显示“转发”按钮** | ||
| * 此事件需要 return 一个 Object，用于自定义转发内容 | ||
| * @param options 分享发起来源参数 | ||
| * @return 转发内容 | ||
| */ | ||
| onShareAppMessage?( | ||
| /** | ||
| * 分享发起来源参数 | ||
| */ | ||
| options?: IShareAppMessageOption, | ||
| ): ICustomShareContent; | ||
| onShareAppMessage?(options?: ShareAppMessageOption): CustomShareContent; | ||
| /** | ||
| * 页面滚动触发事件的处理函数 | ||
| * | ||
| * 监听用户滑动页面事件。 | ||
| * @param options 页面滚动参数 | ||
| */ | ||
| onPageScroll?( | ||
| /** | ||
| * 页面滚动参数 | ||
| */ | ||
| options?: IPageScrollOption, | ||
| ): void; | ||
| onPageScroll?(options?: PageScrollOption): void; | ||
| /** | ||
| * 页面尺寸改变时触发 | ||
| * @param options 页面滚动参数 | ||
| */ | ||
| onResize?(options?: PageScrollOption): void; | ||
| /** | ||
| * 当前是 tab 页时，点击 tab 时触发 | ||
| * @param options tab 点击参数 | ||
| */ | ||
| onTabItemTap?( | ||
| /** | ||
| * tab 点击参数 | ||
| */ | ||
| options?: ITabItemTapOption, | ||
| ): void; | ||
| onTabItemTap?(options?: TabItemTapOption): void; | ||
| /** | ||
| * 监听原生标题栏按钮点击事件 | ||
| * @param options tab 点击参数 | ||
| */ | ||
| onNavigationBarButtonTap?(options?: NavigationBarButtonTapOption): void; | ||
| /** | ||
| * 监听页面返回 | ||
| * @param options tab 点击参数 | ||
| * @return 返回 `true` 时阻止页面返回 | ||
| */ | ||
| onBackPress?(options?: BackPressOption): any; | ||
| /** | ||
| * 监听原生标题栏搜索输入框输入内容变化事件 | ||
| * @param options tab 点击参数 | ||
| * @return 返回 `true` 时阻止页面返回 | ||
| */ | ||
| onNavigationBarSearchInputChanged?(options?: NavigationBarSearchInputChangedOption): any; | ||
| /** | ||
| * 监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。 | ||
| */ | ||
| onNavigationBarSearchInputConfirmed?(): any; | ||
| /** | ||
| * 监听原生标题栏搜索输入框点击事件 | ||
| */ | ||
| onNavigationBarSearchInputClicked?(): any; | ||
| } | ||
| type PageConstructor = <D extends IAnyObject, T extends IAnyObject & PageInstance>( | ||
| options: PageInstance<D, T> & T, | ||
| ) => void; | ||
| type PageConstructor = <T extends AnyObject & PageInstance>( | ||
| options: PageInstance<AnyObject, T> & T, | ||
| ) => void; | ||
| type GetCurrentPages = <D extends IAnyObject = {}, T extends IAnyObject = {}>() => Array<PageInstance<D, T> & T>; | ||
| type GetCurrentPages = <T extends AnyObject = {}>() => Array<PageInstance<AnyObject, T> & T>; | ||
| } | ||
| declare const getCurrentPages: Page.GetCurrentPages; |
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.76%
890705
- Lines of code
- increased by0.82%
22135
- Number of medium supply chain risk alerts
- decreased by-100%
0
No dependency changes