emeryao/typed-we-app

TypeScript declaration file for WeApp API

⚠ ARCHIVED since tencent finally got their own offical type definitions for WeApp

so goodbye and thanks for all the contributors

typed-we-app

TypeScript declaration file for WeApp API

Install

• With npm installed

  npm install typed-we-app --save-dev

• With typings installed

  typings install github:Emeryao/typed-we-app -SG

• Or get the declaration file here and include it to your project

About

Based on the official WeApp API documentation
Wechat Web DevTool Version 1.01.1712150
WAService.js Version 1.7.0

Sample

• TypeScript

wx.request({
    url: 'request/url',
    success: (res) => {
        console.log(res.data);
    }
});

let ctx = wx.createCanvasContext();
ctx.fillText('hello', 0, 0);

let actions = ctx.getActions();
wx.drawCanvas({
    canvasId: 'canvas-id',
    actions
});

wx.getBLEDeviceServices({
    deviceId: '',
    success: (res) => {
        console.log(res.services[0].uuid);
    },
});

Last Update

2019.05.19

typed-we-app's Issues

好像里面没有 Component 的声明？

How to return never when code uploadFile task onProgressUpdate callback function

function uploadFile(url: string, filePath: string, progress?: (progress: number) => never):Promise<{id:number,errMsg?:string}> {
    return new Promise<{id:number,errMsg?:string}>((resolve, reject) => {
        const uploadTask = wx.uploadFile({
            url: url,
            filePath: filePath,
            name: 'resourceFile',
            success: res => resolve(res),
            fail: e => reject(e)
        });
        if (progress){
        uploadTask.onProgressUpdate =
            (res: { progress: number; totalBytesSent: number; totalBytesExpectedToSend: number; }): never => {
                return progress(res.progress)
            }
        }
    });
}

function updateFileUploadProgress(progress:number):never{
    // do something
    return never
}
async function post2sever(page: IPage, images: { path: string }[]) {
    try {
        let fileIDs:Array<number> = new Array<number>()
        for (let img of images) {
            let res = await uploadFile('/resource', img.path, updateFileUploadProgress)
            if (res.errMsg) throw new Error(`upload image[${img.path}] occurs error:${res.errMsg}`)
            fileIDs.push(res.id);
        }
    } catch{

    }
}

bellow function how to retun never? must throw an error or use while true?

function updateFileUploadProgress(progress:number):never{
    // do something
    return never
}

请问可否发布到npm

你好， vscode1.6以后可以支持npm包的typings， 可否将dt发布到npm呢。

udpate to 2.3.0

based on api list changes 776c317

Report an error when declaring a variable with this.data

make a sample page.js

// @ts-check

Page({
  data: {
    pageTop: -1,
    pageBottom: 0,
  },
  onLoad() {
    const { pageTop, pageBottom } = this.data;
    console.log(pageTop, pageBottom);
  },
});

It reports an error Type 'Object' has no property 'pageTop' and no string index signature.

Go to file index.d.ts line 53, change the data type from Object to any will mute the error.

interface PageParam {
        /**页面的初始数据 */
        data?: Object;

Is there a bug or I missed some configuration?

A runtime for Coding wechat MiniProgram in strong type.

I have an idea for improve the code experience by using the Typescript way.(inspired from Angular)

I created a runtime for adapter between wechat configuration object and the class.

It just an experiment , and it indeed work.

https://github.com/John0King/typed-we-app/blob/typescript-runtime/runtimeSample/pages/index/index.ts

Update to 2.1.0

ref here

suggestion to merge to official site

Hi Emery,

I searched around Internet and found your definition is the best and the most updated!
Will you consider to merge this great work to the official typescript definition DefinitelyTyped collection: DefinitelyTyped, so that more developers could know your excellent work and contribute together?

thanks,
John

已关注，刚学ts，有实际使用的demo吗

默认的lib,应该只包含 es2016 , 不应该包含DOM

当跟wx一块工作的时候， tsconfig.json 里面应该只包含 lib:["es2016"] , 因为所有的DOM API 在微信中都不可用

而 interface Console 却包含在 dom 中， 所以 we-app.d.ts 里面应该包含 Console 的定义， 另外 setTimeout setInterval clearInterval 也需要定义，
下面是我写的定义, Console 是从 dom.d.ts 里面 偷的 :P

---

interface Console {
    assert(condition?: boolean, message?: string, ...data: any[]): void;
    clear(): void;
    count(label?: string): void;
    debug(message?: any, ...optionalParams: any[]): void;
    dir(value?: any, ...optionalParams: any[]): void;
    dirxml(value: any): void;
    error(message?: any, ...optionalParams: any[]): void;
    exception(message?: string, ...optionalParams: any[]): void;
    group(groupTitle?: string, ...optionalParams: any[]): void;
    groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void;
    groupEnd(): void;
    info(message?: any, ...optionalParams: any[]): void;
    log(message?: any, ...optionalParams: any[]): void;
    markTimeline(label?: string): void;
    profile(reportName?: string): void;
    profileEnd(): void;
    table(...tabularData: any[]): void;
    time(label?: string): void;
    timeEnd(label?: string): void;
    timeStamp(label?: string): void;
    timeline(label?: string): void;
    timelineEnd(label?: string): void;
    trace(message?: any, ...optionalParams: any[]): void;
    warn(message?: any, ...optionalParams: any[]): void;
}

declare var console: Console;

/**
 * 定期执行特定的处理程序
 * @param handler 处理程序
 * @param waitTime 等待的时间
 */
declare function setTimeout(handler: () => any, waitTime: number): number;

/**
 * 每隔一段时间执行特定的处理程序
 * @param handler 处理程序
 * @param waitTime 每次执行间隔的时间
 */
declare function setInterval(handler: () => any, waitTime: number): number;

/**
 * 清理由 setInterval 产生的 timer
 * @param timerId timer 的id
 */
declare function clearInterval(timerId: number);

/**
 * 清理由 setTimeout 产生的timer
 * @param timerId timer 的 id
 */
declare function clearTimeout(timerId: number);

declare function require(lib: string): any;

setImmediate 和 clearImmediate 我没定义， 主要是没用到，也不确定 小程序支持

A rest parameter must be of an array type.

@emeryao

A rest parameter must be of an array type.

interface UpdateManager 方法返回值未定义

报错信息

node_modules/@types/we-app/index.d.ts(1062,9): error TS7010: 'onCheckForUpdate', which lacks return-type annotation, implicitly has an 'any' return type.
node_modules/@types/we-app/index.d.ts(1063,9): error TS7010: 'onUpdateFailed', which lacks return-type annotation, implicitly has an 'any' return type.
node_modules/@types/we-app/index.d.ts(1064,9): error TS7010: 'onUpdateReady', which lacks return-type annotation, implicitly has an 'any' return type.

修改代码后通过

interface UpdateManager {
        applyUpdate: Function,
        onCheckForUpdate(callback: Function):any,
        onUpdateFailed(callback: Function):any,
        onUpdateReady(callback: Function):any
    }

Example

Hi @emeryao,

Do you have an example about how to use interface Page in coding?

Thanks,
John

UserInfo接口有误

we-app.d.ts的1454行，encryptData应为encryptedData，缺少iv
官方文档： https://mp.weixin.qq.com/debug/wxadoc/dev/api/open.html#wxgetuserinfoobject