Skip to content

Commit a02615d

Browse files
committed
chore: modify typedoc config.
1 parent b92f3d6 commit a02615d

File tree

3 files changed

+19
-14
lines changed

3 files changed

+19
-14
lines changed

index.d.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,15 @@ export interface AuthResult {
129129
}
130130
/**
131131
* 支付
132-
* @param payInfo 支付详情
132+
* @param payInfo 支付详情,是后台拼接好的支付参数
133133
* @returns result 支付宝回调结果 https://docs.open.alipay.com/204/105301
134134
*/
135135
export function alipay(payInfo: string): Promise<OrderResult>;
136136
/**
137137
* 快速登录授权
138+
* - ⚠️ 注意授权成功返回结果是一个字符串,[返回内容](https://github.com/uiwjs/react-native-alipay/blob/74140a294e850884ed1851b9d2c2d2c00ee75003/index.d.ts#L89-L113)
139+
* - ⚠️ 支付宝需要设置 Scheme 和 iOS添加原生代码,才能支持验证[回弹商家APP]的功能
140+
* - ⚠️ 支付宝 `管理中心-支付宝开放平台` 需要签约 `APP支付宝登录`
138141
* @param authInfoStr 验证详情
139142
* @returns result 支付宝回调结果 https://opendocs.alipay.com/open/218/105327
140143
*/

tsconfig.json

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"compilerOptions": {
3+
},
4+
"typedocOptions": {
5+
"entryPoints": ["./index.d.ts"],
6+
"out": "typedoc",
7+
"name": "React Native Alipay",
8+
"theme": "minimal",
9+
"excludeExternals": true,
10+
"excludePrivate": true,
11+
"excludeProtected": true,
12+
"toc": ["EntryClass", "ImportantInterface"],
13+
"hideGenerator": true
14+
}
15+
}

typedoc.json

-13
This file was deleted.

0 commit comments

Comments
 (0)