Add interface members & some comments.

flipsnap/flipsnap.d.ts

@@ -1,36 +1,93 @@
 // Type definitions for flipsnap.js
 // Project: http://pxgrid.github.io/js-flipsnap/
-// Definitions by: kubosho_ & gsino <https://github.com/kubosho><https://github.com/gsino>
+// Definitions by: kubosho_ <https://github.com/kubosho>, gsino <https://github.com/gsino>, Mayuki Sawatari <https://github.com/mayuki>
 // Definitions: https://github.com/borisyankov/DefinitelyTyped
 
-interface Flipsnap {
+interface IFlipsnap {
+    /**
+     * Return true or false. true is returned when there is previous element.
+     */
     hasPrev(): boolean;
+
+    /**
+     * Return true or false. true is returned when there is next element.
+     */
     hasNext(): boolean;
+
+    /**
+     * Move to previous item.
+     */
     toPrev(transitionDuration?: number): void;
+
+    /**
+     * Move to next item.
+     */
     toNext(transitionDuration?: number): void;
+
+    /**
+     * Move to item of number.
+     */
     moveToPoint(point: number, transitionDuration?: number): void;
+
+    /**
+     * Recalculate values
+     */
+    refresh(): void;
+
     element: HTMLElement;
 }
 
 interface FlipsnapStatic {
-    (element: HTMLElement, opts?: FlipsnapOptions): Flipsnap;
-    (element: string, opts?: FlipsnapOptions): Flipsnap;
+    /**
+     * @param element The element
+     */
+    (element: HTMLElement, opts?: FlipsnapOptions): IFlipsnap;
+
+    /**
+     * @param selector The parameter must be CSS Selector. When set string, to get first element of result. Not all element.
+     */
+    (selector: string, opts?: FlipsnapOptions): IFlipsnap;
 }
 
 interface FlipsnapOptions {
+    /**
+     * Stop point count. default is auto calculate from element item count.
+     */
     maxPoint?: number;
+    /**
+     * Move distance. default is auto calculate from element width and maxPont.
+     */
     distance?: number;
+    /**
+     * Transition duration (millisecond). default is 350.
+     */
     transitionDuration?: number;
+    /**
+     * When set true, touch event is disabled. Only handling button or etc interface. default is false.
+     */
     disableTouch?: boolean;
+    /**
+     * When support 3D transform browser and this option set true, it is not used 3D transform and use 2D transform. You should set true, when it is a device which has a bug in 3D transform(old Android or BlackBerry etc). default is false.
+     */
     disable3d?: boolean;
 }
 
 interface HTMLElement {
-    addEventListener(type: "fstouchend", listener: (ev: FlipsnapEvent) => any, useCapture?: boolean): void;
+    addEventListener(type: "fstouchstart", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "fstouchmove", listener: (ev: FlipsnapTouchMoveEvent) => any, useCapture?: boolean): void;
+    addEventListener(type: "fstouchend", listener: (ev: FlipsnapTouchEndEvent) => any, useCapture?: boolean): void;
 }
 
-interface FlipsnapEvent extends Event {
+interface FlipsnapTouchMoveEvent extends Event {
+    delta: number;
+    direction: number;
+}
+
+interface FlipsnapTouchEndEvent extends Event {
+    moved: boolean;
+    cancelled: boolean;
     newPoint: number;
+    originalPoint: number;
 }
 
-declare var Flipsnap: FlipsnapStatic;
+declare var Flipsnap: FlipsnapStatic;