-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathwx.d.ts
13558 lines (13375 loc) · 394 KB
/
wx.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Generated at 2018-10-7
declare namespace wx {
namespace request {
type Param = {
/**
* 开发者服务器接口地址
*/
url: string
/**
* 请求的参数
*/
data?: any | string | ArrayBuffer
/**
* 设置请求的 header,header 中不能设置 Referer。
*/
header?: any
/**
* (需大写)有效值:OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT
*
* @default GET
*/
method?: string
/**
* 如果设为json,会尝试对返回的数据做一次 JSON.parse
*
* @default json
*/
dataType?: string
/**
* 设置响应的数据类型。合法值:text、arraybuffer
*
* @default text
* @since 1.7.0
*/
responseType?: string
/**
* 收到开发者服务成功返回的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 收到开发者服务成功返回的回调函数
*/
type ParamPropSuccess = (res: ParamPropSuccessParam) => any
type ParamPropSuccessParam = {
/**
* 开发者服务器返回的数据
*
* **data 数据说明:**
*
* 最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String 。转换规则如下:
*
* * 对于 `GET` 方法的数据,会将数据转换成 query string(encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...)
* * 对于 `POST` 方法且 `header['content-type']` 为 `application/json` 的数据,会对数据进行 JSON 序列化
* * 对于 `POST` 方法且 `header['content-type']` 为 `application/x-www-form-urlencoded` 的数据,会将数据转换成 query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...)
*/
data: any | string | ArrayBuffer
/**
* 开发者服务器返回的 HTTP 状态码
*/
statusCode: number
/**
* 开发者服务器返回的 HTTP Response Header
*
* @since 1.2.0
*/
header: any
}
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
type Return = {
/**
* 中断请求任务
*
* @since 1.4.0
*/
abort: ReturnPropAbort
}
/**
* 中断请求任务
*/
type ReturnPropAbort = () => any
}
/**
* 发起网络请求。**使用前请先阅读[说明](https://developers.weixin.qq.com/miniprogram/dev/api/api-network.html)**。
*
* **返回值:**
*
* @since 1.4.0
*
* 返回一个 `requestTask` 对象,通过 `requestTask`,可中断请求任务。
*
* **Bug & Tip:**
*
* 1. `tip`: content-type 默认为 'application/json';
* 2. `bug`: 开发者工具 `0.10.102800` 版本,`header` 的 `content-type` 设置异常;
*
* **示例代码:**
*
* ```javascript
* wx.request({
* url: 'test.php', //仅为示例,并非真实的接口地址
* data: {
* x: '' ,
* y: ''
* },
* header: {
* 'content-type': 'application/json' // 默认值
* },
* success: function(res) {
* console.log(res.data)
* }
* })
* ```
*
* **示例代码:**
*
* ```javascript
* const requestTask = wx.request({
* url: 'test.php', //仅为示例,并非真实的接口地址
* data: {
* x: '' ,
* y: ''
* },
* header: {
* 'content-type': 'application/json'
* },
* success: function(res) {
* console.log(res.data)
* }
* })
*
* requestTask.abort() // 取消请求任务
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-request.html#wxrequestobject
*/
function request(OBJECT: request.Param): request.Return
namespace uploadFile {
type Param = {
/**
* 开发者服务器 url
*/
url: string
/**
* 要上传文件资源的路径
*/
filePath: string
/**
* 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容
*/
name: string
/**
* HTTP 请求 Header, header 中不能设置 Referer
*/
header?: any
/**
* HTTP 请求中其他额外的 form data
*/
formData?: any
/**
* 接口调用成功的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 接口调用成功的回调函数
*/
type ParamPropSuccess = (res: ParamPropSuccessParam) => any
type ParamPropSuccessParam = {
/**
* 开发者服务器返回的数据
*/
data: string
/**
* 开发者服务器返回的 HTTP 状态码
*/
statusCode: number
}
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
type Return = {
/**
* 监听上传进度变化
*
* @since 1.4.0
*/
onProgressUpdate: ReturnPropOnProgressUpdate
/**
* 中断上传任务
*
* @since 1.4.0
*/
abort: ReturnPropAbort
}
/**
* 监听上传进度变化
*/
type ReturnPropOnProgressUpdate = (callback: ReturnPropOnProgressUpdateParam) => any
type ReturnPropOnProgressUpdateParam = (res: ReturnPropOnProgressUpdateParamParam) => any
type ReturnPropOnProgressUpdateParamParam = {
/**
* 上传进度百分比
*/
progress: number
/**
* 已经上传的数据长度,单位 Bytes
*/
totalBytesSent: number
/**
* 预期需要上传的数据总长度,单位 Bytes
*/
totalBytesExpectedToSend: number
}
/**
* 中断上传任务
*/
type ReturnPropAbort = () => any
}
/**
* 将本地资源上传到开发者服务器,客户端发起一个 HTTPS POST 请求,其中 `content-type` 为 `multipart/form-data` 。**使用前请先阅读[说明](https://developers.weixin.qq.com/miniprogram/dev/api/api-network.html)**。
*
* 如页面通过 [wx.chooseImage](https://developers.weixin.qq.com/miniprogram/dev/api/media-picture.html#wxchooseimageobject) 等接口获取到一个本地资源的临时文件路径后,可通过此接口将本地资源上传到指定服务器。
*
* **返回值:**
*
* @since 1.4.0
*
* 返回一个 `uploadTask` 对象,通过 `uploadTask`,可监听上传进度变化事件,以及取消上传任务。
*
* **示例代码:**
*
* ```javascript
* wx.chooseImage({
* success: function(res) {
* var tempFilePaths = res.tempFilePaths
* wx.uploadFile({
* url: 'https://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
* filePath: tempFilePaths[0],
* name: 'file',
* formData:{
* 'user': 'test'
* },
* success: function(res){
* var data = res.data
* //do something
* }
* })
* }
* })
* ```
*
* **示例代码:**
*
* ```javascript
* const uploadTask = wx.uploadFile({
* url: 'http://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
* filePath: tempFilePaths[0],
* name: 'file',
* formData:{
* 'user': 'test'
* },
* success: function(res){
* var data = res.data
* //do something
* }
* })
*
* uploadTask.onProgressUpdate((res) => {
* console.log('上传进度', res.progress)
* console.log('已经上传的数据长度', res.totalBytesSent)
* console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend)
* })
*
* uploadTask.abort() // 取消上传任务
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-file.html#wxuploadfileobject
*/
function uploadFile(OBJECT: uploadFile.Param): uploadFile.Return
namespace downloadFile {
type Param = {
/**
* 下载资源的 url
*/
url: string
/**
* HTTP 请求 Header,header 中不能设置 Referer
*/
header?: any
/**
* 下载成功后以 tempFilePath 的形式传给页面,res = {tempFilePath: '文件的临时路径'}
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 下载成功后以 tempFilePath 的形式传给页面,res = {tempFilePath: '文件的临时路径'}
*/
type ParamPropSuccess = (res: ParamPropSuccessParam) => any
type ParamPropSuccessParam = {
/**
* 临时文件路径,下载后的文件会存储到一个临时文件
*/
tempFilePath: string
/**
* 开发者服务器返回的 HTTP 状态码
*/
statusCode: number
}
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
type Return = {
/**
* 监听下载进度变化
*
* @since 1.4.0
*/
onProgressUpdate: ReturnPropOnProgressUpdate
/**
* 中断下载任务
*
* @since 1.4.0
*/
abort: ReturnPropAbort
}
/**
* 监听下载进度变化
*/
type ReturnPropOnProgressUpdate = (callback: ReturnPropOnProgressUpdateParam) => any
type ReturnPropOnProgressUpdateParam = (res: ReturnPropOnProgressUpdateParamParam) => any
type ReturnPropOnProgressUpdateParamParam = {
/**
* 下载进度百分比
*/
progress: number
/**
* 已经下载的数据长度,单位 Bytes
*/
totalBytesWritten: number
/**
* 预期需要下载的数据总长度,单位 Bytes
*/
totalBytesExpectedToWrite: number
}
/**
* 中断下载任务
*/
type ReturnPropAbort = () => any
}
/**
* 下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。**使用前请先阅读[说明](https://developers.weixin.qq.com/miniprogram/dev/api/api-network.html)**。
*
* **返回值:**
*
* @since 1.4.0
*
* 返回一个 `downloadTask` 对象,通过 `downloadTask`,可监听下载进度变化事件,以及取消下载任务。
*
* **Bug & Tip:**
*
* 1. `tip`: 6.5.3 以及之前版本的 iOS 微信客户端 `header` 设置无效
*
* **示例代码:**
*
* ```javascript
* wx.downloadFile({
* url: 'https://example.com/audio/123', //仅为示例,并非真实的资源
* success: function(res) {
* // 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容
* if (res.statusCode === 200) {
* wx.playVoice({
* filePath: res.tempFilePath
* })
* }
* }
* })
* ```
*
* **示例代码:**
*
* ```javascript
* const downloadTask = wx.downloadFile({
* url: 'http://example.com/audio/123', //仅为示例,并非真实的资源
* success: function(res) {
* wx.playVoice({
* filePath: res.tempFilePath
* })
* }
* })
*
* downloadTask.onProgressUpdate((res) => {
* console.log('下载进度', res.progress)
* console.log('已经下载的数据长度', res.totalBytesWritten)
* console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
* })
*
* downloadTask.abort() // 取消下载任务
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-file.html#wxdownloadfileobject
*/
function downloadFile(OBJECT: downloadFile.Param): downloadFile.Return
namespace connectSocket {
type Param = {
/**
* 开发者服务器接口地址,必须是 wss 协议,且域名必须是后台配置的合法域名
*/
url: string
/**
* HTTP Header , header 中不能设置 Referer
*/
header?: any
/**
* 子协议数组
*
* @since 1.4.0
*/
protocols?: string[]
/**
* 接口调用成功的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 接口调用成功的回调函数
*/
type ParamPropSuccess = (res: any) => any
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
}
/**
* 创建一个 [WebSocket](https://developer.mozilla.org/zh-CN/docs/Web/API/WebSocket) 连接。**使用前请先阅读[说明](https://developers.weixin.qq.com/miniprogram/dev/api/api-network.html)**。
*
* **基础库 1.7.0 之前,一个微信小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。基础库版本 1.7.0 及以后,支持存在多个 WebSokcet 连接,每次成功调用 wx.connectSocket 会返回一个新的 [SocketTask](https://developers.weixin.qq.com/miniprogram/dev/api/socket-task.html)。**
*
* **示例代码:**
*
* ```javascript
* wx.connectSocket({
* url: 'wss://example.qq.com',
* data:{
* x: '',
* y: ''
* },
* header:{
* 'content-type': 'application/json'
* },
* protocols: ['protocol1'],
* method:"GET"
* })
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxconnectsocketobject
*/
function connectSocket(OBJECT: connectSocket.Param): SocketTask
namespace onSocketOpen {
type Param = (res: ParamParam) => any
type ParamParam = {
/**
* 连接成功的 HTTP 响应 Header
*
* @since 2.0.0
*/
header?: any
}
}
/**
* 监听WebSocket连接打开事件。
*
* **示例代码:**
*
* ```javascript
* wx.connectSocket({
* url: 'test.php'
* })
* wx.onSocketOpen(function(res) {
* console.log('WebSocket连接已打开!')
* })
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxonsocketopencallback
*/
function onSocketOpen(callback?: onSocketOpen.Param): void
/**
* 监听WebSocket错误。
*
* **示例代码:**
*
* ```javascript
* wx.connectSocket({
* url: 'test.php'
* })
* wx.onSocketOpen(function(res){
* console.log('WebSocket连接已打开!')
* })
* wx.onSocketError(function(res){
* console.log('WebSocket连接打开失败,请检查!')
* })
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxonsocketerrorcallback
*/
function onSocketError(CALLBACK: any): void
namespace sendSocketMessage {
type Param = {
/**
* 需要发送的内容
*/
data: string | ArrayBuffer
/**
* 接口调用成功的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 接口调用成功的回调函数
*/
type ParamPropSuccess = (res: any) => any
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
}
/**
* 通过 WebSocket 连接发送数据,需要先 [wx.connectSocket](https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxconnectsocketobject),并在 [wx.onSocketOpen](https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxonsocketopencallback) 回调之后才能发送。
*
* **示例代码:**
*
* ```javascript
* var socketOpen = false
* var socketMsgQueue = []
* wx.connectSocket({
* url: 'test.php'
* })
*
* wx.onSocketOpen(function(res) {
* socketOpen = true
* for (var i = 0; i < socketMsgQueue.length; i++){
* sendSocketMessage(socketMsgQueue[i])
* }
* socketMsgQueue = []
* })
*
* function sendSocketMessage(msg) {
* if (socketOpen) {
* wx.sendSocketMessage({
* data:msg
* })
* } else {
* socketMsgQueue.push(msg)
* }
* }
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxsendsocketmessageobject
*/
function sendSocketMessage(OBJECT: sendSocketMessage.Param): void
namespace onSocketMessage {
type Param = (res: ParamParam) => any
type ParamParam = {
/**
* 服务器返回的消息
*/
data: string | ArrayBuffer
}
}
/**
* 监听WebSocket接受到服务器的消息事件。
*
* **示例代码:**
*
* ```javascript
* wx.connectSocket({
* url: 'test.php'
* })
*
* wx.onSocketMessage(function(res) {
* console.log('收到服务器内容:' + res.data)
* })
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxonsocketmessagecallback
*/
function onSocketMessage(CALLBACK: onSocketMessage.Param): void
namespace closeSocket {
type Param = {
/**
* 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭)
*
* @since 1.4.0
*/
code?: number
/**
* 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符)
*
* @since 1.4.0
*/
reason?: string
/**
* 接口调用成功的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 接口调用成功的回调函数
*/
type ParamPropSuccess = (res: any) => any
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
}
/**
* 关闭 WebSocket 连接。
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxclosesocketobject
*/
function closeSocket(OBJECT: closeSocket.Param): void
/**
* 监听WebSocket关闭。
*
* **返回值:**
*
* @since 1.7.0
*
* 返回一个 [SocketTask](https://developers.weixin.qq.com/miniprogram/dev/api/socket-task.html)。
*
* **Bug & Tip:**
*
* 1. `tip`: 基础库 1.7.0 开始,支持同时存在 2 条 WebSocket 连接
*
* **示例:**
*
* ```javascript
* wx.connectSocket({
* url: 'test.php'
* })
*
* //注意这里有时序问题,
* //如果 wx.connectSocket 还没回调 wx.onSocketOpen,而先调用 wx.closeSocket,那么就做不到关闭 WebSocket 的目的。
* //必须在 WebSocket 打开期间调用 wx.closeSocket 才能关闭。
* wx.onSocketOpen(function() {
* wx.closeSocket()
* })
*
* wx.onSocketClose(function(res) {
* console.log('WebSocket 已关闭!')
* })
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html#wxonsocketclosecallback
*/
function onSocketClose(CALLBACK: any): void
namespace SocketTask {
namespace send {
type Param = {
/**
* 需要发送的内容
*/
data: string | ArrayBuffer
/**
* 接口调用成功的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 接口调用成功的回调函数
*/
type ParamPropSuccess = (res: any) => any
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
}
namespace close {
type Param = {
/**
* 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭)
*/
code?: number
/**
* 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符)
*/
reason?: string
/**
* 接口调用成功的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 接口调用成功的回调函数
*/
type ParamPropSuccess = (res: any) => any
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
}
namespace onOpen {
type Param = (res: ParamParam) => any
type ParamParam = {
/**
* 连接成功的 HTTP 响应 Header
*
* @since 2.0.0
*/
header: any
}
}
namespace onError {
type Param = (res: ParamParam) => any
type ParamParam = {
/**
* 错误信息
*/
errMsg: string
}
}
namespace onMessage {
type Param = (res: ParamParam) => any
type ParamParam = {
/**
* 服务器返回的消息
*/
data: string | ArrayBuffer
}
}
}
/**
* @since 1.7.0
*
* WebSocket 任务,可通过 [wx.connectSocket()](https://developers.weixin.qq.com/miniprogram/dev/api/network-socket.html) 接口创建返回。
*/
class SocketTask {
/**
*
* **SocketTask.send(OBJECT):**
*
* 通过 WebSocket 连接发送数据。
*/
send(OBJECT: SocketTask.send.Param): void
/**
*
* **SocketTask.close(OBJECT):**
*
* 关闭 WebSocket 连接。
*/
close(OBJECT: SocketTask.close.Param): void
/**
*
* **SocketTask.onOpen(CALLBACK):**
*
* 监听 WebSocket 连接打开事件。
*/
onOpen(CALLBACK: SocketTask.onOpen.Param): void
/**
*
* **SocketTask.onClose(CALLBACK):**
*
* 监听 WebSocket 连接关闭事件。
*/
onClose(CALLBACK: any): void
/**
*
* **SocketTask.onError(CALLBACK):**
*
* 监听 WebSocket 错误。
*/
onError(CALLBACK: SocketTask.onError.Param): void
/**
*
* **SocketTask.onMessage(CALLBACK):**
*
* 监听WebSocket接受到服务器的消息事件。
*/
onMessage(CALLBACK: SocketTask.onMessage.Param): void
}
namespace chooseImage {
type Param = {
/**
* 最多可以选择的图片张数,默认9
*/
count?: number
/**
* original 原图,compressed 压缩图,默认二者都有
*/
sizeType?: string[]
/**
* album 从相册选图,camera 使用相机,默认二者都有
*/
sourceType?: string[]
/**
* 成功则返回图片的本地文件路径列表 tempFilePaths
*/
success: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 成功则返回图片的本地文件路径列表 tempFilePaths
*/
type ParamPropSuccess = (res: ParamPropSuccessParam) => any
type ParamPropSuccessParam = {
/**
* 图片的本地文件路径列表
*/
tempFilePaths: string[]
/**
* 图片的本地文件列表,每一项是一个 File 对象
*
* @since 1.2.0
*/
tempFiles: ParamPropSuccessParamPropTempFiles
}
/**
* 图片的本地文件列表,每一项是一个 File 对象
*/
type ParamPropSuccessParamPropTempFiles = ParamPropSuccessParamPropTempFilesItem[]
type ParamPropSuccessParamPropTempFilesItem = {
/**
* 本地文件路径
*/
path: string
/**
* 本地文件大小,单位:B
*/
size: number
}
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
type ParamPropComplete = () => any
}
/**
* 从本地相册选择图片或使用相机拍照。
*
* **示例代码:**
*
* ```javascript
* wx.chooseImage({
* count: 1, // 默认9
* sizeType: ['original', 'compressed'], // 可以指定是原图还是压缩图,默认二者都有
* sourceType: ['album', 'camera'], // 可以指定来源是相册还是相机,默认二者都有
* success: function (res) {
* // 返回选定照片的本地文件路径列表,tempFilePath可以作为img标签的src属性显示图片
* var tempFilePaths = res.tempFilePaths
* }
* })
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/api/media-picture.html#wxchooseimageobject
*/
function chooseImage(OBJECT: chooseImage.Param): void
namespace previewImage {
type Param = {
/**
* 当前显示图片的链接,不填则默认为 urls 的第一张
*/
current?: string
/**
* 需要预览的图片链接列表
*/
urls: string[]
/**
* 接口调用成功的回调函数
*/
success?: ParamPropSuccess
/**
* 接口调用失败的回调函数
*/
fail?: ParamPropFail
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: ParamPropComplete
}
/**
* 接口调用成功的回调函数
*/
type ParamPropSuccess = (res: any) => any
/**
* 接口调用失败的回调函数
*/
type ParamPropFail = (err: any) => any
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)