@types/redux-socket.io NPM

Installation

npm install --save @types/redux-socket.io

Summary

This package contains type definitions for redux-socket.io (https://github.com/itaylor/redux-socket.io#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-socket.io.

index.d.ts

// Type definitions for redux-socket.io 1.4
// Project: https://github.com/itaylor/redux-socket.io#readme
// Definitions by: Igor Voropaev <https://github.com/snakeego>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="socket.io-client" />

import { Middleware, Action, Dispatch } from 'redux';

export interface MiddlewareOptions {
    eventName?: string | undefined;
    execute?: (<S>(action: Action, emitBound: SocketIOClient.Socket, next: Dispatch<S>, dispatch: Dispatch<S>) => any) | undefined;
}

export default function createSocketIoMiddleware(
    socket: SocketIOClient.Socket,
    criteria: (string | ReadonlyArray<string> | ((type: string, action: Action) => boolean)),
    options?: MiddlewareOptions
): Middleware;