Skip to content

Commit

Permalink
docs(taro): upload types
Browse files Browse the repository at this point in the history
  • Loading branch information
ZakaryCode committed Nov 7, 2019
1 parent e0e1852 commit 881a04b
Show file tree
Hide file tree
Showing 67 changed files with 265 additions and 750 deletions.
6 changes: 2 additions & 4 deletions packages/taro/types/api/base/base.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ declare namespace Taro {
* * `${attribute}` 代表组件属性
* * `${option}` 代表组件属性的可选值
*
* 例子:
*
* **示例:**
*
* @since 1.1.1
* @example
```js
Taro.canIUse('openBluetoothAdapter')
Taro.canIUse('getSystemInfoSync.return.screenWidth')
Expand Down
17 changes: 5 additions & 12 deletions packages/taro/types/api/base/base.debug.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,9 @@ declare namespace Taro {
}
}
/**
* @since 1.4.0
*
* 设置是否打开调试开关,此开关对正式版也能生效。
*
* **示例代码:**
*
* @since 1.4.0
* @example
```javascript
// 打开调试
Taro.setEnableDebug({
Expand All @@ -37,9 +34,8 @@ declare namespace Taro {
namespace getLogManager {
type Param = {
/**
* @since 2.3.2
*
* 取值为0/1,取值为0表示是否会把 App、Page 的生命周期函数和 wx 命名空间下的函数调用写入日志,取值为1则不会。默认值是 0
* @since 2.3.2
*/
level?: number
}
Expand All @@ -63,12 +59,9 @@ declare namespace Taro {
}
}
/**
* @since 2.1.0
*
* 获取日志管理器对象。
*
* **示例代码:**
*
* @since 2.1.0
* @example
```javascript
const logger = Taro.getLogManager({level: 1})
logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3])
Expand Down
20 changes: 2 additions & 18 deletions packages/taro/types/api/base/base.system.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ declare namespace Taro {
type Return = {
/**
* 手机品牌
*
* @since 1.5.0
*/
brand: string
Expand All @@ -21,13 +20,11 @@ declare namespace Taro {
pixelRatio: number
/**
* 屏幕宽度
*
* @since 1.1.0
*/
screenWidth: number
/**
* 屏幕高度
*
* @since 1.1.0
*/
screenHeight: number
Expand All @@ -41,7 +38,6 @@ declare namespace Taro {
windowHeight: number
/**
* 状态栏的高度
*
* @since 1.9.0
*/
statusBarHeight: number
Expand All @@ -63,23 +59,19 @@ declare namespace Taro {
platform: string
/**
* 用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准,单位:px
*
* @since 1.5.0
*/
fontSizeSetting: number
/**
* 客户端基础库版本
*
* @since 1.1.0
*/
SDKVersion: string
}
}
/**
* 获取系统信息同步接口
*
* **示例代码:**
*
* @example
```javascript
try {
var res = Taro.getSystemInfoSync()
Expand All @@ -102,7 +94,6 @@ declare namespace Taro {
type Promised = {
/**
* 手机品牌
*
* @since 1.5.0
*/
brand: string
Expand All @@ -116,13 +107,11 @@ declare namespace Taro {
pixelRatio: string
/**
* 屏幕宽度
*
* @since 1.1.0
*/
screenWidth: number
/**
* 屏幕高度
*
* @since 1.1.0
*/
screenHeight: number
Expand All @@ -136,7 +125,6 @@ declare namespace Taro {
windowHeight: number
/**
* 状态栏的高度
*
* @since 1.9.0
*/
statusBarHeight: number
Expand All @@ -158,13 +146,11 @@ declare namespace Taro {
platform: string
/**
* 用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准,单位:px
*
* @since 1.5.0
*/
fontSizeSetting: number
/**
* 客户端基础库版本
*
* @since 1.1.0
*/
SDKVersion: string
Expand All @@ -173,9 +159,7 @@ declare namespace Taro {
}
/**
* 获取系统信息。
*
* **示例代码:**
*
* @example
```javascript
Taro.getSystemInfo({
success: function(res) {
Expand Down
8 changes: 2 additions & 6 deletions packages/taro/types/api/base/base.update.d.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
declare namespace Taro {
/**
* @since 1.9.90
*
* 获取**全局唯一**的版本更新管理器,用于管理小程序更新。
*
* 关于小程序的更新机制,可以查看 [运行机制](https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/operating-mechanism.html) 文档。
*
* **示例代码:**
*
* @since 1.9.90
* @example
```javascript
const updateManager = Taro.getUpdateManager()
updateManager.onCheckForUpdate(function (res) {
Expand Down
16 changes: 5 additions & 11 deletions packages/taro/types/api/base/base.weapp.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,13 @@ declare namespace Taro {
}
}
/**
* @since 微信小程序 2.1.2
*
* 获取小程序启动时的参数。与 `App.onLaunch` 的回调参数一致。
*
* **注意**
* 部分版本在无 `referrerInfo` 的时候会返回 undefined,
* 建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。
*
* @since 微信小程序 2.1.2
* @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html
*/
function getLaunchOptionsSync(): getLaunchOptionsSync.Return
Expand Down Expand Up @@ -68,10 +67,8 @@ declare namespace Taro {
type onPageNotFoundCallback = (parma: onPageNotFoundCallbackParam) => void
}
/**
* @since 微信小程序 2.1.2
*
* 监听小程序要打开的页面不存在事件。该事件与 `App.onPageNotFound` 的回调时机一致
*
* @since 微信小程序 2.1.2
*/
function onPageNotFound(callback: onPageNotFound.onPageNotFoundCallback): void

Expand All @@ -86,23 +83,20 @@ declare namespace Taro {
type onErrorCallback = (param: onErrorParam) => void
}
/**
* @since 微信小程序 2.1.2
*
* 监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 App.onError 的回调时机与参数一致
* @since 微信小程序 2.1.2
*/
function onError(callback: onError.onErrorCallback): void

/**
* @since 微信小程序 2.6.2
*
* 监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功
* @since 微信小程序 2.6.2
*/
function onAudioInterruptionEnd(callback: () => void): void

/**
* @since 微信小程序 2.6.2
*
* 监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件:闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后,小程序内所有音频会暂停
* @since 微信小程序 2.6.2
*/
function onAudioInterruptionBegin(callback: () => void): void

Expand Down
18 changes: 5 additions & 13 deletions packages/taro/types/api/device/device.accelerometer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,9 @@ declare namespace Taro {
type Param = {}
}
/**
* @since 1.1.0
*
* 停止监听加速度数据。
*
* **示例代码:**
*
* @since 1.1.0
* @example
```javascript
Taro.stopAccelerometer()
```
Expand All @@ -20,12 +17,9 @@ declare namespace Taro {
type Param = {}
}
/**
* @since 1.1.0
*
* 开始监听加速度数据。
*
* **示例代码:**
*
* @since 1.1.0
* @example
```javascript
Taro.startAccelerometer()
```
Expand All @@ -52,9 +46,7 @@ declare namespace Taro {
}
/**
* 监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可使用 `Taro.stopAccelerometer` 停止监听。
*
* **示例代码:**
*
* @example
```javascript
Taro.onAccelerometerChange(function(res) {
console.log(res.x)
Expand Down
Loading

0 comments on commit 881a04b

Please sign in to comment.