很久没有写点东西了，可能是太忙的加班让我迷茫了。
用python爬取了一下微信的小游戏api页面（好像微信的页面很多人访问所以没有设置反扒机制？这个爬小游戏的api页面好像特别顺利），然后提取成了一个简单的wx.d.ts，用ts写接口的时候提示稍稍有点改观了。
关于python代码，写的稍微有点乱，大致是3步
1. 爬取微信网页的api，并将html存于本地，（保存的方式有点拙劣，都放在同一个文件夹）
(1)先去爬取首页的内容（附上首页链接wxapi）
(2)根据这个内容，拿到所有的api，以及其对应的url，再进行判断url对应的文件是否存在于本地，最后依次爬取不存在本地的。
爬虫的代码如下，传入的值是request.session 和 拿到的对应url
# 根据url来遍历
def get_evy_url(session,sts):
header = {
'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:57.0) Gecko/20100101 Firefox/57.0',
'Host': 'developers.weixin.qq.com',
'Referer': 'https://developers.weixin.qq.com'
}
x = sts.split("/")
if not FORCE_RELOAD_HTML and os.path.exists('page/%s'%(x[len(x)-1])):
print "%s already exists"%x[len(x)-1][0:-5]
r = session.get('https://developers.weixin.qq.com/minigame/dev/api/'+sts,headers = header,verify=False)
if r.status_code == 200:
with open('page/%s'%(x[len(x)-1]), 'w') as fp:
fp.write(r.content)
else:
with open("error.txt","a+") as fp:
fp.write('%s\n'%sts);
这里就是简单的抓取网页的内容，特别没有技术含量。
2. 提取这些网页中重要的信息整理分类api
根据每个api对应的网页，分析其中的信息
大类型归为3种
(1). 对于一般函数如setTimeout的，类型归为only method
(2). 对于类，只有属性的类 归为 only class
(3) .对于类的方法，归为class-method
小类型，如函数的参数就分析是否为object，如果是则分析其object的内容，否则传入其类型
（这里的分析不是很完善，获取的页面变化有些稍稍不一致，所以暂时没有考虑那些特殊的）
3. 将提取出的信息写入wx.d.ts（写之前需要将一些不合规则的字符替换掉）
这一步根据第二步拿到的数据写入文件，第二步拿到的网页的数据分析出来有些小问题会导致d.ts报错，所以做了一下替换如下
# 以下是爬取过程需要替换的一些字符，否则d.ts会有一些错误
writeStrs = writeStrs.replace("Array.","Array")
writeStrs = writeStrs.replace(": object",": Object")
writeStrs = writeStrs.replace(": function",": Function")
writeStrs = writeStrs.replace(": arraykvdata",": Array<KVData>")
writeStrs = writeStrs.replace(": Promise",": Promise<any>")
writeStrs = writeStrs.replace(" Image"," WxImage")
writeStrs = writeStrs.replace(" Touch"," WxTouch")
writeStrs = writeStrs.replace("<Touch","<WxTouch")
writeStrs = writeStrs.replace(" RenderingContext"," WxRenderingContext")
写入思路是这样的，
-. 对于某些直接调用的方法就直接declare function
-. 对于有属性的就declare class
-. 其他的就是declare interface
其他
其中有些和系统api冲突的类加了前缀Wx,比如Image->WxImage,Touch->WxTouch
有些参数可能会有点小奇怪，当你看到Promise的时候，就是可以=>的时候了，
对于某些类的属性是object的暂时还没有做处理，到时候整理了python代码再处理一下
对于之前给我提问的小伙伴我表示很抱歉，没有及时回复你们消息。如果有小伙伴有什么想问的，请直接发邮件给我吧，1354647573@qq.com
关于代码
这个不能传文件就很尴尬呀。文件的话百度云需要登录了，所以不传百度云了，不喜欢这种强制登录才能下载的云。生成d.ts的python文件和wx.d.ts都放在https://github.com/zevoGet/get.wx.d.ts了，有需要直接命令行走一波 git clone 就行了
贴个代码生成的d.ts的内容吧
/**
* 取消由 requestAnimationFrame 添加到计划中的动画帧请求
*/
declare function cancelAnimationFrame(requestID: number): void;
/**
* 在下次进行重绘时执行
*/
declare function requestAnimationFrame(callback: Function): number;
/**
* 取消由 setInterval 设置的定时器
*/
declare function clearInterval(intervalID: number): void;
/**
* 取消由 setTimeout 设置的定时器
*/
declare function clearTimeout(timeoutID: number): void;
/**
* 设定一个定时器
*/
declare function setInterval(callback: Function,delay: number,rest: any): number;
/**
* 设定一个定时器
*/
declare function setTimeout(callback: Function,delay: number,rest: any): number;
/**
* 托管的 KV 数据
*/
declare class KVData{
/**
* 数据的 key
*/
key: string;
/**
* 数据的 value
*/
value: string;
}
/**
* 用户授权设置信息
*/
declare class AuthSetting{
scope:{
/**
* 是否授权用户信息，对应接口 wx.getUserInfo
*/
userInfo: boolean;
/**
* 是否授权地理位置，对应接口 wx.getLocation wx.chooseLocation
*/
userLocation: boolean;
/**
* 是否授权通讯地址，对应接口 wx.chooseAddress
*/
address: boolean;
/**
* 是否授权发票抬头，对应接口 wx.chooseInvoiceTitle
*/
invoiceTitle: boolean;
/**
* 是否授权微信运动步数，对应接口 wx.getWeRunData
*/
werun: boolean;
/**
* 是否授权录音功能，对应接口 wx.startRecord
*/
record: boolean;
/**
* 是否授权保存到相册 wx.saveImageToPhotosAlbum, wx.saveVideoToPhotosAlbum
*/
writePhotosAlbum: boolean;
/**
* 是否授权摄像头
*/
camera: boolean;
}}
/**
* 画布对象的绘图上下文
*/
declare interface WxRenderingContext{
}
/**
* 图片对象
*/
declare class WxImage{
/**
* 图片的 URL
*/
src: string;
/**
* 图片的真实宽度
*/
width: number;
/**
* 图片的真实高度
*/
height: number;
/**
* 图片加载完成后触发的回调函数
*/
onload: Function;
/**
* 图片加载发生错误后触发的回调函数
*/
onerror: Function;
}
/**
* 用户信息
*/
declare class UserInfo{
/**
* 用户昵称
*/
nickName: string;
/**
* 用户头像图片的 URL。URL 最后一个数值代表正方形头像大小（有 0、46、64、96、132 数值可选，0 代表 640x640 的正方形头像，46 表示 46x46 的正方形头像，剩余数值以此类推。默认132），用户没有头像时该项为空。若用户更换头像，原有头像 URL 将失效。
*/
avatarUrl: string;
/**
* 用户性别
*/
gender: number;
/**
* 用户所在国家
*/
country: string;
/**
* 用户所在省份
*/
province: string;
/**
* 用户所在城市
*/
city: string;
/**
* 显示 country，province，city 所用的语言
*/
language: string;
}
/**
* 托管数据
*/
declare class UserGameData{
/**
* 用户的微信头像 url
*/
avatarUrl: string;
/**
* 用户的微信昵称
*/
nickname: string;
/**
* 用户的 openid
*/
openid: string;
/**
* 用户的托管 KV 数据列表
*/
KVDataList: Array<KVData>;
}
/**
* 在触控设备上的触摸点
*/
declare class WxTouch{
/**
* WxTouch 对象的唯一标识符，只读属性。一次触摸动作(我们值的是手指的触摸)在平面上移动的整个过程中, 该标识符不变。可以根据它来判断跟踪的是否是同一次触摸过程。
*/
identifier: number;
/**
* 触点相对于屏幕左边沿的 X 坐标。
*/
screenX: number;
/**
* 触点相对于屏幕上边沿的 Y 坐标。
*/
screenY: number;
}
/**
*
*/
declare interface Performance{
/**
* 可以获取当前时间以微秒为单位的时间戳
*/
now(): number;
}
/**
*
*/
declare interface LoadSubpackageTask{
/**
* 监听分包加载进度变化事件
*/
onProgressUpdate(callback:(res:{progress: number,totalBytesWritten: number,totalBytesExpectedToWrite: number})=>void);
}
/**
*
*/
declare interface RequestTask{
/**
* 中断请求任务
*/
abort();
}
/**
*
*/
declare class OpenDataContext{
/**
* 开放数据域和主域共享的 sharedCanvas
*/
canvas: Canvas;
/**
* 向开放数据域发送消息
*/
postMessage(message:Object);
}
/**
*
*/
declare class Stats{
/**
* 文件的类型和存取的权限，对应 POSIX stat.st_mode
*/
mode: string;
/**
* 文件大小，单位：B，对应 POSIX stat.st_size
*/
size: number;
/**
* 文件最近一次被存取或被执行的时间，UNIX 时间戳，对应 POSIX stat.st_atime
*/
lastAccessedTime: number;
/**
* 文件最后一次被修改的时间，UNIX 时间戳，对应 POSIX stat.st_mtime
*/
lastModifiedTime: number;
/**
* 判断当前文件是否一个目录
*/
isDirectory(): boolean;
/**
* 判断当前文件是否一个普通文件
*/
isFile(): boolean;
}
/**
*
*/
declare interface UploadTask{
/**
* 中断上传任务
*/
abort();
/**
* 监听上传进度变化事件
*/
onProgressUpdate(callback:(res:{progress: number,totalBytesSent: number,totalBytesExpectedToSend: number})=>void);
}
/**
*
*/
declare interface DownloadTask{
/**
* 中断下载任务
*/
abort();
/**
* 监听下载进度变化事件
*/
onProgressUpdate(callback:(res:{progress: number,totalBytesWritten: number,totalBytesExpectedToWrite: number})=>void);
}
/**
*
*/
declare interface Worker{
/**
* 监听主线程/Worker 线程向当前线程发送的消息的事件
*/
onMessage(callback:(res:{message: Object})=>void);
/**
* 向主线程/Worker 线程发送的消息
*/
postMessage(message:Object);
/**
* 结束当前 Worker 线程
*/
terminate();
}
/**
*
*/
declare class Canvas{
/**
* 画布的宽度
*/
width: number;
/**
* 画布的高度
*/
height: number;
/**
* 获取画布对象的绘图上下文
*/
getContext(contextType:string,contextAttributes:Object): WxRenderingContext;
/**
* 把画布上的绘制内容以一个 data URI 的格式返回
*/
toDataURL(): string;
/**
* 将当前 Canvas 保存为一个临时文件
*/
toTempFilePath(object:Object): string;
/**
* Canvas.toTempFilePath 的同步版本
*/
toTempFilePathSync(obj:{x?: number,y?: number,width?: number,height?: number,destWidth?: number,destHeight?: number,fileType?: string,quality?: number});
}
/**
*
*/
declare interface UpdateManager{
/**
* 强制小程序重启并使用新版本
*/
applyUpdate();
/**
* 监听向微信后台请求检查更新结果事件
*/
onCheckForUpdate(callback:(res:{hasUpdate: boolean})=>void);
/**
* 监听小程序更新失败事件
*/
onUpdateFailed(callback:Function);
/**
* 监听小程序有版本更新事件
*/
onUpdateReady(callback:Function);
}
/**
*
*/
declare class UserInfoButton{
/**
* 按钮的类型
*/
type: string;
/**
* 按钮上的文本，仅当 type 为 text 时有效
*/
text: string;
/**
* 按钮的背景图片，仅当 type 为 image 时有效
*/
image: string;
/**
* 按钮的样式
*/
style: Object;
/**
* 销毁用户信息按钮
*/
destroy();
/**
* 隐藏用户信息按钮
*/
hide();
/**
* 取消监听用户信息按钮的点击事件
*/
offTap(callback:Function);
/**
* 监听用户信息按钮的点击事件
*/
onTap(callback:(res:{userInfo: UserInfo,rawData: string,signature: string,encryptedData: string,iv: string})=>void);
/**
* 显示用户信息按钮
*/
show();
}
/**
*
*/
declare class OpenSettingButton{
/**
* 按钮的类型
*/
type: string;
/**
* 按钮上的文本，仅当 type 为 text 时有效
*/
text: string;
/**
* 按钮的背景图片，仅当 type 为 image 时有效
*/
image: string;
/**
* 按钮的样式
*/
style: Object;
/**
* 销毁打开设置页面按钮
*/
destroy();
/**
* 隐藏打开设置页面按钮
*/
hide();
/**
* 取消监听设置页面按钮的点击事件
*/
offTap(callback:Function);
/**
* 监听设置页面按钮的点击事件
*/
onTap(callback:Function);
/**
* 显示打开设置页面按钮
*/
show();
}
/**
*
*/
declare class FeedbackButton{
/**
* 按钮的类型
*/
type: string;
/**
* 按钮上的文本，仅当 type 为 text 时有效
*/
text: string;
/**
* 按钮的背景图片，仅当 type 为 image 时有效
*/
image: string;
/**
* 按钮的样式
*/
style: Object;
/**
* 销毁意见反馈按钮
*/
destroy();
/**
* 隐藏意见反馈按钮
*/
hide();
/**
* 取消监听意见反馈按钮的点击事件
*/
offTap(callback:Function);
/**
* 监听意见反馈按钮的点击事件
*/
onTap(callback:Function);
/**
* 显示意见反馈按钮
*/
show();
}
/**
*
*/
declare class GameClubButton{
/**
* 显示游戏圈按钮
*/
object: Object;
/**
* 销毁游戏圈按钮
*/
destroy();
/**
* 隐藏游戏圈按钮
*/
hide();
/**
* 取消监听游戏圈按钮的点击事件
*/
offTap(callback:Function);
/**
* 监听游戏圈按钮的点击事件
*/
onTap(callback:Function);
/**
* 显示游戏圈按钮
*/
show();
}
/**
*
*/
declare interface SocketTask{
/**
* 关闭 WebSocket 连接
*/
close(obj:{code?: number,reason?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 监听WebSocket 连接关闭事件
*/
onClose(callback:Function);
/**
* 监听WebSocket 错误事件
*/
onError(callback:(res:{errMsg: string})=>void);
/**
* 监听WebSocket 接受到服务器的消息事件
*/
onMessage(callback:(res:{data: string|ArrayBuffer})=>void);
/**
* 监听WebSocket 连接打开事件
*/
onOpen(callback:(res:{header: Object})=>void);
/**
* 通过 WebSocket 连接发送数据
*/
send(obj:{data?: string|ArrayBuffer,success?: Function,fail?: Function,complete?: Function});
}
/**
*
*/
declare interface console{
/**
* 向调试面板中打印 debug 日志
*/
debug();
/**
* 向调试面板中打印 error 日志
*/
error();
/**
* 在调试面板中创建一个新的分组
*/
group(label:string);
/**
* 结束由 console.group 创建的分组
*/
groupEnd();
/**
* 向调试面板中打印 info 日志
*/
info();
/**
* 向调试面板中打印 log 日志
*/
log();
/**
* 向调试面板中打印 warn 日志
*/
warn();
}
/**
*
*/
declare interface RewardedVideoAd{
/**
* 隐藏激励视频广告
*/
load(): Promise<any>;
/**
* 取消监听用户点击 关闭广告 按钮的事件
*/
offClose(callback:Function);
/**
* 取消监听激励视频错误事件
*/
offError(callback:Function);
/**
* 取消监听激励视频广告加载事件
*/
offLoad(callback:Function);
/**
* 监听用户点击 关闭广告 按钮的事件
*/
onClose(callback:(res:{isEnded: boolean})=>void);
/**
* 监听激励视频错误事件
*/
onError(callback:(res:{errMsg: string,errCode: number})=>void);
/**
* 监听激励视频广告加载事件
*/
onLoad(callback:Function);
/**
* 显示激励视频广告
*/
show(): Promise<any>;
}
/**
*
*/
declare class BannerAd{
/**
* banner 广告组件的样式。style 上的属性的值仅为开发者设置的值，banner 广告会根据开发者设置的宽度进行等比缩放，缩放后的真实尺寸需要通过 BannerAd.onResize() 事件获得。
*/
style: Object;
/**
* 销毁 banner 广告
*/
destroy();
/**
* 隐藏 banner 广告
*/
hide();
/**
* 取消监听banner 广告错误事件
*/
offError(callback:Function);
/**
* 取消监听banner 广告加载事件
*/
offLoad(callback:Function);
/**
* 取消监听banner 广告尺寸变化事件
*/
offResize(callback:Function);
/**
* 监听banner 广告错误事件
*/
onError(callback:(res:{errMsg: string,errCode: number})=>void);
/**
* 监听banner 广告加载事件
*/
onLoad(callback:Function);
/**
* 监听banner 广告尺寸变化事件
*/
onResize(callback:(res:{width: number,height: number})=>void);
/**
* 显示 banner 广告
*/
show(): Promise<any>;
}
/**
*
*/
declare interface RecorderManager{
/**
* 监听录音错误事件
*/
onError(callback:(res:{errMsg: string})=>void);
/**
* 监听已录制完指定帧大小的文件事件
*/
onFrameRecorded(callback:(res:{frameBuffer: ArrayBuffer,isLastFrame: boolean})=>void);
/**
* 监听录音因为受到系统占用而被中断开始事件
*/
onInterruptionBegin(callback:Function);
/**
* 监听录音中断结束事件
*/
onInterruptionEnd(callback:Function);
/**
* 监听录音暂停事件
*/
onPause(callback:Function);
/**
* 监听录音继续事件
*/
onResume(callback:Function);
/**
* 监听录音开始事件
*/
onStart(callback:Function);
/**
* 监听录音结束事件
*/
onStop(callback:(res:{tempFilePath: string})=>void);
/**
* 暂停录音
*/
pause();
/**
* 继续录音
*/
resume();
/**
* 开始录音
*/
start(obj:{duration?: number,sampleRate?: number,numberOfChannels?: number,encodeBitRate?: number,format?: string,frameSize?: number,audioSource?: string});
/**
* 停止录音
*/
stop();
}
/**
*
*/
declare class Video{
/**
* 视频的左上角横坐标
*/
x: number;
/**
* 视频的左上角纵坐标
*/
y: number;
/**
* 视频的宽度
*/
width: number;
/**
* 视频的高度
*/
height: number;
/**
* 视频的资源地址
*/
src: number;
/**
* 视频的封面
*/
poster: number;
/**
* 视频的初始播放位置，单位为 s 秒
*/
initialTime: number;
/**
* 视频的播放速率，有效值有 0.5、0.8、1.0、1.25、1.5
*/
playbackRate: number;
/**
* 视频是否为直播
*/
live: number;
/**
* 视频的缩放模式
*/
objectFit: number;
/**
* 视频是否显示控件
*/
controls: number;
/**
* 视频是否自动播放
*/
autoplay: number;
/**
* 视频是否是否循环播放
*/
loop: number;
/**
* 视频是否禁音播放
*/
muted: number;
/**
* 视频开始缓冲时触发的回调函数
*/
onwaiting: Function;
/**
* 视频开始播放时触发的回调函数
*/
onplay: Function;
/**
* 视频暂停时触发的回调函数
*/
onpause: Function;
/**
* 视频播放到末尾时触发的回调函数
*/
onended: Function;
/**
* 每当视频播放进度更新时触发的回调函数
*/
ontimeupdate: Function;
/**
* 视频发生错误时触发的回调函数
*/
onerror: Function;
/**
* 销毁视频
*/
destroy();
/**
* 视频退出全屏
*/
exitFullScreen(): Promise<any>;
/**
* 取消监听视频播放到末尾事件
*/
offEnded(callback:Function);
/**
* 取消监听视频错误事件
*/
offError(callback:Function);
/**
* 取消监听视频暂停事件
*/
offPause(callback:Function);
/**
* 取消监听视频播放事件
*/
offPlay(callback:Function);
/**
* 取消监听视频播放进度更新事件
*/
offTimeUpdate(callback:Function);
/**
* 取消监听视频缓冲事件
*/
offWaiting(callback:Function);
/**
* 监听视频播放到末尾事件
*/
onEnded(callback:Function);
/**
* 监听视频错误事件
*/
onError(callback:(res:{errMsg: string})=>void);
/**
* 监听视频暂停事件
*/
onPause(callback:Function);
/**
* 监听视频播放事件
*/
onPlay(callback:Function);
/**
* 监听视频播放进度更新事件
*/
onTimeUpdate(callback:(res:{position: number,duration: number})=>void);
/**
* 监听视频缓冲事件
*/
onWaiting(callback:Function);
/**
* 暂停视频
*/
pause(): Promise<any>;
/**
* 播放视频
*/
play(): Promise<any>;
/**
* 视频全屏
*/
requestFullScreen(): Promise<any>;
/**
* 视频跳转
*/
seek(time:number): Promise<any>;
/**
* 停止视频
*/
stop(): Promise<any>;
}
/**
*
*/
declare class InnerAudioContext{
/**
* 音频资源的地址，用于直接播放。2.2.3 开始支持云文件ID
*/
src: string;
/**
* 开始播放的位置（单位：s），默认为 0
*/
startTime: number;
/**
* 是否自动开始播放，默认为 false
*/
autoplay: boolean;
/**
* 是否循环播放，默认为 false
*/
loop: boolean;
/**
* 是否遵循系统静音开关，默认为 true。当此参数为 false 时，即使用户打开了静音开关，也能继续发出声音
*/
obeyMuteSwitch: boolean;
/**
* 支持版本 >= 1.9.90
*/
volume: number;
/**
* 音量。范围 0~1。默认为 1
*/
duration: number;
/**
* 当前音频的长度（单位 s）。只有在当前有合法的 src 时返回（只读）
*/
currentTime: number;
/**
* 当前音频的播放位置（单位 s）。只有在当前有合法的 src 时返回，时间保留小数点后 6 位（只读）
*/
paused: boolean;
/**
* 当前是是否暂停或停止状态（只读）
*/
buffered: number;
/**
* 销毁当前实例
*/
destroy();
/**
* 取消监听音频进入可以播放状态的事件
*/
offCanplay(callback:Function);
/**
* 取消监听音频自然播放至结束的事件
*/
offEnded(callback:Function);
/**
* 取消监听音频播放错误事件
*/
offError(callback:Function);
/**
* 取消监听音频暂停事件
*/
offPause(callback:Function);
/**
* 取消监听音频播放事件
*/
offPlay(callback:Function);
/**
* 取消监听音频完成跳转操作的事件
*/
offSeeked(callback:Function);
/**
* 取消监听音频进行跳转操作的事件
*/
offSeeking(callback:Function);
/**
* 取消监听音频停止事件
*/
offStop(callback:Function);
/**
* 取消监听音频播放进度更新事件
*/
offTimeUpdate(callback:Function);
/**
* 取消监听音频加载中事件
*/
offWaiting(callback:Function);
/**
* 监听音频进入可以播放状态的事件
*/
onCanplay(callback:Function);
/**
* 监听音频自然播放至结束的事件
*/
onEnded(callback:Function);
/**
* 监听音频播放错误事件
*/
onError(callback:(res:{errCode: number})=>void);
/**
* 监听音频暂停事件
*/
onPause(callback:Function);
/**
* 监听音频播放事件
*/
onPlay(callback:Function);
/**
* 监听音频完成跳转操作的事件
*/
onSeeked(callback:Function);
/**
* 监听音频进行跳转操作的事件
*/
onSeeking(callback:Function);
/**
* 监听音频停止事件
*/
onStop(callback:Function);
/**
* 监听音频播放进度更新事件
*/
onTimeUpdate(callback:Function);
/**
* 监听音频加载中事件
*/
onWaiting(callback:Function);
/**
* 暂停
*/
pause();
/**
* 播放
*/
play();
/**
* 跳转到指定位置
*/
seek(position:number);
/**
* 停止
*/
stop();
}
/**
*
*/
declare interface FileSystemManager{
/**
* 判断文件/目录是否存在
*/
access(obj:{path?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.access 的同步版本
*/
accessSync(path:string);
/**
* 在文件结尾追加内容
*/
appendFile(obj:{filePath?: string,data?: string|ArrayBuffer,encoding?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.appendFile 的同步版本
*/
appendFileSync(filePath:string,data:string|ArrayBuffer,encoding:string);
/**
* 复制文件
*/
copyFile(obj:{srcPath?: string,destPath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.copyFile 的同步版本
*/
copyFileSync(srcPath:string,destPath:string);
/**
* 获取该小程序下的 本地临时文件 或 本地缓存文件 信息
*/
getFileInfo(obj:{filePath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 获取该小程序下已保存的本地缓存文件列表
*/
getSavedFileList(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 创建目录
*/
mkdir(obj:{dirPath?: string,recursive?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.mkdir 的同步版本
*/
mkdirSync(dirPath:string,recursive:boolean);
/**
* 读取目录内文件列表
*/
readdir(obj:{dirPath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.readdir 的同步版本
*/
readdirSync(dirPath:string): Array<string>;
/**
* 读取本地文件内容
*/
readFile(obj:{filePath?: string,encoding?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.readFile 的同步版本
*/
readFileSync(filePath:string,encoding:string): string|ArrayBuffer;
/**
* 删除该小程序下已保存的本地缓存文件
*/
removeSavedFile(obj:{filePath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 重命名文件
*/
rename(obj:{oldPath?: string,newPath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.rename 的同步版本
*/
renameSync(oldPath:string,newPath:string);
/**
* 删除目录
*/
rmdir(obj:{dirPath?: string,recursive?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.rmdir 的同步版本
*/
rmdirSync(dirPath:string,recursive:boolean);
/**
* 保存临时文件到本地
*/
saveFile(obj:{tempFilePath?: string,filePath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.saveFile 的同步版本
*/
saveFileSync(tempFilePath:string,filePath:string): number;
/**
* 获取文件 Stats 对象
*/
stat(obj:{path?: string,recursive?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.stat 的同步版本
*/
statSync(path:string,recursive:boolean): Stats|Object;
/**
* 删除文件
*/
unlink(obj:{filePath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.unlink 的同步版本
*/
unlinkSync(filePath:string);
/**
* 解压文件
*/
unzip(obj:{zipFilePath?: string,targetPath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 写文件
*/
writeFile(obj:{filePath?: string,data?: string|ArrayBuffer,encoding?: string,success?: Function,fail?: Function,complete?: Function});
/**
* FileSystemManager.writeFile 的同步版本
*/
writeFileSync(filePath:string,data:string|ArrayBuffer,encoding:string);
}
/**
*
*/
declare interface wx{
/**
* 创建一个画布对象
*/
createCanvas(): Canvas;
/**
* 获取一行文本的行高
*/
getTextLineHeight(object:Object): number;
/**
* 加载自定义字体文件
*/
loadFont(path:string): string;
/**
* 可以修改渲染帧率
*/
setPreferredFramesPerSecond(fps:number);
/**
* 创建一个图片对象
*/
createImage(): WxImage;
/**
* 创建 banner 广告组件
*/
createBannerAd(object:Object): BannerAd;
/**
* 创建激励视频广告组件
*/
createRewardedVideoAd(object:Object): RewardedVideoAd;
/**
* 设置是否打开调试开关
*/
setEnableDebug(obj:{enableDebug?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* 监听加速度数据事件
*/
onAccelerometerChange(callback:(res:{x: number,y: number,z: number})=>void);
/**
* 开始监听加速度数据
*/
startAccelerometer(obj:{interval?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 停止监听加速度数据
*/
stopAccelerometer(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 获取设备电量
*/
getBatteryInfo(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* wx.getBatteryInfo 的同步版本
*/
getBatteryInfoSync(): Object;
/**
* 获取系统剪贴板的内容
*/
getClipboardData(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 设置系统剪贴板的内容
*/
setClipboardData(obj:{data?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 监听罗盘数据变化事件
*/
onCompassChange(callback:(res:{direction: number,accuracy: number|string})=>void);
/**
* 开始监听罗盘数据
*/
startCompass(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 停止监听罗盘数据
*/
stopCompass(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 监听陀螺仪数据变化事件
*/
onGyroscopeChange(callback:(res:{res: Object,x: number,y: number,z: number})=>void);
/**
* 开始监听陀螺仪数据
*/
startGyroscope(obj:{interval?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 停止监听陀螺仪数据
*/
stopGyroscope(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 监听设备方向变化事件
*/
onDeviceMotionChange(callback:(res:{alpha: number,beta: number,gamma: number})=>void);
/**
* 开始监听设备方向的变化
*/
startDeviceMotionListening(obj:{interval?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 停止监听设备方向的变化
*/
stopDeviceMotionListening(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 获取网络类型
*/
getNetworkType(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 监听网络状态变化事件
*/
onNetworkStatusChange(callback:(res:{isConnected: boolean,networkType: string})=>void);
/**
* 取消监听横竖屏切换事件
*/
offDeviceOrientationChange(callback:Function);
/**
* 监听横竖屏切换事件
*/
onDeviceOrientationChange(callback:(res:{value: string})=>void);
/**
* 监听内存不足告警事件
*/
onMemoryWarning(callback:(res:{level: number})=>void);
/**
* 获取屏幕亮度
*/
getScreenBrightness(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 设置是否保持常亮状态
*/
setKeepScreenOn(obj:{keepScreenOn?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* 设置屏幕亮度
*/
setScreenBrightness(obj:{value?: number,success?: Function,fail?: Function,complete?: Function});
/**
* 使手机发生较长时间的振动（400 ms)
*/
vibrateLong(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 使手机发生较短时间的振动（15 ms）
*/
vibrateShort(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 获取全局唯一的文件管理器
*/
getFileSystemManager(): FileSystemManager;
/**
* 获取当前的地理位置、速度
*/
getLocation(obj:{type?: string,altitude?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 创建内部 audio 上下文 InnerAudioContext 对象
*/
createInnerAudioContext(): InnerAudioContext;
/**
* 获取当前支持的音频输入源
*/
getAvailableAudioSources(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 设置 InnerAudioContext 的播放选项
*/
setInnerAudioOption(obj:{mixWithOther?: boolean,obeyMuteSwitch?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* 从本地相册选择图片或使用相机拍照
*/
chooseImage(obj:{count?: number,sizeType?: Array<string>,sourceType?: Array<string>,success?: Function,fail?: Function,complete?: Function});
/**
* 在新页面中全屏预览图片
*/
previewImage(obj:{urls?: Array<string>,current?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 保存图片到系统相册
*/
saveImageToPhotosAlbum(obj:{filePath?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 获取全局唯一的录音管理器 RecorderManager
*/
getRecorderManager(): RecorderManager;
/**
* 创建视频
*/
createVideo(object:Object): Video;
/**
* 发起米大师支付
*/
requestMidasPayment(obj:{mode?: string,env?: number,offerId?: string,currencyType?: string,platform?: string,buyQuantity?: number,zoneId?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 下载文件资源到本地
*/
downloadFile(object:Object): DownloadTask;
/**
* 发起 HTTPS 网络请求
*/
request(object:Object): RequestTask;
/**
* 将本地资源上传到服务器
*/
uploadFile(object:Object): UploadTask;
/**
* 关闭 WeSocket 连接
*/
closeSocket(obj:{code?: number,reason?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 创建一个 WebSocket 连接
*/
connectSocket(object:Object): SocketTask;
/**
* 监听WebSocket 连接关闭事件
*/
onSocketClose(callback:Function);
/**
* 监听WebSocket 错误事件
*/
onSocketError(callback:Function);
/**
* 监听WebSocket 接受到服务器的消息事件
*/
onSocketMessage(callback:(res:{data: string|ArrayBuffer})=>void);
/**
* 监听WebSocket 连接打开事件
*/
onSocketOpen(callback:(res:{header: Object})=>void);
/**
* 通过 WebSocket 连接发送数据
*/
sendSocketMessage(obj:{data?: string|ArrayBuffer,success?: Function,fail?: Function,complete?: Function});
/**
* 根据用户当天游戏时间判断用户是否需要休息
*/
checkIsUserAdvisedToRest(obj:{todayPlayedTime?: number,success?: Function,fail?: Function,complete?: Function});
/**
* 提前向用户发起授权请求
*/
authorize(obj:{scope?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 获取开放数据域
*/
getOpenDataContext(): OpenDataContext;
/**
* 监听主域发送的消息
*/
onMessage(callback:Function);
/**
* 进入客服会话
*/
openCustomerServiceConversation(obj:{sessionFrom?: string,showMessageCard?: boolean,sendMessageTitle?: string,sendMessagePath?: string,sendMessageImg?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 拉取当前用户所有同玩好友的托管数据
*/
getFriendCloudStorage(obj:{keyList?: Array<string>,success?: Function,fail?: Function,complete?: Function});
/**
* 获取群同玩成员的游戏数据
*/
getGroupCloudStorage(obj:{shareTicket?: string,keyList?: Array<string>,success?: Function,fail?: Function,complete?: Function});
/**
* 获取主域和开放数据域共享的 sharedCanvas
*/
getSharedCanvas(): Canvas;
/**
* 获取当前用户托管数据当中对应 key 的数据
*/
getUserCloudStorage(obj:{keyList?: Array<string>,success?: Function,fail?: Function,complete?: Function});
/**
* 删除用户托管数据当中对应 key 的数据
*/
removeUserCloudStorage(obj:{keyList?: Array<string>,success?: Function,fail?: Function,complete?: Function});
/**
* 对用户托管数据进行写数据操作
*/
setUserCloudStorage(obj:{KVDataList?: Array<KVData>,success?: Function,fail?: Function,complete?: Function});
/**
* 创建打开意见反馈页面的按钮
*/
createFeedbackButton(type:string,text:string,image:string,style:Object): FeedbackButton;
/**
* 创建游戏圈按钮
*/
createGameClubButton(object:Object): GameClubButton;
/**
* 检查登录态是否过期
*/
checkSession(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 调用接口获取登录凭证（code）
*/
login(obj:{timeout?: number,success?: Function,fail?: Function,complete?: Function});
/**
* 打开另一个小程序
*/
navigateToMiniProgram(obj:{appId?: string,path?: string,extraData?: Object,envVersion?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 创建打开设置页面的按钮
*/
createOpenSettingButton(type:string,text:string,image:string,style:Object): OpenSettingButton;
/**
* 获取用户的当前设置
*/
getSetting(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 调起客户端小程序设置界面，返回用户设置的操作结果
*/
openSetting(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 创建用户信息按钮
*/
createUserInfoButton(object:Object): UserInfoButton;
/**
* 获取用户信息
*/
getUserInfo(obj:{withCredentials?: boolean,lang?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 获取用户过去三十天微信运动步数
*/
getWeRunData(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 获取性能管理器
*/
getPerformance(): Performance;
/**
* 加快触发 JavaScriptCore 垃圾回收（Garbage Collection）
*/
triggerGC();
/**
* 获取转发详细信息
*/
getShareInfo(obj:{shareTicket?: string,timeout?: number,success?: Function,fail?: Function,complete?: Function});
/**
* 隐藏转发按钮
*/
hideShareMenu(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 取消监听用户点击右上角菜单的「转发」按钮时触发的事件
*/
offShareAppMessage(callback:Function);
/**
* 监听用户点击右上角菜单的「转发」按钮时触发的事件
*/
onShareAppMessage(callback:(res:{title: string,imageUrl: string,query: string})=>void);
/**
* 主动拉起转发，进入选择通讯录界面
*/
shareAppMessage(obj:{title?: string,imageUrl?: string,query?: string});
/**
* 显示当前页面的转发按钮
*/
showShareMenu(obj:{withShareTicket?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* 更新转发属性
*/
updateShareMenu(obj:{withShareTicket?: boolean,isUpdatableMessage?: boolean,activityId?: string,templateInfo?: Object,success?: Function,fail?: Function,complete?: Function});
/**
* 清理本地数据缓存
*/
clearStorage(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* wx.clearStorage 的同步版本
*/
clearStorageSync();
/**
* 从本地缓存中异步获取指定 key 的内容
*/
getStorage(obj:{key?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 异步获取当前storage的相关信息
*/
getStorageInfo(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* wx.getStorageInfo 的同步版本
*/
getStorageInfoSync(): Object;
/**
* wx.getStorage 的同步版本
*/
getStorageSync(key:string): Object|string;
/**
* 从本地缓存中移除指定 key
*/
removeStorage(obj:{key?: string,success?: Function,fail?: Function,complete?: Function});
/**
* wx.removeStorage 的同步版本
*/
removeStorageSync(key:string);
/**
* 将数据存储在本地缓存中指定的 key 中
*/
setStorage(obj:{key?: string,data?: Object|string,success?: Function,fail?: Function,complete?: Function});
/**
* wx.setStorage 的同步版本
*/
setStorageSync(key:string,data:Object|string);
/**
* 触发分包加载，详见 分包加载
*/
loadSubpackage(object:Object): LoadSubpackageTask;
/**
* 退出当前小游戏
*/
exitMiniProgram(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 返回小程序启动参数
*/
getLaunchOptionsSync(): Object;
/**
* 取消监听小游戏隐藏到后台事件
*/
offHide(callback:Function);
/**
* 取消监听小游戏回到前台的事件
*/
offShow(callback:Function);
/**
* 监听小游戏隐藏到后台事件
*/
onHide(callback:Function);
/**
* 监听小游戏回到前台的事件
*/
onShow(callback:(res:{scene: string,query: Object,shareTicket: string,referrerInfo: Object,appId: string,extraData: Object})=>void);
/**
* 取消监听音频因为受到系统占用而被中断开始事件
*/
offAudioInterruptionBegin(callback:Function);
/**
* 取消监听音频中断结束事件
*/
offAudioInterruptionEnd(callback:Function);
/**
* 取消监听全局错误事件
*/
offError(callback:Function);
/**
* 监听音频因为受到系统占用而被中断开始事件
*/
onAudioInterruptionBegin(callback:Function);
/**
* 监听音频中断结束事件
*/
onAudioInterruptionEnd(callback:Function);
/**
* 监听全局错误事件
*/
onError(callback:(res:{message: string,stack: string})=>void);
/**
* 获取系统信息
*/
getSystemInfo(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* wx.getSystemInfo 的同步版本
*/
getSystemInfoSync(): Object;
/**
* 取消监听触点失效事件
*/
offTouchCancel(callback:Function);
/**
* 取消监听触摸结束事件
*/
offTouchEnd(callback:Function);
/**
* 取消监听触点移动事件
*/
offTouchMove(callback:Function);
/**
* 取消监听开始触摸事件
*/
offTouchStart(callback:Function);
/**
* 监听触点失效事件
*/
onTouchCancel(callback:(res:{touches: Array<WxTouch>,changedTouches: Array<WxTouch>,timeStamp: number})=>void);
/**
* 监听触摸结束事件
*/
onTouchEnd(callback:(res:{touches: Array<WxTouch>,changedTouches: Array<WxTouch>,timeStamp: number})=>void);
/**
* 监听触点移动事件
*/
onTouchMove(callback:(res:{touches: Array<WxTouch>,changedTouches: Array<WxTouch>,timeStamp: number})=>void);
/**
* 监听开始触摸事件
*/
onTouchStart(callback:(res:{touches: Array<WxTouch>,changedTouches: Array<WxTouch>,timeStamp: number})=>void);
/**
* 隐藏 loading 提示框
*/
hideLoading(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 隐藏消息提示框
*/
hideToast(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 显示操作菜单
*/
showActionSheet(obj:{itemList?: Array<string>,itemColor?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 显示 loading 提示框
*/
showLoading(obj:{title?: string,mask?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* 显示模态对话框
*/
showModal(obj:{title?: string,content?: string,showCancel?: boolean,cancelText?: string,cancelColor?: string,confirmText?: string,confirmColor?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 显示消息提示框
*/
showToast(obj:{title?: string,icon?: string,image?: string,duration?: number,mask?: boolean,success?: Function,fail?: Function,complete?: Function});
/**
* 隐藏键盘
*/
hideKeyboard(obj:{success?: Function,fail?: Function,complete?: Function});
/**
* 取消监听监听键盘收起的事件
*/
offKeyboardComplete(callback:Function);
/**
* 取消监听用户点击键盘 Confirm 按钮时的事件
*/
offKeyboardConfirm(callback:Function);
/**
* 取消监听键盘输入事件
*/
offKeyboardInput(callback:Function);
/**
* 监听监听键盘收起的事件
*/
onKeyboardComplete(callback:(res:{value: string})=>void);
/**
* 监听用户点击键盘 Confirm 按钮时的事件
*/
onKeyboardConfirm(callback:(res:{value: string})=>void);
/**
* 监听键盘输入事件
*/
onKeyboardInput(callback:(res:{value: Object})=>void);
/**
* 显示键盘
*/
showKeyboard(obj:{defaultValue?: string,maxLength?: number,multiple?: boolean,confirmHold?: boolean,confirmType?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 更新键盘输入框内容
*/
updateKeyboard(obj:{value?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 获取菜单按钮的布局置信息
*/
getMenuButtonBoundingClientRect(): Object;
/**
* 动态设置通过右上角按钮拉起的菜单的样式
*/
setMenuStyle(obj:{style?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 当在配置中设置 showStatusBarStyle 时，屏幕顶部会显示状态栏
*/
setStatusBarStyle(obj:{style?: string,success?: Function,fail?: Function,complete?: Function});
/**
* 取消监听窗口尺寸变化事件
*/
offWindowResize(callback:Function);
/**
* 监听窗口尺寸变化事件
*/
onWindowResize(callback:(res:{windowWidth: number,windowHeight: number})=>void);
/**
* 获取全局唯一的版本更新管理器，用于管理小程序更新
*/
getUpdateManager(): UpdateManager;
/**
* 创建一个 Worker 线程
*/
createWorker(scriptPath:string): Worker;
}
