Skip to content

Commit abb02ae

Browse files
committed
refactor(types): sync components types
1 parent f294658 commit abb02ae

File tree

4 files changed

+15
-9
lines changed

4 files changed

+15
-9
lines changed

docs/apis/network/request/request.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ sidebar_label: request
5555
| mode | `keyof CorsMode` | `"same-origin"` | 否 | 设置是否允许跨域请求<br />API 支持度: h5 |
5656
| credentials | `keyof Credentials` | `"omit"` | 否 | 设置是否携带 Cookie<br />API 支持度: h5 |
5757
| cache | `keyof Cache` | `"default"` | 否 | 设置缓存模式<br />API 支持度: h5 |
58-
| retryTimes | `number` | `2` | 否 | 设置请求重试次数<br />API 支持度: h5 |
59-
| backup | string or string[] | | 否 | 设置请求的兜底接口<br />API 支持度: h5 |
58+
| retryTimes | `number` | `2` | 否 | 设置请求重试次数<br />API 支持度: h5<br />h5: 仅在 jsonp 模式下生效 |
59+
| backup | string or string[] | | 否 | 设置请求的兜底接口<br />API 支持度: h5<br />h5: 仅在 jsonp 模式下生效 |
6060
| signal | `AbortSignal` | | 否 | 设置请求中止信号<br />API 支持度: h5 |
61-
| dataCheck | `() => boolean` | | 否 | 设置请求响应的数据校验函数,若返回 false,则请求兜底接口,若无兜底接口,则报请求失败<br />API 支持度: h5 |
62-
| useStore | `boolean` | `false` | 否 | 设置请求是否使用缓存<br />API 支持度: h5 |
63-
| storeCheckKey | `string` | | 否 | 设置请求缓存校验的 key<br />API 支持度: h5 |
64-
| storeSign | `string` | | 否 | 设置请求缓存签名<br />API 支持度: h5 |
61+
| dataCheck | `() => boolean` | | 否 | 设置请求响应的数据校验函数,若返回 false,则请求兜底接口,若无兜底接口,则报请求失败<br />API 支持度: h5<br />h5: 仅在 jsonp 模式下生效 |
62+
| useStore | `boolean` | `false` | 否 | 设置请求是否使用缓存<br />API 支持度: h5<br />h5: 仅在 jsonp 模式下生效 |
63+
| storeCheckKey | `string` | | 否 | 设置请求缓存校验的 key<br />API 支持度: h5<br />h5: 仅在 jsonp 模式下生效 |
64+
| storeSign | `string` | | 否 | 设置请求缓存签名<br />API 支持度: h5<br />h5: 仅在 jsonp 模式下生效 |
6565
| storeCheck | `() => boolean` | | 否 | 设置请求校验函数,一般不需要设置<br />API 支持度: h5 |
6666

6767
### SuccessCallbackResult

docs/components/viewContainer/scroll-view.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ export default {
259259
| ScrollViewProps.reverse | ✔️ | | | | | | | | |
260260
| ScrollViewProps.cacheExtent | ✔️ | | | | | | | | |
261261
| ScrollViewProps.scrollIntoViewWithinExtent | ✔️ | | | | | | | | |
262-
| ScrollViewProps.scrollIntoViewAlignment | ✔️ | | | | | | | | |
262+
| ScrollViewProps.scrollIntoViewAlignment | ✔️ | | | | | | ✔️ | | |
263263
| ScrollViewProps.onScrollToUpper | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
264264
| ScrollViewProps.onScrollToLower | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
265265
| ScrollViewProps.onScroll | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |

packages/taro-components/types/ScrollView.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { ComponentType } from 'react'
2-
import { StandardProps, CommonEventFunction, BaseEventOrigFunction } from './common'
2+
import { BaseEventOrigFunction, CommonEventFunction, StandardProps } from './common'
33
interface ScrollViewProps extends StandardProps {
44
/** 允许横向滚动
55
* @default false
@@ -157,7 +157,7 @@ interface ScrollViewProps extends StandardProps {
157157
* center - 目标节点显示在视口中间
158158
* end - 目标节点显示在视口结束处
159159
* nearest - 目标节点在就近的视口边缘显示,若节点已在视口内则不触发滚动
160-
* @supported weapp
160+
* @supported weapp, h5
161161
* @default 'start'
162162
*/
163163
scrollIntoViewAlignment?: 'start' | 'center' | 'end' | 'nearest'

packages/taro/types/api/network/request.d.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,12 @@ declare module '../../index' {
106106
/** 设置请求重试次数
107107
* @default 2
108108
* @supported h5
109+
* @h5 仅在 jsonp 模式下生效
109110
*/
110111
retryTimes?: number
111112
/** 设置请求的兜底接口
112113
* @supported h5
114+
* @h5 仅在 jsonp 模式下生效
113115
*/
114116
backup?: string | string[]
115117
/** 设置请求中止信号
@@ -118,19 +120,23 @@ declare module '../../index' {
118120
signal?: AbortSignal
119121
/** 设置请求响应的数据校验函数,若返回 false,则请求兜底接口,若无兜底接口,则报请求失败
120122
* @supported h5
123+
* @h5 仅在 jsonp 模式下生效
121124
*/
122125
dataCheck?(): boolean
123126
/** 设置请求是否使用缓存
124127
* @default false
125128
* @supported h5
129+
* @h5 仅在 jsonp 模式下生效
126130
*/
127131
useStore?: boolean
128132
/** 设置请求缓存校验的 key
129133
* @supported h5
134+
* @h5 仅在 jsonp 模式下生效
130135
*/
131136
storeCheckKey?: string
132137
/** 设置请求缓存签名
133138
* @supported h5
139+
* @h5 仅在 jsonp 模式下生效
134140
*/
135141
storeSign?: string
136142
/** 设置请求校验函数,一般不需要设置

0 commit comments

Comments
 (0)