redux-sock/index.d.ts

Redux middleware and reducer for controlling socket.io clients.

/** @module redux-sock
 */
declare module "redux-sock" {
    /**
     * @typedef {Object} Options
     * @prop {string} url
     * @prop {string[]|Object<string, true | string | ((dispatch: Function) => void)>} [events]
     * @prop {Object} [socketClientOptions]
     * @prop {string} [basePrefix="@@socket/"]
     * @prop {string} [sendPrefix="send/"]
     * @prop {string} [receivePrefix="received/"]
     */
    export type Options = {
        url: string;
        socketClientOptions?: any;
        basePrefix?: string;
        sendPrefix?: string;
        receivePrefix?: string;
    };
    /**
     * @typedef {Object} SockMiddleware
     * @prop {import("redux").Reducer} reducer
     * @prop {Object} client
     */
    export type SockMiddleware = {
        client: any;
    };
    /**
     * @param {Options} options
     * @return {SockMiddleware}
     */
    export default function(options: Options): SockMiddleware;
}