Merge pull request #34 from cnjack/master

添加typescript支持

Author: cunjinli6

.gitignore

@@ -1,6 +1,7 @@
 .idea
 .DS_Store
 package-lock.json
+yarn.lock
 
 logs
 *.log

README.md

@@ -139,6 +139,11 @@ npm install --save miniprogram-recycle-view
    })
    ```
 
+   `typescript`支持,使用如下方式引入
+   ```typescript
+   import * as recycleContext from 'miniprogram-recycle-view';
+   ```
+
    ​  页面必须通过 Component 构造器定义，页面引入了`miniprogram-recycle-view`包之后，会在 wx 对象下面新增接口`createRecycleContext`函数创建`RecycleContext`对象来管理 recycle-view 定义的的数据，`createRecycleContext`接收类型为1个 Object 的参数，Object 参数的每一个 key 的介绍如下：
 
    | 参数名    | 类型            | 描述                                                             |

src/index.d.ts

@@ -0,0 +1,45 @@
+declare namespace recycleContext {
+    interface itemSize {
+        width: number;
+        height: number;
+    }
+    
+    type Component = any;
+    type Page = any;
+    
+    type itemSizeFunc<T> = (item: T, index: number) => itemSize
+    
+    interface options<T> {
+        id: string;
+        dataKey: string;
+        page: Component | Page;
+        itemSize: itemSizeFunc<T> | itemSize;
+        useInPage?: boolean;
+        root?: Page;
+    }
+    
+    interface position {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+    }
+    
+    interface RecycleContext<T> {
+        append(list: T[], callback?: () => void): void
+        appendList(list: T[], callback?: () => void): void
+        splice(begin: number, deleteCount: number, appendList: T[], callback?: () => void): void;
+        updateList(beginIndex: number, list: T[], callback?: () => void): void
+        update(beginIndex: number, list: T[], callback?: () => void): void
+        destroy(): void
+        forceUpdate(callback: () => void, reinitSlot: boolean): void
+        getBoundingClientRect(index: number | undefined): position | position[]
+        getScrollTop(): number;
+        transformRpx(rpx: number, addPxSuffix?: string): number;
+        getViewportItems(inViewportPx: number): T[]
+        getList(): T[]
+    }
+}
+declare function recycleContext<T>(op: recycleContext.options<T>): recycleContext.RecycleContext<T>
+
+export = recycleContext;

src/utils/recycle-context.js

@@ -574,6 +574,9 @@ RecycleContext.prototype.getTotalHeight = function () {
 }
 // 返回完整的列表数据
 RecycleContext.prototype.getList = function () {
+  if (!recycleData[this.id]) {
+    return [];
+  }
   return recycleData[this.id].list
 }
 module.exports = RecycleContext

tools/build.js

@@ -231,10 +231,16 @@ class BuildTask {
     /**
      * copy resources to dist folder
      */
-    gulp.task(`${id}-copy`, gulp.parallel(done => {
+    gulp.task(`${id}-copy`, gulp.parallel(async done => {
       const copyList = this.copyList
-      const copyFileList = copyList.map(dir => path.join(dir, '**/*.!(wxss)'))
-
+      const anAsyncFunction = async dir => {
+        const isFileExist = await _.checkFileExists(path.join(srcPath, dir));
+        if (!isFileExist){
+          return path.join(dir, '**/*.!(wxss)')
+        }
+        return dir
+      }
+      const copyFileList =  await Promise.all(copyList.map(item => anAsyncFunction(item)))
       if (copyFileList.length) return copy(copyFileList)
 
       return done()

tools/config.js

@@ -62,5 +62,5 @@ module.exports = {
       assetFilter: assetFilename => assetFilename.endsWith('.js')
     }
   },
-  copy: ['./wxml', './wxss', './wxs', './images'],
+  copy: ['./wxml', './wxss', './wxs', './images', './index.d.ts'],
 }