DefinitelyTyped/types/subscribe-ui-event/index.d.ts

// Type definitions for subscribe-ui-event 1.1
// Project: https://github.com/yahoo/subscribe-ui-event#readme
// Definitions by: Cheng Wang <https://github.com/wangcheng678>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/subscribe-ui-event
// TypeScript Version: 2.3

export type UIEventType =
    | 'resize'
    | 'resizeEnd'
    | 'resizeStart'
    | 'scroll'
    | 'scrollEnd'
    | 'scrollStart'
    | 'visibilitychange';

export type TouchEventType =
    | 'touchend'
    | 'touchmove'
    | 'touchmoveEnd'
    | 'touchmoveStart'
    | 'touchstart';

export type EventType = UIEventType | TouchEventType;

export interface SubscribeOptions {
    context?: any;
    enableResizeInfo?: boolean;
    enableScrollInfo?: boolean;
    enableTouchInfo?: boolean;
    eventOptions?: AddEventListenerOptions;
    throttleRate?: number;
    useRAF?: boolean;
}

export interface ArgmentedEvent<T extends EventType> {
    mainType: string;
    resize: {
        height: number;
        width: number;
    };
    scroll: {
        delta: number;
        top: number;
    };
    subType: string;
    type: T;
    touch: {
        axisIntention: 'x' | 'y' | '';
        deltaX: number;
        deltaY: number;
        startX: number;
        startY: number;
    };
}

export type UIEventCallback<T extends UIEventType = UIEventType> = (
    event: UIEvent,
    payload: ArgmentedEvent<T>
) => any;

export type TouchEventCallback<T extends TouchEventType = TouchEventType> = (
    event: TouchEvent,
    payload: ArgmentedEvent<T>
) => any;

export interface Subscrption {
    unsubscribe: () => void;
}

export function subscribe<T extends UIEventType>(
    eventType: T,
    callback: UIEventCallback<T>,
    options?: SubscribeOptions
): Subscrption;

export function subscribe<T extends TouchEventType>(
    eventType: T,
    callback: TouchEventCallback<T>,
    options?: SubscribeOptions
): Subscrption;

export function unsubscribe<T extends UIEventType>(
    eventType: T,
    callback: UIEventCallback<T>
): void;

export function unsubscribe<T extends TouchEventType>(
    eventType: T,
    callback: TouchEventCallback<T>
): void;

export function listen(
    target: EventTarget,
    eventType: string,
    handler: EventListenerOrEventListenerObject,
    options?: AddEventListenerOptions
): {
    remove: () => void;
};